Video API, REST: Playlist.GetPlayerURL

Field

Description

playlistId

string

Required field. ID of the playlist for which to generate a player URL.

The maximum string length in characters is 50.

Field

Description

params

PlaylistPlayerParams

Optional player parameters to customize the playback experience.
These parameters control initial player state such as mute, autoplay, and visibility of interface controls.

Field

Description

mute

boolean

If true, the player will start with audio muted.
Users can unmute the audio manually after playback starts.

autoplay

boolean

If true, the playlist will start playing automatically when the player loads.
This may be subject to browser autoplay policies that restrict autoplay with sound.

hidden

boolean

If true, the player interface controls will be hidden initially.
Users can typically reveal the controls by moving the mouse over the player.

Field

Description

playerUrl

string

Direct URL to the playlist player.
This URL can be used to access the playlist in a web browser
or shared with users who have appropriate permissions.

html

string

HTML embed code in iframe format that can be inserted into web pages.
This code allows the playlist to be embedded directly in third-party websites.