Skip to main content

Function: getRecordingPosterUrl()

Gala Launchpad SDK 9.0.0-rc.5

Gala Launchpad SDK 9.0.0-rc.5 / index / getRecordingPosterUrl

Function: getRecordingPosterUrl()

getRecordingPosterUrl(tokenName, recordingId, baseUrl): string

Defined in: packages/launchpad-sdk/dist/utils/assetUrls.d.ts:342

Get redirect URL for a recording poster image

High-quality still frame from the recording, typically used as a placeholder before playback or in list views.

Backend: Redirects to Mux poster image if available, otherwise placeholder.

Parameters​

tokenName​

string

Token name (lowercase)

recordingId​

string

Recording asset ID (from Mux)

baseUrl​

string

API base URL

Returns​

string

Full redirect URL to recording poster

Throws​

Error if token name or recording ID is invalid

Example​

const posterUrl = getRecordingPosterUrl(
  'anime',
  'asset_abc123',
  'https://api.example.com'
);
// → "https://api.example.com/v1/tokens/anime/recordings/asset_abc123/assets/poster.jpg"

Since​

7.3.0