Interface TextTrack

This interface also inherits properties from EventTarget.

MDN Reference

Hierarchy

EventTarget
- TextTrack

Index

Properties

activeCues cues id inBandMetadataTrackDispatchType kind label language mode oncuechange

Methods

addCue addEventListener dispatchEvent removeCue removeEventListener

Properties

`Readonly` activeCues

activeCues: null | TextTrackCueList

Returns the text track cues from the text track list of cues that are currently active (i.e. that start before the current playback position and end after it), as a TextTrackCueList object.

MDN Reference

`Readonly` cues

cues: null | TextTrackCueList

Returns the text track list of cues, as a TextTrackCueList object.

MDN Reference

`Readonly` id

id: string

Returns the ID of the given track.

For in-band tracks, this is the ID that can be used with a fragment if the format supports media fragment syntax, and that can be used with the getTrackById() method.

For TextTrack objects corresponding to track elements, this is the ID of the track element.

MDN Reference

`Readonly` inBandMetadataTrackDispatchType

inBandMetadataTrackDispatchType: string

Returns the text track in-band metadata track dispatch type string.

MDN Reference

`Readonly` kind

kind: TextTrackKind

Returns the text track kind string.

MDN Reference

`Readonly` label

label: string

Returns the text track label, if there is one, or the empty string otherwise (indicating that a custom label probably needs to be generated from the other attributes of the object if the object is exposed to the user).

MDN Reference

`Readonly` language

language: string

Returns the text track language string.

MDN Reference

mode

mode: TextTrackMode

Returns the text track mode, represented by a string from the following list:

Can be set, to change the mode.

MDN Reference

oncuechange

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

MDN Reference

Type declaration

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

Methods

addCue

addCue(cue): void
Adds the given cue to textTrack's text track list of cues.

MDN Reference
Parameters
- cue: TextTrackCue
Returns void
- Defined in node_modules/typescript/lib/lib.dom.d.ts:22125

addEventListener

addEventListener<K>(type, listener, options?): void
Type Parameters
- K extends "cuechange"
Parameters
- type: K
- listener: ((this, ev) => any)
  - - (this, ev): any
    - Parameters
      this: TextTrack
      ev: TextTrackEventMap[K]
      Returns any
- Optional options: boolean | AddEventListenerOptions
Returns void
Overrides EventTarget.addEventListener
- Defined in node_modules/typescript/lib/lib.dom.d.ts:22132
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:22133

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

removeCue

removeCue(cue): void
Removes the given cue from textTrack's text track list of cues.

MDN Reference
Parameters
- cue: TextTrackCue
Returns void
- Defined in node_modules/typescript/lib/lib.dom.d.ts:22131

removeEventListener

removeEventListener<K>(type, listener, options?): void
Type Parameters
- K extends "cuechange"
Parameters
- type: K
- listener: ((this, ev) => any)
  - - (this, ev): any
    - Parameters
      this: TextTrack
      ev: TextTrackEventMap[K]
      Returns any
- Optional options: boolean | EventListenerOptions
Returns void
Overrides EventTarget.removeEventListener
- Defined in node_modules/typescript/lib/lib.dom.d.ts:22134
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:22135

Interface TextTrack

Hierarchy

Index

Properties

Methods

Properties

Readonly activeCues

Readonly cues

Readonly id

Readonly inBandMetadataTrackDispatchType

Readonly kind

Readonly label

Readonly language

mode

oncuechange

Type declaration

Parameters

this: TextTrack

ev: Event

Returns any

Methods

addCue

Parameters

cue: TextTrackCue

Returns void

addEventListener

Type Parameters

K extends "cuechange"

Parameters

type: K

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

Parameters

this: TextTrack

ev: TextTrackEventMap[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

removeCue

Parameters

cue: TextTrackCue

Returns void

removeEventListener

Type Parameters

K extends "cuechange"

Parameters

type: K

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

Parameters

this: TextTrack

ev: TextTrackEventMap[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` activeCues

`Readonly` cues

`Readonly` id

`Readonly` inBandMetadataTrackDispatchType

`Readonly` kind

`Readonly` label

`Readonly` language

`Optional` options: boolean | AddEventListenerOptions

`Optional` options: boolean | AddEventListenerOptions

`Optional` options: boolean | EventListenerOptions

`Optional` options: boolean | EventListenerOptions