Custom visual parameters:
The customization options related to visual aspects will always be within the iframe route, passed as query parameters.
| Variable | Description | Values | Default |
|---|---|---|---|
| primaryColor | When filled as a query parameter, it will modify the primary color of all player items that use it as a reference. | Default HEX value | "#EDEDED" |
| watermarkOpacity | Sets the opacity of the watermark, if it exists. | 0.1 to 1 | 0.8 |
| watermarkPosition | When set in the query parameters, adjusts the position of the watermark on the screen. | "top-right", "top-center", "top-left", "bottom-right", "bottom-center", "bottom-center" | "top-right" |
| watermarkText | When filled in the query parameters, it displays a text watermark in the top right corner of the screen (if filled, it will override the image watermark). | "Example value" | null |
| watermarkTime | When filled in the query parameters, it defines the time which the watermark fades in/out | number | 15 |
| watermarkType | When filled in the query parameters, it displays a watermark in the top right corner of the screen (if filled, it will override the image watermark). | "text" or "img" | null |
| watermarkUrl | Set the watermark's link. | string | null |
Custom behavior parameters:
The customization options related to behavior will always be referenced in the query parameters. If you want to use the default behavior, it is not necessary to declare them in the iframe.
| Variable | Description | Values | Default |
|---|---|---|---|
| aspectRatio | Declare the video's aspect ratio. | "1:1", "4:3", "9:16", "16:9", "21:9" | "16:9" |
| autoplay | When inserted as a query parameter and set to 1, the video player will start playing upon page load. | number | 0 |
| controls | When set in the query parameters as 0, the video player controls will be disabled. | number | 1 |
| pip | When set to 1 in the query parameters, allows the video to be played in a Picture-in-Picture (PIP) window provided by the browser, if supported. | number | 1 |
| fullscreen | If set to 0, disables the fullscreen option for the user. | number | 0 |
| loop | When set to 1 in the query parameters, the video will continuously loop, restarting after reaching the end. | number | 0 |
| muted | When set to 1 in the query parameters, the video will be played in muted mode, without audio. | number | 0 |
| preload | If set to 0, disables video preloading. | number | 1 |
| responsive | If set to 0, disables responsive layout in the player. | number | 1 |
| seekStep | Sets the time interval, in seconds, that the player should seek forward or backward when the seek keys (forward/backward) are pressed. | number | 5 |
| seekTo | Set in seconds, the time which the video should start. | number | 0 |
| startSummary | Sets if the video should start as summarized, 0 starts with the default, 1 as summarized. | number | 0 |
| volumeStep | Sets the volume increment/decrement when the volume keys are pressed. | number | 0.2 |