Storyboards

Retrieve storyboard metadata in WebVTT format

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

get/{PLAYBACK_ID}/storyboard.vtt

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.

Response

WebVTT metadata retrieved successfully.

Changes

Changed in 2 of the 28 revisions of this API.7

    • api tag Storyboards added

      api-tag-added

    • api tag Image removed

      api-tag-removed

    • added the new optional query request parameter asset_end_time

      new-optional-request-parameter

    • added the new optional query request parameter asset_start_time

      new-optional-request-parameter

    • added the new optional query request parameter program_end_time

      new-optional-request-parameter

    • added the new optional query request parameter program_start_time

      new-optional-request-parameter

    • endpoint added

      endpoint-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog