While the main Player experience is controlled using the settings defined in your Player configuration, additional runtime customization is achievable using client-side parameters.
| 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. | object |
scaleMode | fit | To adjust the player’s video focus. Possible values: | enum |
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: | boolean |
autoplay | false | Automatically attempt to start playback 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 |
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 |
autoplay
autoplayAutomatically attempt to start playback
| Type | default value |
|---|---|
| boolean | false |