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 {
    $destroyListeners?: any[];
    endTime: number;
    id: string;
    onenter: Object;
    onexit: Object;
    pauseOnExit: boolean;
    startTime: number;
    track: TextTrack;
    addEventListener<K>(type, listener, options?): void;
    addEventListener(type, listener, options?): void;
    dispatchEvent(event): boolean;
    removeEventListener<K>(type, listener, options?): void;
    removeEventListener(type, listener, options?): void;
}

Hierarchy

Properties

$destroyListeners? endTime id onenter onexit pauseOnExit startTime track

Methods

addEventListener dispatchEvent removeEventListener

Properties

Optional $destroyListeners

$destroyListeners?: any[]

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

MDN Reference

onexit

onexit: Object

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

Readonly track

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

  • Type Parameters

    Parameters

    Returns void

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

  • 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

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

  • Type Parameters

    Parameters

    Returns void

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

  • Parameters

    Returns void

Settings

Member Visibility

Theme

On This Page

$destroyListenersendTimeidonenteronexitpauseOnExitstartTimetrackaddEventListenerdispatchEventremoveEventListener