AdEvent.AdEventType

Kotlin |Java

enum AdEvent.AdEventType

Types of events that can occur during ad playback.

Summary

Enum Values
`AD_BREAK_ENDED`	Fired when an ad break in a stream ends.
`AD_BREAK_FETCH_ERROR`	Fired when an ad break will not play back any ads.
`AD_BREAK_READY`	Fired when an ad break is ready from VMAP or ad rule ads.
`AD_BREAK_STARTED`	Fired when an ad break in a stream starts.
`AD_BUFFERING`	Fired when playback stalls while the ad buffers.
`AD_PERIOD_ENDED`	Fired when an ad period in a stream ends.
`AD_PERIOD_STARTED`	Fired when an ad period in a stream starts.
`AD_PROGRESS`	Fired to inform of ad progress and can be used by publisher to display a countdown timer.
`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.
`CLICKED`	Fired when an ad is clicked.
`COMPLETED`	Fired when an ad completes playing.
`CONTENT_PAUSE_REQUESTED`	Fired when content should be paused.
`CONTENT_RESUME_REQUESTED`	Fired when content should be resumed.
`CUEPOINTS_CHANGED`	Fired when VOD stream cuepoints have changed.
`FIRST_QUARTILE`	Fired when the ad playhead crosses first quartile.
`ICON_FALLBACK_IMAGE_CLOSED`	The user has closed the icon fallback image dialog.
`ICON_TAPPED`	The user has tapped an ad icon.
`LOADED`	Fired when the VAST response has been received.
`LOG`	Fired to enable the SDK to communicate a message to be logged, which is stored in adData.
`MIDPOINT`	Fired when the ad playhead crosses midpoint.
`PAUSED`	Fired when an ad is paused.
`RESUMED`	Fired when an ad is resumed.
`SKIPPABLE_STATE_CHANGED`	Fired when an ad changes its skippable state.
`SKIPPED`	Fired when an ad was skipped.
`STARTED`	Fired when an ad starts playing.
`TAPPED`	Fired when a non-clickthrough portion of a video ad is clicked.
`THIRD_QUARTILE`	Fired when the ad playhead crosses third quartile.

Public functions
`java-static AdEvent.AdEventType!`	`valueOf(name: String!)` Returns the enum constant of this type with the specified name.
`java-static Array<AdEvent.AdEventType!>!`	`values()` Returns an array containing the constants of this enum type, in the order they're declared.

Enum Values

AD_BREAK_ENDED

val AdEvent.AdEventType.AD_BREAK_ENDED: AdEvent.AdEventType

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

AD_BREAK_FETCH_ERROR

val AdEvent.AdEventType.AD_BREAK_FETCH_ERROR: AdEvent.AdEventType

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

AD_BREAK_READY

val AdEvent.AdEventType.AD_BREAK_READY: AdEvent.AdEventType

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.

AD_BREAK_STARTED

val AdEvent.AdEventType.AD_BREAK_STARTED: AdEvent.AdEventType

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

AD_BUFFERING

val AdEvent.AdEventType.AD_BUFFERING: AdEvent.AdEventType

Fired when playback stalls while the ad buffers.

AD_PERIOD_ENDED

val AdEvent.AdEventType.AD_PERIOD_ENDED: AdEvent.AdEventType

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

AD_PERIOD_STARTED

val AdEvent.AdEventType.AD_PERIOD_STARTED: AdEvent.AdEventType

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.

AD_PROGRESS

val AdEvent.AdEventType.AD_PROGRESS: AdEvent.AdEventType

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

ALL_ADS_COMPLETED

val AdEvent.AdEventType.ALL_ADS_COMPLETED: AdEvent.AdEventType

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.

CLICKED

val AdEvent.AdEventType.CLICKED: AdEvent.AdEventType

Fired when an ad is clicked.

COMPLETED

val AdEvent.AdEventType.COMPLETED: AdEvent.AdEventType

Fired when an ad completes playing.

CONTENT_PAUSE_REQUESTED

val AdEvent.AdEventType.CONTENT_PAUSE_REQUESTED: AdEvent.AdEventType

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

CONTENT_RESUME_REQUESTED

val AdEvent.AdEventType.CONTENT_RESUME_REQUESTED: AdEvent.AdEventType

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

CUEPOINTS_CHANGED

val AdEvent.AdEventType.CUEPOINTS_CHANGED: AdEvent.AdEventType

Fired when VOD stream cuepoints have changed.

FIRST_QUARTILE

val AdEvent.AdEventType.FIRST_QUARTILE: AdEvent.AdEventType

Fired when the ad playhead crosses first quartile.

ICON_FALLBACK_IMAGE_CLOSED

val AdEvent.AdEventType.ICON_FALLBACK_IMAGE_CLOSED: AdEvent.AdEventType

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.

ICON_TAPPED

val AdEvent.AdEventType.ICON_TAPPED: AdEvent.AdEventType

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.

LOADED

val AdEvent.AdEventType.LOADED: AdEvent.AdEventType

Fired when the VAST response has been received.

LOG

val AdEvent.AdEventType.LOG: AdEvent.AdEventType

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.

MIDPOINT

val AdEvent.AdEventType.MIDPOINT: AdEvent.AdEventType

Fired when the ad playhead crosses midpoint.

PAUSED

val AdEvent.AdEventType.PAUSED: AdEvent.AdEventType

Fired when an ad is paused.

RESUMED

val AdEvent.AdEventType.RESUMED: AdEvent.AdEventType

Fired when an ad is resumed.

SKIPPABLE_STATE_CHANGED

val AdEvent.AdEventType.SKIPPABLE_STATE_CHANGED: AdEvent.AdEventType

Fired when an ad changes its skippable state.

SKIPPED

val AdEvent.AdEventType.SKIPPED: AdEvent.AdEventType

Fired when an ad was skipped.

STARTED

val AdEvent.AdEventType.STARTED: AdEvent.AdEventType

Fired when an ad starts playing.

TAPPED

val AdEvent.AdEventType.TAPPED: AdEvent.AdEventType

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

THIRD_QUARTILE

val AdEvent.AdEventType.THIRD_QUARTILE: AdEvent.AdEventType

Fired when the ad playhead crosses third quartile.

Public functions

valueOf

java-static fun valueOf(name: String!): AdEvent.AdEventType!

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Returns
`AdEvent.AdEventType!`	the enum constant with the specified name

Throws
`java.lang.IllegalArgumentException`	if this enum type has no constant with the specified name

values

java-static fun values(): Array<AdEvent.AdEventType!>!

Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants.

Returns
`Array<AdEvent.AdEventType!>!`	an array containing the constants of this enum type, in the order they're declared