Interface TextMetadataCue

Contains text timed metadata from the stream.

interface TextMetadataCue {
    description: string;
    endTime: number;
    owner: string;
    startTime: number;
    text: string;
    type: "TextMetadataCue";
}

Hierarchy (view full)

  • Cue
    • TextMetadataCue

Properties

description endTime owner startTime text type

Properties

description

description: string

The description for the cue.

endTime

endTime: number

The time when the cue should be cleared.

owner

owner: string

The source of the cue, either RTMP inband or HTTP out of band.

startTime

startTime: number

The time when the cue should be displayed.

text

text: string

The text information for the cue.

type

type: "TextMetadataCue"

Settings

Member Visibility

Theme

On This Page

descriptionendTimeownerstartTimetexttype