TextTrack

This translation is incomplete. Please help translate this article from English

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. Thus, for displayed cues such as captions or subtitles, the active cues are currently being displayed.
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. The default is disabled, unless the <track> element's default Boolean attribute is specified, in which case the default mode is started.

Events

cuechange
Fired when cues are entered and exited. A given text cue appears when the cue is entered and disappears when the cue is exited.
Also available via the oncuechange property.

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
HTML Living Standard
La definición de 'TextTrack' en esta especificación.
Living Standard

Browser compatibility

Update compatibility data on GitHub
DesktopMobile
ChromeEdgeFirefoxInternet ExplorerOperaSafariAndroid webviewChrome para AndroidFirefox para AndroidOpera para AndroidSafari en iOSSamsung Internet
TextTrackChrome Soporte completo 18Edge Soporte completo 12Firefox Soporte completo 31
Notas
Soporte completo 31
Notas
Notas Firefox versions before Firefox 50 didn't display captions when playing media without one or more video tracks being played.
IE Soporte completo 10Opera Soporte completo 15Safari Soporte completo 6WebView Android Soporte completo 4.4Chrome Android Soporte completo 18Firefox Android Soporte completo 31Opera Android Sin soporte NoSafari iOS Soporte completo 7Samsung Internet Android Soporte completo 1.0
activeCuesChrome Soporte completo 18Edge Soporte completo 12Firefox Soporte completo 31
Notas
Soporte completo 31
Notas
Notas Starting in Firefox 69, cues are no longer incorrectly loaded when the TextTrack's mode is disabled; if that's the case, the returned list is empty.
IE Soporte completo 10Opera Soporte completo 15Safari Soporte completo 6WebView Android Soporte completo 4.4Chrome Android Soporte completo 18Firefox Android Soporte completo 31Opera Android Sin soporte NoSafari iOS Soporte completo 7Samsung Internet Android Soporte completo 1.0
addCueChrome Soporte completo 18Edge Soporte completo 12Firefox Soporte completo 31IE Soporte completo 10Opera Soporte completo 15Safari Soporte completo 6WebView Android Soporte completo 4.4Chrome Android Soporte completo 18Firefox Android Soporte completo 31Opera Android Sin soporte NoSafari iOS Soporte completo 7Samsung Internet Android Soporte completo 1.0
cuechange eventChrome Soporte completo SiEdge Soporte completo 12Firefox Soporte completo 31IE ? Opera ? Safari Soporte completo SiWebView Android Soporte completo SiChrome Android Soporte completo SiFirefox Android Soporte completo 31Opera Android Sin soporte NoSafari iOS ? Samsung Internet Android Soporte completo Si
cuesChrome Soporte completo 18Edge Soporte completo 12Firefox Soporte completo 31
Notas
Soporte completo 31
Notas
Notas Starting in Firefox 69, cues are no longer incorrectly loaded when the TextTrack's mode is disabled; if that's the case, the returned list is empty.
IE Soporte completo 10Opera Soporte completo 15Safari Soporte completo 6WebView Android Soporte completo 4.4Chrome Android Soporte completo 18Firefox Android Soporte completo 31Opera Android Sin soporte NoSafari iOS Soporte completo 7Samsung Internet Android Soporte completo 1.0
idChrome Soporte completo 18Edge Soporte completo 12Firefox Soporte completo 31IE Soporte completo 10Opera Soporte completo 15Safari Soporte completo 6WebView Android Soporte completo 4.4Chrome Android Soporte completo 18Firefox Android Soporte completo 31Opera Android Sin soporte NoSafari iOS Soporte completo 7Samsung Internet Android Soporte completo 1.0
inBandMetadataTrackDispatchTypeChrome Soporte completo 18Edge Soporte completo 12Firefox Soporte completo 31IE Soporte completo 10Opera Soporte completo 15Safari Soporte completo 6WebView Android Soporte completo 4.4Chrome Android Soporte completo 18Firefox Android Soporte completo 31Opera Android Sin soporte NoSafari iOS Soporte completo 7Samsung Internet Android Soporte completo 1.0
kindChrome Soporte completo 18Edge Soporte completo 12Firefox Soporte completo 31IE Soporte completo 10Opera Soporte completo 15Safari Soporte completo 6WebView Android Soporte completo 4.4Chrome Android Soporte completo 18Firefox Android Soporte completo 31Opera Android Sin soporte NoSafari iOS Soporte completo 7Samsung Internet Android Soporte completo 1.0
labelChrome Soporte completo 18Edge Soporte completo 12Firefox Soporte completo 31IE Soporte completo 10Opera Soporte completo 15Safari Soporte completo 6WebView Android Soporte completo 4.4Chrome Android Soporte completo 18Firefox Android Soporte completo 31Opera Android Sin soporte NoSafari iOS Soporte completo 7Samsung Internet Android Soporte completo 1.0
languageChrome Soporte completo 18Edge Soporte completo 12Firefox Soporte completo 31IE Soporte completo 10Opera Soporte completo 15Safari Soporte completo 6WebView Android Soporte completo 4.4Chrome Android Soporte completo 18Firefox Android Soporte completo 31Opera Android Sin soporte NoSafari iOS Soporte completo 7Samsung Internet Android Soporte completo 1.0
modeChrome Soporte completo 18Edge Soporte completo 12Firefox Soporte completo 31
Notas
Soporte completo 31
Notas
Notas 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.
IE Soporte completo 10Opera Soporte completo 15Safari Soporte completo 6WebView Android Soporte completo 4.4Chrome Android Soporte completo 18Firefox Android Soporte completo 31Opera Android Sin soporte NoSafari iOS Soporte completo 7Samsung Internet Android Soporte completo 1.0
oncuechangeChrome Soporte completo SiEdge Soporte completo 12Firefox Soporte completo 31IE ? Opera Soporte completo SiSafari Soporte completo SiWebView Android Soporte completo SiChrome Android Soporte completo SiFirefox Android Soporte completo 31Opera Android Sin soporte NoSafari iOS ? Samsung Internet Android Soporte completo Si
removeCueChrome Soporte completo 18Edge Soporte completo 12Firefox Soporte completo 31IE Soporte completo 10Opera Soporte completo 15Safari Soporte completo 6WebView Android Soporte completo 4.4Chrome Android Soporte completo 18Firefox Android Soporte completo 31Opera Android Sin soporte NoSafari iOS Soporte completo 7Samsung Internet Android Soporte completo 1.0
sourceBufferChrome Sin soporte NoEdge Sin soporte NoFirefox ? IE Sin soporte NoOpera ? Safari Soporte completo SiWebView Android Sin soporte NoChrome Android Sin soporte NoFirefox Android ? Opera Android Sin soporte NoSafari iOS ? Samsung Internet Android Sin soporte No

Leyenda

Soporte completo  
Soporte completo
Sin soporte  
Sin soporte
Compatibilidad desconocida  
Compatibilidad desconocida
Ver notas de implementación.
Ver notas de implementación.

See also