StreamEvent
This event type is raised by the stream manager as a notification when the stream state changes.
Enumeration
Type
string
List of event types supported by the IMA DAI SDK.
Value
LOADED
Fired when the stream manifest is available.
AD_BREAK_STARTED
Fired first time each ad break begins playback. If an ad break is watched subsequent times this will not be fired. Applications must disable seeking when this occurs.
AD_BREAK_ENDED
Fired the first time each ad break ends. Applications must reenable seeking when this occurs.
AD_PERIOD_STARTED
Fired every time the stream switches from content to advertising or slate. This will be fired even when an ad is played a second time or when seeking into an ad.
AD_PERIOD_ENDED
Fired every time the stream switches from advertising or slate to content. This will be fired even when an ad is played a second time or when seeking into an ad.
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.
PAUSED
Fired when the ad is paused by the user.
RESUMED
Fired when the ad is resumed by the user.
Properties
data
any type
data
any type
Type
string
List of event types supported by the IMA DAI SDK.
Value
LOADED
Fired when the stream manifest is available.
AD_BREAK_STARTED
Fired first time each ad break begins playback. If an ad break is watched subsequent times this will not be fired. Applications must disable seeking when this occurs.
AD_BREAK_ENDED
Fired the first time each ad break ends. Applications must reenable seeking when this occurs.
AD_PERIOD_STARTED
Fired every time the stream switches from content to advertising or slate. This will be fired even when an ad is played a second time or when seeking into an ad.
AD_PERIOD_ENDED
Fired every time the stream switches from advertising or slate to content. This will be fired even when an ad is played a second time or when seeking into an ad.
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.
PAUSED
Fired when the ad is paused by the user.
RESUMED
Fired when the ad is resumed by the user.
Methods
getAd
getAd() returns (null or Ad )
- Returns
-
(null or non-null Ad )return object with ad information.
getStreamData
getStreamData() returns StreamData
- Returns
-
non-null StreamDatareturn object with stream information.
