index/functions/getRecordingStoryboardUrl.md

getRecordingStoryboardUrl(tokenName, recordingId, baseUrl, extension?): string

Get redirect URL for a recording storyboard

Contact sheet of thumbnails extracted from the entire recording, useful for scrubbing/seeking through video playback. Can be in VTT, JSON, or image format.

Backend: Redirects to Mux storyboard if available, otherwise placeholder.

Parameters

Parameter	Type	Description
tokenName	string	Token name (lowercase)
recordingId	string	Recording asset ID (from Mux)
baseUrl	string	API base URL
extension?	string	File extension (optional, default: 'vtt')

Returns

string

Full redirect URL to recording storyboard

Throws

Error if token name or recording ID is invalid, or extension format is incorrect

Example

// VTT format
const storyboardVtt = getRecordingStoryboardUrl(
  'anime',
  'asset_abc123',
  'https://api.example.com',
  'vtt'
);
// → "https://api.example.com/v1/tokens/anime/recordings/asset_abc123/assets/storyboard.vtt"

Since

7.3.0