Interface CustomWebVTTTextTrack

Represents a text track of a media resource that can be filled with cues during playback.

interface CustomWebVTTTextTrack {
    accessibility: AccessibilityRole[];
    activeCues: null | TextTrackCueList;
    cues: null | TextTrackCueList;
    forced: boolean;
    id: string;
    inBandMetadataTrackDispatchType: string;
    kind: string;
    label: string;
    language: string;
    mode: string;
    readyState: TextTrackReadyState;
    src: string;
    type: "webvtt";
    uid: number;
    addCue(startTime: number, endTime: number, content: string): WebVTTCue;
    addEventListener<TType>(type: TType | readonly TType[], listener: EventListener<TextTrackEventMap[TType]>): void;
    removeCue(cue: WebVTTCue): void;
    removeEventListener<TType>(type: TType | readonly TType[], listener: EventListener<TextTrackEventMap[TType]>): void;
}

Hierarchy (view full)

Properties

accessibility activeCues cues forced id inBandMetadataTrackDispatchType kind label language mode readyState src type uid

Methods

addCue addEventListener removeCue removeEventListener

Properties

Readonlyaccessibility

accessibility: AccessibilityRole[]

The accessibility settings of the track.

Remarks


- For DASH: the accessibility descriptors for the corresponding AdaptationSet.
- For HLS: the CHARACTERISTICS for the corresponding #EXT-X-MEDIA tag.

ReadonlyactiveCues

activeCues: null | TextTrackCueList

The list of active cues of the track.

Remarks


- A cue is active if the current playback position falls within the time bounds of the cue.
- This list dynamically updates based on the current playback position.
- If the TextTrack.mode is 'disabled', this property is null.

Readonlycues

cues: null | TextTrackCueList

The list of cues of the track.

Remarks


- If the TextTrack.mode is 'disabled', this property is null.

Readonlyforced

forced: boolean

Indicates whether the track contains Forced Narrative cues. This may only be true for subtitle tracks where
- For DASH: the corresponding AdaptationSet contains a child Role with its value attribute equal to 'forced_subtitle'
- For HLS: the corresponding #EXT-X-MEDIA tag contains the attributes TYPE=SUBTITLES and FORCED=YES (not supported yet)

Readonlyid

id: string

The identifier of the text track.

Remarks


- This identifier can be used to distinguish between related tracks, e.g. tracks in the same list.
- For a text track embedded within an MPEG-DASH stream, this returns the Representation’d id attribute.
- For MPEG-DASH streams a Representation's ID is preferred over the AdaptationSet's ID.

ReadonlyinBandMetadataTrackDispatchType

inBandMetadataTrackDispatchType: string

The in-band metadata track dispatch type of the text track.

Readonlykind

kind: string

The kind of the text track, represented by a value from the following list:
- 'subtitles': The track contains subtitles.
- 'captions': The track contains closed captions, a translation of dialogue and sound effects.
- 'descriptions': The track contains descriptions, a textual description of the video.
- 'chapters': The track contains chapter titles.
- 'metadata': The track contains metadata. This track will not serve display purposes.

label

label: string

The label of the text track.

Readonlylanguage

language: string

The language of the text track.

mode

mode: string

The mode of the text track, represented by a value from the following list:
- 'disabled': The track is disabled.
- 'hidden': The track is hidden.
- 'showing': The track is showing.

Remarks


- A disabled track is not displayed and exposes no active cues, nor fires cue events.
- A hidden track is not displayed but exposes active cues and fires cue events.
- A showing track is displayed, exposes active cues and fires cue events.

ReadonlyreadyState

readyState: TextTrackReadyState

The ready state of the text track.

Readonlysrc

src: string

The source of the text track.

Readonlytype

type

The kind of the text track.

Readonlyuid

uid: number

A unique identifier of the text track.

Remarks


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

Methods

addCue

  • addCue(startTime, endTime, content): WebVTTCue

  • Adds a cue to the text track.

    Parameters

    • startTime: number

      The start time of the cue.

    • endTime: number

      The end time of the cue.

    • content: string

      The content of the cue.

    Returns WebVTTCue

addEventListener

removeCue

  • removeCue(cue): void

  • Removed a cue from the text track.

    Parameters

    Returns void

removeEventListener

Settings

Member Visibility

On This Page

Properties
Methods