...
Variable | Type | Description |
|---|---|---|
adConfig | Object | Default adConfig for ads |
position | String | The div id where the player should be positioned |
width | Number | The width of the player. If width is 100 and height is 0, the player automatically adopt to the space available |
height | Number | The height of the player |
minHeight | Number | Minimum player height |
maxWidth | Number | Maximum player width |
autoPlay | Boolean | Start playing automatically or wait for click on the play button |
autoLoop | Boolean | Automatically restart playlist when it ends |
autoContinue | Boolean | Auto continue to next content when the content ends |
showReplay | Boolean | Show or not the replay button when playlist ends (and autoLoop is false) |
replayText | String | Text to show with replay button |
showTitle | String | Where to show the content title. Possible values - left/right |
title | Object | Show title even in 180px-300px |
title.position | String | x-y-z e.g. bottom-right-middle |
caption | Object | Note: only works if captionBgColor is defined! |
captionBgColor | String | A color for text caption/label (even if caption is not defined, i.e. empty) at the top of the player |
content | Object | Content object |
content.order | Number | 0: Order of content according to configuration |
content.randomFrom | Number | If order is 1, randomize from the content defined |
content.breakingAds | Number/false |
|
content.breakingAdsMode | String | Ads mode of the player:
|
content.impCap | Number | Max number of ads allowed in the player |
content.contents | Array | Array of video content elements |
content.contents[].id | String | Unique id of the content |
content.contents[].url | String | Url of video to play |
content.contents[].fallbackUrl | String | Optional fallback url of video. Typically used with hls videos and will be used if hls video fails to play |
content.contents[].clickThrough | String | If defined, when clicking on the video it will open this url |
content.contents[].type | String | Must be “video“ |
content.contents[].impCap | Number | Max number of impressions for this video |
content.contents[].slots | Array | Array of slots configuration for this video. Used only with “op“ and “default“ breakingAdsMode |
content.firstPrerollSlot | Object | Slot configuration for the first preroll in the player |
content.commonSlots | Array | Array of slots configuration that is used for all contents. Will be merged with slots defined per content if any |
content.contents[].slots[].adConfig | Object | adConfig for the specific slot. Used only with “default“ mode, replace slots with commonSlots[] or firstPrerollSlot |
content.contents[].slots.time | Number | Time in seconds when we want to play the ad. 0 for preroll, replace slots with commonSlots[] or firstPrerollSlot |
content.contents[].slots.preloadAdTime | Number | V2.54 and above |
content.contents[].slots.nextAdTimeout | Number | V2.54 and above |
content.contents[].slots.maxAds | Number | V2.54 and above |
floating, sticky | Object | floating or sticky configuration |
floating.resize | Boolean | If true, the floating resize the player and not using scale |
floating.size sticky.size | Number | The resize scale of the floated player. 0-1 With sticky set to 1 |
floating.floatOnBottom | Boolean | Float the player also when the player is below the view. Relevant only to floating |
floating.position sticky.position | String | Can be one of: “bottom-right“, “bottom-left“, “top-right“, “top-left“, “top”, ”bottom” |
floating.closeButton | Boolean | Show close button on floating player |
floating.left sticky.left | Number | Margin from the left of the screen |
floating.right sticky.right | Number | Margin from the right of the screen |
floating.top sticky.top | Number | Margin from the top of the screen |
floating.bottom sticky.bottom | Number | Margin from the bottom of the screen |
floating.textFont | String | Set the font for the text, make sure showTitle is set. Relevant for floating.position: top/bottom |
floating.textColor | Object | Set the text color, options are Black/White, make sure showTitle is set. Relevant for floating.position: top/bottom |
floating.backgroundColor | Object | Set the background color, options are Black/White, make sure showTitle is set. Relevant for floating.position: top/bottom |
floating.textSize | Number | Set the text size, make sure showTitle is set. Relevant for floating.position: top/bottom |
floating.floatOnView | Boolean | Start floating only when in view. |
floating.when | String | Can be set to “on-ads” |
showBigPlay | Boolean | Show big play button |
showBigPlayOnPause | Boolean | Show or not the big play button when the player is paused |
showBigPrevNextOnPause | Boolean | Show or not the prev and next buttons when the player is paused |
soundButtonPosition | String | The position of the sound button on the controls bar. Can be “left“ or “right“ |
showPauseButton | Boolean | Show or not the play/pause button on the control bar |
showPrevButton | Boolean | Show or not the prev button on the control bar |
showNextButton | Boolean | Show or not the next button on the control bar |
showBigPrevNext | Boolean | Show or not the big prev and next buttons |
showSoundButton | Boolean | Show or not the sound button at the control bar |
showVolumeControl | Boolean | Show or not the volume control on the control bar |
volumeControlVertical | Boolean | Show vertical or horizontal volume control bar |
durationPosition | String | Video duration position in the control bar. Can be “left“ or “right“ |
showDuration | Boolean | Show or not the video duration |
showTimelineReplay | Boolean | Show or not the replay button on content/playlist end |
showFullScreen | Boolean | Show or not the full screen button |
hideGuiOnMouseout | Boolean | In desktop, hide or don’t hide play gui when mouse is out of player area |
hideGuiTimeout | Number(2) | In mobile, number of sec to wait before hiding timeout after first click on UI |
timelineMode | String |
|
spinner | String |
|
theme | String |
|
themeColor | String | Color code for controls |
logo | Object | Custom logo info |
logo.url | String | URL of logo png |
logo.text | String | Text to show with the logo |
logo.size | Number | Size in pixels of the logo |
logo.position | String | Position of the logo. Can be: “top-left“, “top-right“ |
startVolume | Number | Start volume. With autoPlay: true must be set to 0 |
syncVolume | Boolean | Sync ads and content volume |
startMode | Object | Prevent the player to load content before it have an imprssion. |
startMode.mode | String | For now, supports only "WaitForAd", it’s a must variable for the configuration |
startMode.hidden | Boolean | The player will be hidden and will open only if it got an impression, when opens it will open growing height animation. |
startMode.openAnim | Boolean | Supports the “hidden” flag and will make the player open with animation |
startMode.showPlayer | Boolean | Always open the space of the player, even if the player is hidden |
startMode.noFloat | Boolean | When the poster is shown, and the player is with floating configuartin, the player won’t float until an impression will occur or the play button will be pressed. |
startMode.playButtonDelay | Number | In case there is no impression the play button will appear after “playButtonDelay” seconds. |
autoSkip | Object | Activate the auto skip functionality, after 20 seconds a skip button with a filling bar for 10 seconds will appear. If any gesture on the player won’t accrue, the player will skip the content. It is also possible to click the next button to skip immediately. Relevant for mode “OP” only |
autoSkip.text | String | Set custom text for auto skip button |
autoSkip.time | Number | Default is 30 seconds, the end time in which the player will skip |
autoSkip.timeout | Number | Default is 10 seconds, the timeout in which the auto skip will appear before the autoSkip.time |
passback | Object | Allows to close the player and open an iframe instead |
passback.url | String | For non txt passback.type: Uses it as a string to output |
passback.width | Number | Width of passback iframe. Default 100% |
passback.height | Number | Height of passback iframe. Default 100% |
passback.color | String | Background color. default |
passback.type | String | Options: ‘script' | ‘html' | 'txt' - Type of the passback file. Default "script" |
passback.mode | String | Options: 'Immediate' | 'OnContentEnd' | 'OnPlaylistEnd' "Immediate" - after error limit "OnContentEnd" - after error limit + end of current content "OnPlaylistEnd" - after error limit + end of playlist |
showQualityTracks | Boolean | Set true to enable the option to choose different video qualities |
readMoreButton | Object | Control the Read More button |
readMoreButton.enable | Boolean | Can change to false from the default true |
readMoreButton.label | String | Changes the text for readmore |
readMoreButton.preventOtherClickThrough | Boolean | Can change to true from the default false in order to make only the Read More lead to the landing page as opposed to the entire player |
readMoreButton.position | String | Can change the default ( |
...