TextTrackCue

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 TextTrackCue interface of the WebVTT API is the abstract base class for the various derived cue types, such as VTTCue; you will work with these derived types rather than the base class.

These cues represent strings of text presented for some duration of time during the performance of a TextTrack. The cue includes the start time (the time at which the text will be displayed) and the end time (the time at which it will be removed from the display), as well as other information.

Instance properties

This interface also inherits properties from EventTarget.

TextTrackCue.track Read only: The TextTrack that this cue belongs to, or null if it doesn't belong to any.
TextTrackCue.id: A string that identifies the cue.
TextTrackCue.startTime: A double that represents the video time that the cue will start being displayed, in seconds.
TextTrackCue.endTime: A double that represents the video time that the cue will stop being displayed, in seconds.
TextTrackCue.pauseOnExit: A boolean for whether the video will pause when this cue stops being displayed.

Events

enter: Fired when a cue becomes active.
exit: Fired when the cue has stopped being active.

Specifications

Specification
HTML Standard # texttrackcue

Browser compatibility

BCD tables only load in the browser