ads-sdk-core/com.dolby.optiview.ads.core/PlayerAdapterEvent

PlayerAdapterEvent

enum PlayerAdapterEvent : Enum<PlayerAdapterEvent>

Event types a PlayerAdapter must forward (mirrors the TS PlayerAdapterEvent).

TIMEDMETADATA is optional/capability-style: content adapters used for SSAI playback emit it for each in-stream timed-metadata marker (HLS ID3 / EXT-X-DATERANGE) with a TimedMetadataCue payload, so the SDK can forward markers to IMA for ad tracking. Adapters that cannot surface metadata never emit it.

Entries

TIMEUPDATE

The playback position advanced; the SDK schedules breaks on it.

ENDED

Playback reached the end of the content.

ERROR

The player failed; the payload is the player's error.

SEEKED

A seek completed; the SDK enforces snapback on it.

VOLUMECHANGE

Volume or mute state changed.

WAITING

Playback stalled waiting for data.

PLAYING

Playback started or resumed.

PAUSE

Playback paused (drives pause ads).

TIMEDMETADATA

An in-stream timed-metadata marker; the payload is a TimedMetadataCue.

Properties

entries

val entries: EnumEntries<PlayerAdapterEvent>

Returns a representation of an immutable list of all enum entries, in the order they're declared.

value

val value: String

The event name, as used by the web PlayerAdapter.

Functions

valueOf

fun valueOf(value: String): PlayerAdapterEvent

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.)

values

fun values(): Array<PlayerAdapterEvent>

Returns an array containing the constants of this enum type, in the order they're declared.