TextTrackCueList

Baseline Widely available

This feature is well established and works across many devices and browser versions. It’s been available across browsers since July 2015.

The TextTrackCueList interface of the WebVTT API is an array-like object that represents a dynamically updating list of TextTrackCue objects.

An instance of this type is obtained from TextTrack.cues in order to get all the cues in the TextTrack object. This interface has no constructor.

Instance properties

TextTrackCueList.length Read only: An unsigned long that is the number of cues in the list.

Instance methods

TextTrackCueList.getCueById(): Returns the first TextTrackCue object with the identifier passed to it.

Examples

The HTMLMediaElement.textTracks property returns a TextTrackList object listing all of the TextTrack objects, one for each text track linked to the media. The TextTrack.cues property then returns a TextTrackCueList containing the cues for that particular track.

js

const video = document.getElementById("video");
video.onplay = () => {
  console.log(video.textTracks[0].cues);
};

Specifications

Specification
HTML Standard # texttrackcuelist

Browser compatibility

BCD tables only load in the browser