OptiView Ads SDK
    Preparing search index...

    Interface TimedMetadataCue

    One in-stream timed-metadata marker (payload of timedmetadata). Minimal, player-agnostic:

    • id3: HLS ID3 — parsed text frames and/or undecoded raw bytes.
    • daterange: HLS EXT-X-DATERANGE — id / schemeIdUri / messageData.
    • emsg: DASH/CMAF event message — schemeIdUri / messageData.
    interface TimedMetadataCue {
        description?: string;
        endTime?: number;
        frames?: Record<string, string>;
        id?: string;
        messageData?: string;
        mimeType?: string;
        phase?: "parsed" | "presented";
        raw?: Uint8Array<ArrayBufferLike>;
        schemeIdUri?: string;
        startTime: number;
        type: "id3" | "daterange" | "emsg";
    }
    Index
    description? endTime? frames? id? messageData? mimeType? phase? raw? schemeIdUri? startTime type
    description?: string

    ID3 frame description (e.g. GEOB Anvatos for Anvato break-signaling cues), when surfaced.

    endTime?: number

    Optional end/active-until time, in seconds.

    frames?: Record<string, string>

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

    id?: string

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

    messageData?: string

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

    mimeType?: string

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

    phase?: "parsed" | "presented"

    When the cue was delivered relative to startTime. parsed means the segment was parsed before playback reached the cue; presented means the playhead reached it. Omit this property when the adapter cannot distinguish the two. Marking an early parsed cue as presented can cause an ad break to start before its scheduled time.

    raw?: Uint8Array<ArrayBufferLike>

    Undecoded marker bytes (ID3/emsg), when available.

    schemeIdUri?: string

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

    startTime: number

    Presentation time of the marker, in seconds.

    type: "id3" | "daterange" | "emsg"

    Marker source type.

    Settings
    Member Visibility

    On This Page
    Properties