Interface EmsgCue

Represents a cue of an emsg metadata text track.

interface EmsgCue {
    content: any;
    emsgID: number;
    endTime: number;
    id: string;
    schemeIDURI: string;
    startTime: number;
    track: TextTrack;
    uid: number;
    value: string;
    addEventListener<TType>(type, listener): void;
    removeEventListener<TType>(type, listener): void;

Hierarchy (view full)


content: any

The content of the cue.


The content differs depending on the TextTrackCue.track's type:
- 'emsg': Content is a Uint8Array representing the binary message data from the emsg box.
- 'eventstream': Content is the value of the messageData attribute which was specified in the manifest.
- 'ttml': Content is an intermediate TTML document’s body element. This is a view of a TTML document where all nodes in the document are active during the cue’s startTime and endTime. As a result, all begin, dur and end properties have been removed. TTML Styles, Regions and Metadata are stored in cue.styles, cue.regions, cue.metadata respectively. Combining those properties with the given content should suffice to render a TTML cue.
- 'webvtt': Content is the cue text in raw unparsed form.

emsgID: number

The emsg identifier of the cue.


- The identifier is unique within the scope of the period.

endTime: number

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

id: string

The identifier of the cue.

schemeIDURI: string

The schemeIDURI of the cue.

startTime: number

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

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.

value: string

The SCTE 35 PID (Program Identifier) of the cue.