TextTrackCue

{{APIRef("WebVTT")}}

The TextTrackCue interface of the WebVTT API is the abstract base class for the various derived cue types, such as {{domxref("VTTCue")}} and {{domxref("DataCue")}}; 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 {{domxref("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.

{{InheritanceDiagram}}

Instance properties

This interface also inherits properties from {{domxref("EventTarget")}}.

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

Events

• {{domxref("TextTrackCue.enter_event", "enter")}}
  • : Fired when a cue becomes active.
• {{domxref("TextTrackCue.exit_event", "exit")}}
  • : Fired when the cue has stopped being active.

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}