Class: StreamEvent

Enumeration

Type

static

string

List of event types supported by the IMA DAI SDK.

Value

LOADED

Fired when the stream manifest is available.

AD_BREAK_STARTED

Fired when an ad break starts.

AD_BREAK_ENDED

Fired when an ad break ends.

AD_PERIOD_STARTED

Fired when an ad period starts. This includes the entire ad break including slate as well. This event will be fired even for ads that are being replayed or when seeking to the middle of an ad break.

AD_PERIOD_ENDED

Fired when an ad period ends.

AD_PROGRESS

Fired when there is an update to an ad's progress.

CUEPOINTS_CHANGED

Dispatched for on-demand streams when the cuepoints change.

CLICK

Dispatched when the click element is clicked or tapped while an ad is being played.

ERROR

Fired when an error occurs.

STARTED

Fired when an ad starts.

FIRST_QUARTILE

Fired when an ad reaches its first quartile.

MIDPOINT

Fired when an ad reaches its midpoint.

STREAM_INITIALIZED

Fired when the stream is initialized.

THIRD_QUARTILE

Fired when an ad reaches its third quartile.

COMPLETE

Fired when an ad is complete.

SKIPPABLE_STATE_CHANGED

Fired when the displayed ad's skippable state is changed.

SKIPPED

Fired when the ad is skipped by the user.

VIDEO_CLICKED

Fired when a user clicks on the video without triggering clickthrough. When a "Learn More" button is shown, such as when on mobile web, the CLICK event is only fired when clicking the button. Other clicks will fire this event.

Property

Type

static

string

List of event types supported by the IMA DAI SDK.

Value

LOADED

Fired when the stream manifest is available.

AD_BREAK_STARTED

Fired when an ad break starts.

AD_BREAK_ENDED

Fired when an ad break ends.

AD_PERIOD_STARTED

Fired when an ad period starts. This includes the entire ad break including slate as well. This event will be fired even for ads that are being replayed or when seeking to the middle of an ad break.

AD_PERIOD_ENDED

Fired when an ad period ends.

AD_PROGRESS

Fired when there is an update to an ad's progress.

CUEPOINTS_CHANGED

Dispatched for on-demand streams when the cuepoints change.

CLICK

Dispatched when the click element is clicked or tapped while an ad is being played.

ERROR

Fired when an error occurs.

STARTED

Fired when an ad starts.

FIRST_QUARTILE

Fired when an ad reaches its first quartile.

MIDPOINT

Fired when an ad reaches its midpoint.

STREAM_INITIALIZED

Fired when the stream is initialized.

THIRD_QUARTILE

Fired when an ad reaches its third quartile.

COMPLETE

Fired when an ad is complete.

SKIPPABLE_STATE_CHANGED

Fired when the displayed ad's skippable state is changed.

SKIPPED

Fired when the ad is skipped by the user.

VIDEO_CLICKED

Fired when a user clicks on the video without triggering clickthrough. When a "Learn More" button is shown, such as when on mobile web, the CLICK event is only fired when clicking the button. Other clicks will fire this event.

Methods

getAd

getAd() returns Ad

Returns

nullable Ad return object with ad information.

getStreamData

getStreamData() returns StreamData

Returns

non-null StreamData return object with stream information.