TextTrackCue

The TextTrackCue interface of the WebVTT API is the abstract base class for the various derived cue types, such as VTTCue and DataCue; you will work with these derived types rather than the base class.

MDN Reference

Extends

• EventTarget

Methods

addEventListener()

Call Signature

addEventListener<K>(
   type, 
   listener, 
   options?
): void;

The addEventListener() method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.

MDN Reference

Type Parameters

Type Parameter
K extends keyof TextTrackCueEventMap

Parameters

Parameter	Type
type	K
listener	(this, ev) => any
options?	boolean | AddEventListenerOptions

Returns

void

Overrides

EventTarget.addEventListener

Call Signature

addEventListener(
   type, 
   listener, 
   options?
): void;

The addEventListener() method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.

MDN Reference

Parameters

Parameter	Type
type	string
listener	EventListenerOrEventListenerObject
options?	boolean | AddEventListenerOptions

Returns

void

Overrides

EventTarget.addEventListener

---

dispatchEvent()

dispatchEvent(event): boolean;

The dispatchEvent() method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order. The normal event processing rules (including the capturing and optional bubbling phase) also apply to events dispatched manually with dispatchEvent().

MDN Reference

Parameters

Parameter	Type
event	Event

Returns

boolean

Inherited from

EventTarget.dispatchEvent

---

removeEventListener()

Call Signature

removeEventListener<K>(
   type, 
   listener, 
   options?
): void;

The removeEventListener() method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target. The event listener to be removed is identified using a combination of the event type, the event listener function itself, and various optional options that may affect the matching process; see Matching event listeners for removal.

MDN Reference

Type Parameters

Type Parameter
K extends keyof TextTrackCueEventMap

Parameters

Parameter	Type
type	K
listener	(this, ev) => any
options?	boolean | EventListenerOptions

Returns

void

Overrides

EventTarget.removeEventListener

Call Signature

removeEventListener(
   type, 
   listener, 
   options?
): void;

The removeEventListener() method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target. The event listener to be removed is identified using a combination of the event type, the event listener function itself, and various optional options that may affect the matching process; see Matching event listeners for removal.

MDN Reference

Parameters

Parameter	Type
type	string
listener	EventListenerOrEventListenerObject
options?	boolean | EventListenerOptions

Returns

void

Overrides

EventTarget.removeEventListener

Properties

endTime

endTime: number;

The endTime property of the TextTrackCue interface returns and sets the end time of the cue.

MDN Reference

---

id

id: string;

The id property of the TextTrackCue interface returns and sets the identifier for this cue.

MDN Reference

---

onenter

onenter: ((this, ev) => any) | null;

MDN Reference

---

onexit

onexit: ((this, ev) => any) | null;

MDN Reference

---

pauseOnExit

pauseOnExit: boolean;

The pauseOnExit property of the TextTrackCue interface returns or sets the flag indicating whether playback of the media should pause when the end of the range to which this cue applies is reached.

MDN Reference

---

startTime

startTime: number;

The startTime property of the TextTrackCue interface returns and sets the start time of the cue.

MDN Reference

---

track

readonly track: TextTrack | null;

The track read-only property of the TextTrackCue interface returns the TextTrack object that this cue belongs to.

MDN Reference