Versions Compared

Old Version 15

changes.mady.by.user Gal Leshem

Saved on

compared with

New Version 16

changes.mady.by.user Itay Nave

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
firstPrerollSlot: {
  "time": 0,            //Slot time, 0 is preroll
  "nextAdTimeout": 6,   //If more than one ads in the slot, the timeout for the second ad
  "preloadAdTime": 10,  //Timeout for the first ad in the slot 
  "maxAds": 2           //Maximum number of ads in the slot
},
commonSlots: [{
  "time": 0,
  "nextAdTimeout": 8,
  "preloadAdTime": 15,
  "maxAds": 4           //2 as postrolls 2 as prerolls of the second content and on
}]

Configuration Options

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

content

Object

Content object

content.order

Number

0: Order of content according to configuration
1: random

content.randomFrom

Number

If order is 1, randomize from the content defined

content.breakingAds

Number/false

  • false: No breaking ads
    Must be false with breakingAdsMode “op“ and “default“

  • Number: Defines midrollTime - time between running the waterfall
    Mast be set with breakingAdsMode: “os“

content.breakingAdsMode

String

Ads mode of the player:
See above for detailed info

  • “os”: The player runs the ad module and whenever and ad is available it will break and pause the content

  • “op“: (Recommended) The player will search for ads and start the ads as defined in the slots configuration.

  • “default“: The player will search for ads and start the ads as defined in the slots configuration.

content.impCap

Number

Max number of ads allowed in the player

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

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.contents[].slots[].adConfig

Object

adConfig for the specific slot. Used only with “default“ mode

content.contents[].slots.time

Number

Time in seconds when we want to play the ad. 0 for preroll

content.contents[].slots.preloadAdTime

Number

V2.54 and above
Timeout in sec for first ad in the slot
use content.contents[].slots.timeout in previous versions

content.contents[].slots.nextAdTimeout

Number

V2.54 and above
Timeout in sec for next ads in the slot. Relevant only if maxAds bigger than 1

content.contents[].slots.maxAds

Number

V2.54 and above
Max number of ads in the slot

floating, sticky

Object

floating or sticky configuration
floating: The player floats when not in view
sticky: The player floats all the time

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.

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

Show or not the replay button on content/playlist end

showFullScreen

Show or not the full screen button

hideGuiOnMouseout

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

  • Default: Show default timeline

  • Bottom: Timeline is shown on the bottom of the control bar

    • None: No timeline

spinner

String

  • Default: Show circle spinner

  • Dots: Show dots spinner ...

  • None: Dont show spinne

theme

String

  • Default: Control bar has grayed background

  • Solid: Control bar has no grayed background

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.
Relevant for mode “OP” with preroll and mode “OS”
Adds functionality to the player when it opens.
By not adding more flags the player will show the poster of the first content until an impression will occur or the play button will be pressed, in case there is no poster it will show a black screen.

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.
By pressing it the content video will start

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.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