THEOplayer Web SDK
    Preparing search index...

    Interface MillicastMetadataCue

    Represents a metadata cue of a Millicast source.

    In order to receive Millicast metadata, you must set metadata to true in MillicastSource.connectOptions.

    https://docs.dolby.io/streaming-apis/docs/frame-metadata

    interface MillicastMetadataCue {
        content: undefined;
        endTime: number;
        id: string;
        mid: string;
        startTime: number;
        timecode: undefined | Date;
        track: TextTrack;
        uid: number;
        unregistered: undefined | object | Uint8Array<ArrayBuffer>;
        uuid: undefined | string;
        addEventListener<TType extends keyof TextTrackCueEventMap>(
            type: TType | readonly TType[],
            listener: EventListener<TextTrackCueEventMap[TType]>,
        ): void;
        removeEventListener<TType extends keyof TextTrackCueEventMap>(
            type: TType | readonly TType[],
            listener: EventListener<TextTrackCueEventMap[TType]>,
        ): void;
    }

    Hierarchy (View Summary)

    Index

    Properties

    content endTime id mid startTime timecode track uid unregistered uuid

    Methods

    addEventListener removeEventListener

    Properties

    Readonlycontent

    content: undefined

    Unused.


    - Use timecode and/or unregistered to retrieve the contents of the Millicast metadata.

    endTime: number

    The playback position at which the cue becomes inactive, in seconds.

    id: string

    The identifier of the cue.

    mid: string

    The media identifier of the track that contains the metadata.

    startTime: number

    The playback position at which the cue becomes active, in seconds.

    timecode: undefined | Date

    Timecode of when the metadata was generated.

    track: TextTrack

    The text track of the cue.

    uid: number

    A unique identifier of the text track cue.


    - This identifier is unique across text track cues of a THEOplayer instance and can be used to distinguish between cues.
    - This identifier is a randomly generated number.

    unregistered: undefined | object | Uint8Array<ArrayBuffer>

    Unregistered data.


    - If the metadata content is valid JSON, then this is the parsed JSON object. Otherwise, it's the raw data as a Uint8Array.

    uuid: undefined | string

    The UUID of the metadata.

    Methods

    Settings

    Member Visibility

    On This Page

    Properties
    Methods