TextTrack: removeCue() method

The removeCue() method of the TextTrack interface removes a cue from the list of cues.

Syntax

removeCue(cue)

Parameters

• cue
  • : A TextTrackCue.

Return value

Undefined.

Exceptions

• NotFoundError DOMException
  • : Thrown if the given cue is not found in the list of cues.

[!NOTE] The TextTrackCue interface is an abstract class used as the parent for other cue interfaces such as VTTCue. Therefore, when removing a cue you will be passing in one of the cue types that inherit from TextTrackCue.

Examples

In the following example a cue is added to a video text track using addCue(), then removed using removeCue.

let video = document.querySelector("video");
let track = video.addTextTrack("captions", "Captions", "en");
track.mode = "showing";
let cue = new VTTCue(0, 0.9, "Hildy!");
track.addCue(cue);
track.removeCue(cue);

Specifications

Browser compatibility