WIwithchima
Sources

Get a streaming upload storyboard

Changed on

Returns a signed 4x4 WebP storyboard whose 16 tiles are sampled evenly across the requested window (durationMs/16 apart; every 5 seconds for the default 80s window) from a streaming upload source owned by the caller or their workspace. startTimeMs is relative to the source. Only startTimeMs and durationMs control the storyboard; tile count, dimensions, and format are fixed. By default returns a 302 redirect — set ?response=json to get {url, columns, rows, intervalMs} JSON instead.

get/v1/sources/{sourceId}/storyboard

Request

Path parameters

sourceIdstring required

Streaming upload source identifier

Example:su_abc123def456

Query parameters

startTimeMsinteger

Start time in ms on the selected target's playback timeline. Defaults to 0.

Example:1000
durationMsinteger

Storyboard window duration in ms. Defaults to 80000; the selected target's remaining duration may shorten it. Pass the target's full duration to sample it end to end.

Example:30000
response'json'

Set to 'json' to receive {url, columns, rows, intervalMs} instead of the default 302 redirect.

Example:json

Response

Returned when ?response=json is set

columnsinteger required

Tiles per row

intervalMsinteger required

Spacing between tiles in ms. Tile i (row-major) shows the frame at startTimeMs + i * intervalMs.

rowsinteger required

Tile rows

urlstring uri required

Signed CDN URL of the WebP sheet

Example response

{
  "columns": 4,
  "intervalMs": 5000,
  "rows": 4
}

Changes

  • ac47c99c144fRevision changes
    • warning

      added the new edit_conflict enum value to the response property for the response status

    • warning

      added the new edit_conflict enum value to the response property for the response status

    • warning

      added the new edit_conflict enum value to the response property for the response status

    • warning

      added the new edit_conflict enum value to the response property for the response status

    • warning

      added the new edit_conflict enum value to the response property for the response status

    • warning

      added the new edit_conflict enum value to the response property for the response status

    • warning

      added the new edit_conflict enum value to the response property for the response status

    • warning

      added the new edit_conflict enum value to the response property for the response status

    • warning

      added the new edit_conflict enum value to the response property for the response status

  • 6b1132ef42fbRevision changes
    • warning

      added the new conflict enum value to the response property for the response status

    • warning

      added the new conflict enum value to the response property for the response status

    • warning

      added the new conflict enum value to the response property for the response status

    • warning

      added the new conflict enum value to the response property for the response status

    • warning

      added the new conflict enum value to the response property for the response status

    • warning

      added the new conflict enum value to the response property for the response status

    • warning

      added the new conflict enum value to the response property for the response status

    • warning

      added the new unavailable enum value to the response property for the response status

    • warning

      added the new unavailable enum value to the response property for the response status

    • warning

      added the new unavailable enum value to the response property for the response status

    • warning

      added the new unavailable enum value to the response property for the response status

    • warning

      added the new unavailable enum value to the response property for the response status

    • warning

      added the new unavailable enum value to the response property for the response status

    • warning

      added the new unavailable enum value to the response property for the response status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status