Join us online - 19th of November
Save your spot

Interface 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

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
endTime id onenter onexit pauseOnExit startTime track
addEventListener dispatchEvent removeEventListener
endTime: number

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

MDN Reference

id: string

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

MDN Reference

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

MDN Reference

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

MDN Reference

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: number

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

MDN Reference

track: TextTrack | null

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

MDN Reference

  • 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

    Parameters

    Returns 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

    Returns void

  • 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

    • event: Event

    Returns boolean

  • 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

    Parameters

    Returns 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

    Returns void

Was this helpful?