MUmuxinc
Storyboards

Retrieve storyboard metadata in JSON format

Changed on

Fetch metadata for the storyboard image in JSON format, detailing the coordinates and time ranges of each thumbnail.

get/{PLAYBACK_ID}/storyboard.json

Request

  • Base URL
    https://image.mux.com
  • Auth
    none declared

Path parameters

PLAYBACK_IDstring required

The asset or live stream's playback ID.

Query parameters

tokenstring

Signed token (JWT) for secure video playback.

program_start_timeinteger

Set the start time of the asset created from a live stream when using the instant clipping feature. The timestamp should be provided as an epoch integer, and is compared to the program date time (PDT) generated by a live stream.

program_end_timeinteger

Set the end time of the asset created from a live stream when using the instant clipping feature. The timestamp should be provided as an epoch integer, and is compared to the program date time (PDT) generated by a live stream.

asset_start_timenumber float

Set the relative start time of the asset (in seconds) when using the instant clipping feature.

asset_end_timenumber float

Set the relative end time of the asset (in seconds) when using the instant clipping feature.

format'jpg' | 'png' | 'webp'

The format of the storyboard image URL in the response. Can be either 'jpg', 'png', or 'webp'. Defaults to 'jpg'.

Response

JSON storyboard retrieved successfully.

urlstring required

The URL of the storyboard image, in the format requested with the format query parameter.

tile_widthinteger required

The width of each tile in pixels.

tile_heightinteger required

The height of each tile in pixels.

durationnumber required

The duration of the asset in seconds.

Changes

  • 395805a20280Revision changes
    • breaking

      the response's body type changed from string to object for status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • 92aac9f20a74Revision changes
    • warning

      deleted the query request parameter TOKEN

    • info

      added the new optional query request parameter token