TextTrack

The TextTrack interface—part of the API for handling WebVTT (text tracks on media presentations)—describes and controls the text track associated with a particular <track> element.

Properties

This interface also inherits properties from EventTarget.

TextTrack.activeCues Read only
A TextTrackCueList object listing the currently active set of text track cues. Track cues are active if the current playback position of the media is between the cues' start and end times.
TextTrack.cues Read only
A TextTrackCueList which contains all of the track's cues.
TextTrack.id Read only
A DOMString which identifies the track, if it has one. If it doesn't have an ID, then this value is an empty string (""). If the TextTrack is associated with a <track> element, then the track's ID matches the element's ID.
TextTrack.inBandMetadataTrackDispatchType Read only
Returns a DOMString which indicates the track's in-band metadata track dispatch type. needs details
TextTrack.kind Read only
Returns a DOMString indicating what kind of text track the TextTrack describes. The value must be one of those in the TextTrackKind enum.
TextTrack.label Read only
A human-readable DOMString which contains the text track's label, if one is present; otherwise, this is an empty string (""), in which case a custom label may need to be generated by your code using other attributes of the track, if the track's label needs to be exposed to the user.
TextTrack.language Read only
A DOMString which specifies the text language in which the text track's contents is written. The value must adhere to the format specified in the Tags for Identifying Languages (BCP 47) document from the IETF, just like the HTML lang attribute. For example, this can be "en-US" for United States English or "pt-BR" for Brazilian Portuguese.
TextTrack.mode
A DOMString specifying the track's current mode. Changing this property's value changes the track's current mode to match. Permitted values are listed under Text track mode constants.

Event handlers

TextTrack.oncuechange
A EventHandler specifying a function to be called when a cuechange event occurs. Handling these events lets you know when cues are entered and exited. A given text cue appears when the cue is entered and disappears when the cue is exited.

Methods

This interface also inherits methods from EventTarget.

TextTrack.addCue()
Adds a cue (specified as a TextTrackCue object to the track's list of cues.
TextTrack.removeCue()
Removes a cue (specified as a TextTrackCue object from the track's list of cues.

Example

tbd

Specifications

Specification Status Comment
WebVTT: The Web Video Text Tracks Format Working Draft  

Browser compatibility

FeatureChromeEdgeFirefoxInternet ExplorerOperaSafari
Basic support181231110156
activeCues18123110156
cues18123110156
id18123110156
inBandMetadataTrackDispatchType18123110156
kind18123110156
label18123110156
language18123110156
mode181231210156
oncuechange Yes1231 ? ? ?
addCue18123110156
removeCue18123110156
sourceBuffer ? ? ? ? ? ?
FeatureAndroid webviewChrome for AndroidEdge mobileFirefox for AndroidOpera AndroidiOS SafariSamsung Internet
Basic support3018 No31 No7.1 Yes
activeCues3018 No31 No7.1 Yes
cues3018 No31 No7.1 Yes
id3018 No31 No7.1 Yes
inBandMetadataTrackDispatchType3018 No31 No7.1 Yes
kind3018 No31 No7.1 Yes
label3018 No31 No7.1 Yes
language3018 No31 No7.1 Yes
mode3018 No31 No7.1 Yes
oncuechange Yes Yes No31 No ? Yes
addCue3018 No31 No7.1 Yes
removeCue3018 No31 No7.1 Yes
sourceBuffer ? ? ? ? ? ? ?

1. Firefox versions before Firefox 50 didn't display captions when playing media without one or more video tracks being played.

2. Before Firefox 52, using JavaScript to change the mode of a text track that's part of a media element would send one change event to the element's textTracks TextTrackList for each change, even if mutliple changes are made in a single pass through the Firefox event loop. Starting in Firefox 52, these changes are reflected by a single event.

See also

Document Tags and Contributors

Contributors to this page: fscholz, tricki, Sheppy
Last updated by: fscholz,