SmartclipApi

Kind: global class

new SmartclipApi(playerProxy, config)

Param Type Description
playerProxy Object extended from FacadeBase
config Object Global configuration

smartclipApi.adInfo ⇒ AdInfo

Combination of generic properties of all types of ads and custom properties that depend on VAST Extensions.

Kind: instance property of SmartclipApi
Returns: AdInfo - Represents static information about the current ad

smartclipApi.adInteractiveState ⇒ Boolean

Returns whether the current ad is interactive (most likely by using VPAID) or not.

Kind: instance property of SmartclipApi
Returns: Boolean - True if the current ad has been specified as interactive

smartclipApi.adCompanions ⇒ Array

The value of this property is an Array that provides ad companion details in VAST 3.0 format for the <CompanionAds> element. The video player should request this value whenever it receives the ON_COMPANIONS_DETECTED add-on event.

Kind: instance property of SmartclipApi
Returns: Array - List of all companion ads

smartclipApi.adExtensions ⇒ Array

The value of this property is an Array that provides ad extension details for the <Extensions> element. The video player should request this value whenever it receives the ON_EXTENSIONS_DETECTED add-on event.

Kind: instance property of SmartclipApi
Returns: Array - List of all extensions

smartclipApi.initAdSlot(adBreak, environmentVars) ⇒ Promise

Invokes a commercial break by requesting the specified ad setup from the ad server.

Kind: instance method of SmartclipApi
Returns: Promise - Resolves if loading the ad manifests has been completed

Param Type Description
adBreak AdBreak Configuration for the upcoming ad break.
environmentVars EnvironmentVars Defines environment conditions for the upcoming ad break

smartclipApi.startAdSlot()

Starts the ad break. The add-on responds by sending an ON_AD_SLOT_START event notifying the video player the ad break is going to start.

Kind: instance method of SmartclipApi

smartclipApi.stopAdSlot()

Stops a running ad break. The add-on responds by sending an ON_AD_SLOT_COMPLETE event notifying the video player it has closed and cleaned up ad resources. Also the content of the video player has been reseted.

Kind: instance method of SmartclipApi

smartclipApi.skipAd()

Skips (stops) a running single ad The add-on respondes by sending the ON_AD_SKIPPED event notifying the video player it has closed and cleaned up a single ad.

_Note: The add-on does proceed with the next ad. Canceling the whole ad break requires calling stopAdSlot() instead.

Kind: instance method of SmartclipApi

smartclipApi.resize(boundingRectangle, viewMode)

Following a resize of the video player, the video player calls resize() to allow the add-on to scale and reposition itself within the display area. The add-on responds by sending an 'ON_AD_SIZE_CHANGED` event.

Kind: instance method of SmartclipApi

Param Type Description
boundingRectangle Rectangle The video content display as a Rectangle {width, height, top, left}
viewMode string Current viewing mode (normal, fullscreen, thumbnail, dynamic)

smartclipApi.clickThrough()

Following a click on the ad, the video player calls clickThrough() to allow the add-on to request the advertisers landing page and call the ClickThru tracking requests.

Kind: instance method of SmartclipApi

smartclipApi.pauseAd()

Pauses the current ad break. The add-on responds by sending the ON_AD_PAUSED event.

Kind: instance method of SmartclipApi

smartclipApi.resumeAd()

Resumes the current ad break. The add-on responds by sending the ON_AD_PLAYING event.

Kind: instance method of SmartclipApi