MUmuxinc
Storyboards

Retrieve a storyboard image for timeline hover previews

Changed on

Fetch a storyboard image composed of multiple thumbnails for use in timeline hover previews.

get/{PLAYBACK_ID}/storyboard.{EXTENSION}

Request

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

Path parameters

PLAYBACK_IDstring required

The asset or live stream's playback ID.

EXTENSION'jpg' | 'png' | 'webp' required

The storyboard image extension, either 'jpg', 'png', or 'webp'.

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.

Response

Storyboard image retrieved successfully.

Changes

  • 92aac9f20a74Revision changes
    • warning

      deleted the query request parameter TOKEN

    • info

      added the new optional query request parameter token

  • 5b4b3133f27dRevision changes
    • breaking

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

    • breaking

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

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status