Interface TextTrackCue

    TextTrackCues represent a string of text that will be displayed for some duration of time on a TextTrack. This includes the start and end times that the cue will be displayed. A TextTrackCue cannot be used directly, instead one of the derived types (e.g. VTTCue) must be used.

    MDN Reference

    interface TextTrackCue {
        endTime: number;
        id: string;
        onenter: ((this: TextTrackCue, ev: Event) => any);
        onexit: ((this: TextTrackCue, ev: Event) => any);
        pauseOnExit: boolean;
        startTime: number;
        track: TextTrack;
        addEventListener<K>(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>(type: K, listener: ((this: TextTrackCue, ev: TextTrackCueEventMap[K]) => any), options?: boolean | EventListenerOptions): void;
        removeEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void;
    }
    Hierarchy

    Properties

    endTime id onenter onexit pauseOnExit startTime track

    Methods

    addEventListener dispatchEvent removeEventListener

    Properties

    endTime

    endTime: number

    Returns the text track cue end time, in seconds.

    Can be set.

    MDN Reference

    id

    id: string

    Returns the text track cue identifier.

    Can be set.

    MDN Reference

    onenter

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

    MDN Reference

    onexit

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

    MDN Reference

    pauseOnExit

    pauseOnExit: boolean

    Returns true if the text track cue pause-on-exit flag is set, false otherwise.

    Can be set.

    MDN Reference

    startTime

    startTime: number

    Returns the text track cue start time, in seconds.

    Can be set.

    MDN Reference

    Readonlytrack

    track: TextTrack

    Returns the TextTrack object to which this text track cue belongs, if any, or null otherwise.

    MDN Reference

    Methods

    addEventListener

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

    • Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.

      The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.

      When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.

      When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.

      When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.

      If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.

      The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.

      MDN Reference

      Type Parameters

      Parameters

      Returns void

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

    • Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.

      The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.

      When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.

      When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.

      When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.

      If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.

      The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.

      MDN Reference

      Parameters

      Returns void

    dispatchEvent

    • dispatchEvent(event): boolean

    • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

      MDN Reference

      Parameters

      Returns boolean

    removeEventListener

    Settings

    Member Visibility

    On This Page

    Properties
    Methods