title | short-title | slug | page-type | browser-compat |
---|---|---|---|---|
TextTrack: addCue() method |
addCue() |
Web/API/TextTrack/addCue |
web-api-instance-method |
api.TextTrack.addCue |
{{APIRef("WebVTT")}}
The addCue()
method of the {{domxref("TextTrack")}} interface adds a new cue to the list of cues.
addCue(cue)
cue
- : A {{domxref("TextTrackCue")}}.
Note: The {{domxref("TextTrackCue")}} interface is an abstract class used as the parent for other cue interfaces such as {{domxref("VTTCue")}}. Therefore, when adding a cue you will be using one of the cue types that inherit from
TextTrackCue
.
Undefined.
InvalidStateError
{{domxref("DOMException")}}- : Thrown if the rules for this {{domxref("TextTrackList")}} do not match those that are appropriate for the incoming {{domxref("TextTrackCue")}}.
In the following example two cues are added to a video text track using addCue()
.
let video = document.querySelector("video");
let track = video.addTextTrack("captions", "Captions", "en");
track.mode = "showing";
track.addCue(new VTTCue(0, 0.9, "Hildy!"));
track.addCue(new VTTCue(1, 1.4, "How are you?"));
{{Specifications}}
{{Compat}}