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.

interface TextTrackCue {
    endTime: number;
    id: string;
    onenter: null | ((this, ev) => any);
    onexit: null | ((this, ev) => any);
    pauseOnExit: boolean;
    startTime: number;
    track: null | 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

  • EventTarget
    • TextTrackCue

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.

id

id: string

Returns the text track cue identifier.

Can be set.

onenter

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

Type declaration

    • (this, ev): any

    • Parameters

      Returns any

onexit

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

Type declaration

    • (this, ev): any

    • Parameters

      Returns any

pauseOnExit

pauseOnExit: boolean

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

Can be set.

startTime

startTime: number

Returns the text track cue start time, in seconds.

Can be set.

Readonly track

track: null | TextTrack

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

Methods

addEventListener

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.

    Parameters

    • event: Event

    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

Generated using TypeDoc