Pulse SDK API Documentation Namespaces

Classes

Ad
Companion
HtmlResource
IFrameResource
InsertionPoint
LinearCreative
MediaFile
NonLinearCreative
Session
Slot
StaticResource
LogItem

Namespaces

OO
Pulse
Events
Settings
RenderingMode
CustomBehaviours
videoplaza
adresponse

Events

AD_AUTOPLAY_BLOCKED

Fired when the ad player detects that a VPAID 2.0 ad has attempted to autoplay a video, but was blocked by the browser. Generally only happens on mobile browsers to reduce data usage.

Type: object

AD_BREAK_EMPTY

Fired when an ad break containing no playable ads was discarded.

Type: object

AD_BREAK_FINISHED

Fired when an ad break has finished.

Type: object

Properties:

Name	Type	Description
`adBreak`	OO.Pulse.AdBreak	The ad break that finished.

AD_BREAK_FINISHING

Fired when an ad break is about to finish.

Type: object

Properties:

Name	Type	Description
`adBreak`	OO.Pulse.AdBreak	The ad break that is about to finish.
`isBumperPosition`	boolean	If true, a sponsor ad just finished playing and there were no normal ads remaining in the break. This will only be `true` in case of postroll breaks.
`defer`	OO.Pulse.AdBreak~defer	A function which lets you prevent the ad break from finishing automatically, which in turn prevents the content playback from starting. `defer` must be called inside the event handler in order to work.

AD_BREAK_STARTED

Fired when an ad break has started, before the first ad has played.

Type: object

Properties:

Name	Type	Description
`adBreak`	OO.Pulse.AdBreak	The ad break that started.

AD_BREAK_STARTING

Fired when an ad break is about to start.

Type: object

Properties:

Name	Type	Description
`adBreak`	OO.Pulse.AdBreak	The ad break that is about to start.
`defer`	OO.Pulse.AdBreak~defer	A function which lets you prevent the ad break from starting automatically. `defer` must be called inside the event handler in order to work.

AD_CLICKED

Fired when the ad video was clicked. If the integration chooses to open the ad's clickthrough page on this event, it should then call adClickThroughOpened on the ad player instance.

Type: object

Properties:

Name	Type	Description
`url`	string	Clickthrough URL

AD_CLICKTHROUGH

Fired when a clickthrough link was opened.

Type: object

Properties:

Name	Type	Description
`url`	string	Clickthrough URL

AD_PLAY_PROMISE_REJECTED

Fired when the play of an ad gets rejected

Type: object

Properties:

Name	Type	Description
`error`	object	Error, which caused the rejection

AD_SESSION_FINISHED

Fired when the content and the postrolls are done playing. If there are no postrolls, AD_SESSION_FINISHED is fired right after the the end of the content.

Type: object

AD_VOLUME_CHANGED

Fired when an ad's volume has changed.

Type: object

Properties:

Name	Type	Description
`volume`	Number	New ad volume between 0 and 1

FLASH_AD_BLOCKED

Fired when Flash is blocked or unavailable, and only Flash based assets are available for the ad.

Type: object

LINEAR_AD_ERROR

Fired when a linear ad has encountered an error during or before playback.

Type: object

LINEAR_AD_FINISHED

Fired when a linear ad has finished playback.

Type: object

LINEAR_AD_FIRST_QUARTILE

Fired when a linear ad has played to 25% of its duration.

Type: object

Properties:

Name	Type	Description
`ad`	OO.Pulse.VideoAd	The ad that reached 25% of playback.

LINEAR_AD_IMPRESSION

Fired when impression is tracked for a linear ad.

Type: object

Properties:

Name	Type	Description
`ad`	OO.Pulse.VideoAd	The ad for which an impression was tracked.

LINEAR_AD_MIDPOINT

Fired when a linear ad has played to 50% of its duration.

Type: object

Properties:

Name	Type	Description
`ad`	OO.Pulse.VideoAd	The ad that reached 50% of playback.

LINEAR_AD_PAUSED

Fired when a linear ad is paused.

Type: object

LINEAR_AD_PLAYING

Fired when a linear ad has started playing, either on first play or when resuming from a paused state.

Type: object

LINEAR_AD_PROGRESS

Fired every time a linear ad's playback position is updated.

Type: object

Properties:

Name	Type	Description
`position`	Number	Playhead position in seconds
`duration`	Number	Total ad duration

LINEAR_AD_SKIPPED

Fired when a linear ad has been skipped by the user.

Type: object

LINEAR_AD_STARTED

Fired when a linear ad has started playing.

Type: object

Properties:

Name	Type	Description
`ad`	OO.Pulse.VideoAd	The ad that started playing.
`adPosition`	Number	The position of the ad in the current ad break.
`selectedMediaFile`	videoplaza.adresponse.MediaFile	The media file selected for playback.

LINEAR_AD_STARTING

Fired when a linear ad is about to start playing.

Type: object

Properties:

Name	Type	Description
`ad`	OO.Pulse.VideoAd	The ad that is about to start playing.
`adPosition`	Number	The position of the ad in the current ad break.
`isBumperPosition`	boolean	If true, a sponsor ad is about to play (during preroll and midrolls breaks), or a sponsor ad just finished playing (postroll breaks).
`defer`	OO.Pulse.VideoAd~defer	A function which lets you prevent ad playback from starting automatically. `defer` must be called inside the event handler in order to work.

LINEAR_AD_THIRD_QUARTILE

Fired when a linear ad has played to 75% of its duration.

Type: object

Properties:

Name	Type	Description
`ad`	OO.Pulse.VideoAd	The ad that reached 75% of playback.

OVERLAY_AD_CLICKED

Fired when an overlay ad is clicked.

Type: object

OVERLAY_AD_CLOSED

Fired when an overlay ad is closd.

Type: object

OVERLAY_AD_ERROR

Fired when an overlay ad could not display.

Type: object

OVERLAY_AD_SHOWN

Fired when an overlay ad is shown.

Type: object

PAUSE_AD_CLOSED

Fired when a pause ad is closed using the close button.

Type: object

PAUSE_AD_PLAYER_HIDDEN

Fired when a pause ad is hidden (when the content resumes, for example). This event can be used by a UI skin to know when to hide the pause ad close button.

Type: object

PAUSE_AD_SHOWN

Fired when a pause ad is displayed.

Type: object

SESSION_STARTED

Fired when an ad session begins.

Type: object

Properties:

Name	Type	Description
`isPlayingPrerolls`	boolean	If true, the session has started with a preroll ad playing. If false, there are no prerolls and the content has started playing.

SHOW_SKIP_BUTTON

Fired when a skippable ad's skip button should be displayed.