AdEvent.AdEventType

public static final enum AdEvent.AdEventType extends Enum<AdEvent.AdEventType>

Types of events that can occur during ad playback.

Inherited Method Summary

Enum Values

public static final AdEvent.AdEventType AD_BREAK_ENDED

Fired by the native JS when an ad break in a stream ends. Communicated to the publisher via player APIs.

public static final AdEvent.AdEventType AD_BREAK_READY

Fired when an ad break is ready from VMAP or ad rule ads. This will only fire if autoPlayAdBreaks has been set to false in ImaSdkSettings. If autoPlayAdBreaks is true, ads will play without firing this event. Here, adData has the following property:
- adBreakTime: the time at which the ad break occurred. 0 for pre-rolls, -1 for post-rolls. For mid-rolls, content playhead time, in seconds.

public static final AdEvent.AdEventType AD_BREAK_STARTED

Fired by the native JS when an ad break in a stream starts. Communicated to the publisher via player APIs.

public static final AdEvent.AdEventType AD_PROGRESS

Fired to inform of ad progress during dynamic ad insertion stream playback and can be used by publisher to display a countdown timer.

public static final AdEvent.AdEventType ALL_ADS_COMPLETED

Fired when all ads managed by the current ads manager have finished playing.

public static final AdEvent.AdEventType CLICKED

Fired when an ad is clicked.

public static final AdEvent.AdEventType COMPLETED

Fired when an ad completes playing.

public static final AdEvent.AdEventType CONTENT_PAUSE_REQUESTED

Fired when content should be paused. This usually happens right before an ad is about to hide the content.

public static final AdEvent.AdEventType CONTENT_RESUME_REQUESTED

Fired when content should be resumed. This usually happens when an ad finishes or collapses.

public static final AdEvent.AdEventType CUEPOINTS_CHANGED

Fired when VOD stream cuepoints have changed.

public static final AdEvent.AdEventType FIRST_QUARTILE

Fired when the ad playhead crosses first quartile.

public static final AdEvent.AdEventType ICON_TAPPED

Fired when an icon is tapped.

public static final AdEvent.AdEventType LOADED

Fired when the VAST response has been received.

public static final AdEvent.AdEventType LOG

Fired to enable the SDK to communicate a message to be logged, which is stored in adData. This can be fired when a VPAID ad sends a LOG message, or in the event of a non-fatal playback error (e.g. an ad in a pod cannot be played). Here, adData has the following properties:
- type: the type of error.
- errorCode: the error code.
- errorMessage: the error message.
- innerError: detailed information about the error, if applicable; will be absent otherwise.

public static final AdEvent.AdEventType MIDPOINT

Fired when the ad playhead crosses midpoint.

public static final AdEvent.AdEventType PAUSED

Fired when an ad is paused.

public static final AdEvent.AdEventType RESUMED

Fired when an ad is resumed.

public static final AdEvent.AdEventType SKIPPED

Fired when an ad was skipped.

public static final AdEvent.AdEventType STARTED

Fired when an ad starts playing.

public static final AdEvent.AdEventType TAPPED

Fired when a non-clickthrough portion of a video ad is clicked.

public static final AdEvent.AdEventType THIRD_QUARTILE

Fired when the ad playhead crosses third quartile.

Send feedback about...

IMA SDK for Android
Need help? Visit our support page.