Options
All
  • Public
  • Public/Protected
  • All
Menu

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.

Hierarchy

Index

Properties

EventTarget

EventTarget: { constructor: any; prototype: EventTarget }

Type declaration

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: ((this: TextTrackCue, ev: Event) => any) | null

onexit

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

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: TextTrack | null

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

Methods

addEventListener

dispatchEvent

  • dispatchEvent(event: 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

    Returns boolean

removeEventListener

Generated using TypeDoc