interface SccSubtitle {
    cues?: VTTCue[];
    enabled?: boolean;
    id: string;
    kind?: "metadata" | "captions" | "chapters" | "descriptions" | "subtitles";
    label?: string;
    language?: string;
    src?: string | SubtitleSource;
    startTime?: TimeCode;
}

Properties

cues?: VTTCue[]

The cues for this subtitle, this property is populated by the SccSubtitlePlugin if the "src" property is provided.

enabled?: boolean

Determines if this subtitle should be enabled or not.

id: string

The id (unique identifier) of the subtitle, this is used when altering the subtitle through the SccSubtitlePlugin API.

kind?: "metadata" | "captions" | "chapters" | "descriptions" | "subtitles"

How the text track is meant to be used. If omitted the default kind is "captions"

label?: string

User readable title of the track.

language?: string

Language of the track text data. It must be a valid BCP 47 language tag.

src?: string | SubtitleSource

The url to the SCC file to load cues from.

startTime?: TimeCode

Start time of the cues. Defaults to the start time set for the currently active video file (frameOffset and frameRate set on the loaded VideoFile object).