AdEvent.AdEventType

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

Types of events that can occur during ad playback.

Inherited Method Summary

From class java.lang.Enum

final int	compareTo(E arg0)
int	compareTo(Object arg0)
final boolean	equals(Object arg0)
final Class<E>	getDeclaringClass()
final int	hashCode()
final String	name()
final int	ordinal()
String	toString()
static <T extends Enum<T>> T	valueOf(Class<T> arg0, String arg1)

From class java.lang.Object

boolean	equals(Object arg0)
final Class<?>	getClass()
int	hashCode()
final void	notify()
final void	notifyAll()
String	toString()
final void	wait(long arg0, int arg1)
final void	wait(long arg0)
final void	wait()

From interface java.lang.Comparable

abstract int

compareTo(E extends Enum<E> arg0)

Enum Values

public static final AdEvent.AdEventType AD_BREAK_ENDED

Fired when an ad break in a stream ends. Communicated to the publisher through player APIs.

public static final AdEvent.AdEventType AD_BREAK_FETCH_ERROR

Fired when an ad break will not play back any ads.

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 when an ad break in a stream starts. Communicated to the publisher through player APIs.

public static final AdEvent.AdEventType AD_BUFFERING

Fired when playback stalls while the ad buffers.

public static final AdEvent.AdEventType AD_PERIOD_ENDED

Fired when an ad period in a stream ends. Communicated to the publisher through player APIs.

public static final AdEvent.AdEventType AD_PERIOD_STARTED

Fired when an ad period in a stream starts. Communicated to the publisher through player APIs. 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.

public static final AdEvent.AdEventType AD_PROGRESS

Fired to inform of ad progress and can be used by publisher to display a countdown timer.

public static final AdEvent.AdEventType ALL_ADS_COMPLETED

Fired when the ads manager is done playing all the valid ads in the ads response, or when the response doesn't return any valid ads.

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_FALLBACK_IMAGE_CLOSED

The user has closed the icon fallback image dialog. This may be a good time to resume ad playback if the user is ready to continue playing the ad. This event only fires for Connected TV devices.

public static final AdEvent.AdEventType ICON_TAPPED

The user has tapped an ad icon. On Android mobile apps, the SDK will navigate to the landing page. On Connected TV devices, the SDK will present a modal dialog containing the VAST icon fallback image.

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 (for example, 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 SKIPPABLE_STATE_CHANGED

Fired when an ad changes its skippable state.

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.