Interface TextTrackCue
endTime: number;
id: string;
onenter: ((this: TextTrackCue, ev: Event) => any) | null;
onexit: ((this: TextTrackCue, ev: Event) => any) | null;
pauseOnExit: boolean;
startTime: number;
track: TextTrack | null;
addEventListener<K extends keyof TextTrackCueEventMap>(
type: K,
listener: (this: TextTrackCue, ev: TextTrackCueEventMap[K]) => any,
options?: boolean | AddEventListenerOptions,
): void;
addEventListener(
type: string,
listener: EventListenerOrEventListenerObject,
options?: boolean | AddEventListenerOptions,
): void;
dispatchEvent(event: Event): boolean;
removeEventListener<K extends keyof TextTrackCueEventMap>(
type: K,
listener: (this: TextTrackCue, ev: TextTrackCueEventMap[K]) => any,
options?: boolean | EventListenerOptions,
): void;
removeEventListener(
type: string,
listener: EventListenerOrEventListenerObject,
options?: boolean | EventListenerOptions,
): void;
}
Hierarchy
- EventTarget
- TextTrackCue
Index
Properties
Methods
Properties
endTime
The endTime property of the TextTrackCue interface returns and sets the end time of the cue.
id
The id property of the TextTrackCue interface returns and sets the identifier for this cue.
onenter
onexit
pauseOnExit
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.
startTime
The startTime property of the TextTrackCue interface returns and sets the start time of the cue.
Readonlytrack
The track read-only property of the TextTrackCue interface returns the TextTrack object that this cue belongs to.
Methods
addEventListener
- addEventListener<K extends keyof TextTrackCueEventMap>(
type: K,
listener: (this: TextTrackCue, ev: TextTrackCueEventMap[K]) => any,
options?: boolean | AddEventListenerOptions,
): voidThe
addEventListener()method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.Type Parameters
- K extends keyof TextTrackCueEventMap
Parameters
- type: K
- listener: (this: TextTrackCue, ev: TextTrackCueEventMap[K]) => any
Optionaloptions: boolean | AddEventListenerOptions
Returns void
- addEventListener(
type: string,
listener: EventListenerOrEventListenerObject,
options?: boolean | AddEventListenerOptions,
): voidThe
addEventListener()method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.Parameters
- type: string
- listener: EventListenerOrEventListenerObject
Optionaloptions: boolean | AddEventListenerOptions
Returns void
dispatchEvent
The
dispatchEvent()method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.Parameters
- event: Event
Returns boolean
removeEventListener
- removeEventListener<K extends keyof TextTrackCueEventMap>(
type: K,
listener: (this: TextTrackCue, ev: TextTrackCueEventMap[K]) => any,
options?: boolean | EventListenerOptions,
): voidThe
removeEventListener()method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.Type Parameters
- K extends keyof TextTrackCueEventMap
Parameters
- type: K
- listener: (this: TextTrackCue, ev: TextTrackCueEventMap[K]) => any
Optionaloptions: boolean | EventListenerOptions
Returns void
- removeEventListener(
type: string,
listener: EventListenerOrEventListenerObject,
options?: boolean | EventListenerOptions,
): voidThe
removeEventListener()method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.Parameters
- type: string
- listener: EventListenerOrEventListenerObject
Optionaloptions: boolean | EventListenerOptions
Returns void
The
TextTrackCueinterface 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.MDN Reference