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

TimedMetadataCue

data class TimedMetadataCue(val type: String, val startTime: Double, val endTime: Double? = null, val frames: Map<String, String> = emptyMap(), val description: String? = null, val mimeType: String? = null, val id: String? = null, val schemeIdUri: String? = null, val messageData: String? = null, val raw: ByteArray? = null, val phase: String? = null)

A single in-stream timed-metadata marker surfaced by a content player — the Kotlin mirror of the TS TimedMetadataCue. Carried as the payload of a TIMEDMETADATA event; in SSAI mode the SDK forwards it to the IMA DAI stream manager for ad tracking.

Constructors

TimedMetadataCue

constructor(type: String, startTime: Double, endTime: Double? = null, frames: Map<String, String> = emptyMap(), description: String? = null, mimeType: String? = null, id: String? = null, schemeIdUri: String? = null, messageData: String? = null, raw: ByteArray? = null, phase: String? = null)

Properties

description

val description: String?

ID3 frame description/info (e.g. the GEOB frame description — Anvatos for Anvato break-signaling cues), when the platform parser surfaces it.

endTime

val endTime: Double?

Optional end/active-until time, in seconds.

frames

val frames: Map<String, String>

Parsed ID3 text frames keyed by frame id (e.g. TXXX).

val id: String?

Marker identifier (EXT-X-DATERANGE ID / emsg id).

messageData

val messageData: String?

Free-form message payload: emsg message data, daterange client attribute, or the decoded (UTF-8) data of an ID3 GEOB frame.

mimeType

val mimeType: String?

ID3 GEOB MIME type (e.g. application/json), when surfaced.

phase

val phase: String?

WHEN this delivery happened, relative to the cue's own startTime: "parsed" when the carrying segment was demuxed (early — 20-30s on hls.js against the live NFL feed, which is what gives a break its preload window), "presented" when the playhead has just reached it (frame-accurate — p90 under 10ms, ADS-285).

raw

val raw: ByteArray?

Undecoded marker bytes, when the platform surfaces them — the TS raw. For DASH "ID3 in emsg" carriage this is the complete raw ID3v2 tag the emsg message data contains; the core unwraps its GEOB frame itself.

schemeIdUri

val schemeIdUri: String?

Scheme URI (EXT-X-DATERANGE scheme / emsg schemeIdUri).

startTime

val startTime: Double

Presentation time of the marker, in seconds.

type

val type: String

Marker source type: id3, daterange, or emsg.