THEOplayer > TTMLCue

TTMLCue interface

Inherits from TextTrackCue. See parent page for inherited properties and methods.

Represents a cue of a TTML text track.

Signature:

export interface TTMLCue extends TextTrackCue 

Properties

Property Details

content

The content of the cue.

Signature:

content: any;

Remarks

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

metadata

The <metadata> Element of the corresponding TTML document.

Signature:

metadata: any;

regions

A record of style for the cue. Each entry contains all style properties for a region id.

Signature:

regions: Record<string, StylePropertyRecord>;

styles

A record of styles for the cue. Each entry contains all style properties for a style id.

Signature:

styles: Record<string, StylePropertyRecord>;