W3cubDocs

/Web APIs

TextTrackList

The TextTrackList interface is used to represent a list of the text tracks defined by the <track> element, with each track represented by a separate textTrack object in the list.

Retrieve an instance of this object with the textTracks property of an HTMLMediaElement object.

For a given HTMLMediaElement object media, the individual tracks can be accessed using:

  • media.TextTracks[n], to get the n-th text track from the object's list of text tracks
  • the media.textTracks.getTrackById() method
EventTarget TextTrackList

Instance properties

This interface also inherits properties from its parent interface, EventTarget.

length Read only

The number of tracks in the list.

Instance methods

This interface also inherits methods from its parent interface, EventTarget.

getTrackById()

Returns the TextTrack found within the TextTrackList whose id matches the specified string. If no match is found, null is returned.

Events

addtrack

Fired when a new text track has been added to the media element. Also available via the onaddtrack property.

change

Fired when a text track has been made active or inactive. Also available via the onchange property.

removetrack

Fired when a new text track has been removed from the media element. Also available via the onremovetrack property.

Usage notes

In addition to being able to obtain direct access to the text tracks present on a media element, TextTrackList lets you set event handlers on the addtrack and removetrack events, so that you can detect when tracks are added to or removed from the media element's stream.

Examples

Getting a video element's text track list

To get a media element's TextTrackList, use its textTracks property.

js

const textTracks = document.querySelector("video").textTracks;

Monitoring track count changes

In this example, we have an app that displays information about the number of channels available. To keep it up to date, handlers for the addtrack and removetrack events are set up.

js

textTracks.onaddtrack = updateTrackCount;
textTracks.onremovetrack = updateTrackCount;

function updateTrackCount(event) {
  trackCount = textTracks.length;
  drawTrackCountIndicator(trackCount);
}

Specifications

Browser compatibility

Desktop Mobile
Chrome Edge Firefox Internet Explorer Opera Safari WebView Android Chrome Android Firefox for Android Opera Android Safari on IOS Samsung Internet
TextTrackList 23 12 31 10 ≤12.1 6 4.4 25 31 ≤12.1 7 1.5
addtrack_event 23 12 31 11 ≤12.1 6 4.4 25 31 ≤12.1 7 1.5
change_event 33 18 31 No 20 7 4.4 33 31 20 7 2.0
getTrackById 33 18 31 No 20 8 4.4.3 33 31 20 8 2.0
length 23 12 31 10 ≤12.1 6 4.4 25 31 ≤12.1 7 1.5
removetrack_event 33 18 31 No 20≤12.1–15 7 4.4 33 31 20≤12.1–14 7 2.0

© 2005–2023 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/TextTrackList