TextTrack.removeCue()
The removeCue()
method of the TextTrack
interface removes a cue from the list of cues.
Syntax
TextTrack.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
No specification found
No specification data found for api.TextTrack.removeCue
.
Check for problems with this page or contribute a missing spec_url
to mdn/browser-compat-data. Also make sure the specification is included in w3c/browser-specs.
Browser compatibility
BCD tables only load in the browser