Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface TextTrackCue

Package version

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

Methods

Properties

EventTarget

EventTarget: { constructor: any; prototype: EventTarget }

Type declaration

  • constructor: function

    • Returns EventTarget

  • prototype: EventTarget

endTime

endTime: number

id

id: string

onenter

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

onexit

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

pauseOnExit

pauseOnExit: boolean

startTime

startTime: number

text

text: string

track

track: TextTrack

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

getCueAsHTML

  • Returns DocumentFragment

removeEventListener

Generated using TypeDoc