Web SDK - Player runtime parameters


While the main Player experience is controlled using the settings defined in your Player configuration, additional runtime customization is achievable using client-side parameters.

Check the dedicated guide to see how to add runtime Player parameters with each embed method of the Web SDK.



Parameters

Default

Description

Type

video

undefined

The ID of the video to load.

string

playlist

undefined

The ID of the playlist to load.

string

customConfig

undefined

Define advertising configuration by passing in keys and values. More details.

E.g. customConfig[key]=values

object

scaleMode

fit

To adjust the player’s video focus.

Possible values: fit fill fillLeft fillRight fillTop fillBottom

enum

mute

false

Whether to mute the video or not. To note, enabling mute may impact monetization. The Player provides smart mute behavior, it tries to automatically start the video playback with sound. If this isn’t possible due to browser prevention, there is a fallback mechanism and the Player reattempts to play the video but with the sound set to mute.

Possible values: true or false

boolean

startTime

0

Specify the time (in seconds) from which the video should start playing.

number

loop

false

To set the video to loop. More details.

Possible values: true or false

boolean



video

The ID of the video to load.

Typedefault value
stringundefined

playlist

The ID of the playlist to load.

Typedefault value
stringundefined

customconfig

Define advertising configuration by passing in keys and values. More details.

E.g. customConfig[key]=values

Typedefault value
objectundefined

scalemode

To adjust the player’s video focus.

Possible values: fit fill fillLeft fillRight fillTop fillBottom

Typedefault value
enumfit

mute

Whether to mute the video or not. To note, enabling mute may impact monetization.

The Player provides smart mute behavior, it tries to automatically start the video playback with sound.

If this isn’t possible due to browser prevention, there is a fallback mechanism and the Player reattempts to play the video but with the sound set to mute.

Possible values: true or false

Typedefault value
booleanfalse

startTime

Specify the time (in seconds) from which the video should start playing.

Typedefault value
number0

loop

To set the video to loop. More details.

Possible values: true or false

Typedefault value
booleanfalse