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 |
|---|---|---|---|
| undefined | The ID of the video to load. | string |
| undefined | The ID of the playlist to load. | string |
| undefined | Define advertising configuration by passing in keys and values. More details. E.g. | object |
|
| To adjust the player’s video focus. Possible values: | enum |
|
| 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: | boolean |
|
| Specify the time (in seconds) from which the video should start playing. | number |
|
| To set the video to loop. More details. Possible values: | boolean |
video
videoThe ID of the video to load.
| Type | default value |
|---|---|
| string | undefined |
playlist
playlistThe ID of the playlist to load.
| Type | default value |
|---|---|
| string | undefined |
customconfig
customconfigDefine advertising configuration by passing in keys and values. More details.
E.g. customConfig[key]=values
| Type | default value |
|---|---|
| object | undefined |
scalemode
scalemodeTo adjust the player’s video focus.
Possible values: fit fill fillLeft fillRight fillTop fillBottom
| Type | default value |
|---|---|
| enum | fit |
mute
muteWhether 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
| Type | default value |
|---|---|
| boolean | false |
startTime
startTimeSpecify the time (in seconds) from which the video should start playing.
| Type | default value |
|---|---|
| number | 0 |
loop
loopTo set the video to loop. More details.
Possible values: true or false
| Type | default value |
|---|---|
| boolean | false |
