Version: 2.67.0

TextTrack

THEOplayer > TextTrack

TextTrack interface

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

Represents a text track of a media resource.

Signature:
export interface TextTrack extends Track

Properties

Property

Type

Description

activeCues

TextTrackCueList

The list of active cues of the track.

cues

TextTrackCueList

The list of cues of the track.

id

string

The identifier of the text track.

inBandMetadataTrackDispatchType

string

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

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

string

The label of the text track.

language

string

The language of the text track.

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.

readyState

TextTrackReadyState

The ready state of the text track.

src

string

The source of the text track.

type

TextTrackType

The content type of the text track.

uid

number

A unique identifier of the text track.