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

Hierarchy

EventTarget
- TextTrackCue

Index

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

MDN Reference

Type declaration

- (this, ev): any
- Parameters
  - this: TextTrackCue
  - ev: Event
  Returns any

onexit

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

MDN Reference

Type declaration

- (this, ev): any
- Parameters
  - this: TextTrackCue
  - ev: Event
  Returns any

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: null | 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
- K extends keyof TextTrackCueEventMap
Parameters
- type: K
- listener: ((this, ev) => any)
  - - (this, ev): any
    - Parameters
      this: TextTrackCue
      ev: TextTrackCueEventMap[K]
      Returns any
- Optional options: boolean | AddEventListenerOptions
Returns void
Overrides EventTarget.addEventListener
- Defined in node_modules/typescript/lib/lib.dom.d.ts:22196
addEventListener(type, listener, options?): void
Parameters
- type: string
- listener: EventListenerOrEventListenerObject
- Optional options: boolean | AddEventListenerOptions
Returns void
Overrides EventTarget.addEventListener
- Defined in node_modules/typescript/lib/lib.dom.d.ts:22197

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
- event: Event
Returns boolean
Inherited from EventTarget.dispatchEvent
- Defined in node_modules/typescript/lib/lib.dom.d.ts:8215

removeEventListener

removeEventListener<K>(type, listener, options?): void
Type Parameters
- K extends keyof TextTrackCueEventMap
Parameters
- type: K
- listener: ((this, ev) => any)
  - - (this, ev): any
    - Parameters
      this: TextTrackCue
      ev: TextTrackCueEventMap[K]
      Returns any
- Optional options: boolean | EventListenerOptions
Returns void
Overrides EventTarget.removeEventListener
- Defined in node_modules/typescript/lib/lib.dom.d.ts:22198
removeEventListener(type, listener, options?): void
Parameters
- type: string
- listener: EventListenerOrEventListenerObject
- Optional options: boolean | EventListenerOptions
Returns void
Overrides EventTarget.removeEventListener
- Defined in node_modules/typescript/lib/lib.dom.d.ts:22199

Interface TextTrackCue

Hierarchy

Index

Properties

Methods

Properties

endTime

id

onenter

Type declaration

Parameters

this: TextTrackCue

ev: Event

Returns any

onexit

Type declaration

Parameters

this: TextTrackCue

ev: Event

Returns any

pauseOnExit

startTime

Readonly track

Methods

addEventListener

Type Parameters

K extends keyof TextTrackCueEventMap

Parameters

type: K

listener: ((this, ev) => any)

Parameters

this: TextTrackCue

ev: TextTrackCueEventMap[K]

Returns any

Optional options: boolean | AddEventListenerOptions

Returns void

Parameters

type: string

listener: EventListenerOrEventListenerObject

Optional options: boolean | AddEventListenerOptions

Returns void

dispatchEvent

Parameters

event: Event

Returns boolean

removeEventListener

Type Parameters

K extends keyof TextTrackCueEventMap

Parameters

type: K

listener: ((this, ev) => any)

Parameters

this: TextTrackCue

ev: TextTrackCueEventMap[K]

Returns any

Optional options: boolean | EventListenerOptions

Returns void

Parameters

type: string

listener: EventListenerOrEventListenerObject

Optional options: boolean | EventListenerOptions

Returns void

Settings

Member Visibility

Theme

On This Page

`Readonly` track

`Optional` options: boolean | AddEventListenerOptions

`Optional` options: boolean | AddEventListenerOptions

`Optional` options: boolean | EventListenerOptions

`Optional` options: boolean | EventListenerOptions