Interface TextTrack

The TextTrack interface of the WebVTT API represents a text track associated with a media element.

interface TextTrack {
    activeCues: TextTrackCueList | null;
    cues: TextTrackCueList | null;
    id: string;
    inBandMetadataTrackDispatchType: string;
    kind: TextTrackKind;
    label: string;
    language: string;
    mode: TextTrackMode;
    oncuechange: ((this: TextTrack, ev: Event) => any) | null;
    addCue(cue: TextTrackCue): void;
    addEventListener<K extends "cuechange">(
        type: K,
        listener: (this: TextTrack, ev: TextTrackEventMap[K]) => any,
        options?: boolean | AddEventListenerOptions,
    ): void;
    addEventListener(
        type: string,
        listener: EventListenerOrEventListenerObject,
        options?: boolean | AddEventListenerOptions,
    ): void;
    dispatchEvent(event: Event): boolean;
    dispatchEvent(event: Event): boolean;
    removeCue(cue: TextTrackCue): void;
    removeEventListener<K extends "cuechange">(
        type: K,
        listener: (this: TextTrack, ev: TextTrackEventMap[K]) => any,
        options?: boolean | EventListenerOptions,
    ): void;
    removeEventListener(
        type: string,
        listener: EventListenerOrEventListenerObject,
        options?: boolean | EventListenerOptions,
    ): void;
}

Hierarchy

EventTarget
- TextTrack

Index

Properties

activeCues cues id inBandMetadataTrackDispatchType kind label language mode oncuechange

Methods

addCue addEventListener dispatchEvent removeCue removeEventListener

Properties

`Readonly`activeCues

activeCues: TextTrackCueList | null

The activeCues read-only property of the TextTrack interface returns a TextTrackCueList object listing the currently active cues.

MDN Reference

`Readonly`cues

cues: TextTrackCueList | null

The cues read-only property of the TextTrack interface returns a TextTrackCueList object containing all of the track's cues.

MDN Reference

`Readonly`id

id: string

The id read-only property of the TextTrack interface returns the ID of the track if it has one.

MDN Reference

`Readonly`inBandMetadataTrackDispatchType

inBandMetadataTrackDispatchType: string

The inBandMetadataTrackDispatchType read-only property of the TextTrack interface returns the text track's in-band metadata dispatch type of the text track represented by the TextTrack object.

MDN Reference

`Readonly`kind

kind: TextTrackKind

The kind read-only property of the TextTrack interface returns the kind of text track this object represents.

MDN Reference

`Readonly`label

label: string

The label read-only property of the TextTrack interface returns a human-readable label for the text track, if it is available.

MDN Reference

`Readonly`language

language: string

The language read-only property of the TextTrack interface returns the language of the text track.

MDN Reference

mode

mode: TextTrackMode

The TextTrack interface's mode property is a string specifying and controlling the text track's mode: disabled, hidden, or showing.

MDN Reference

oncuechange

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

MDN Reference

Methods

addCue

addCue(cue: TextTrackCue): void
The addCue() method of the TextTrack interface adds a new cue to the list of cues.

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

addEventListener

addEventListener<K extends "cuechange">(
    type: K,
    listener: (this: TextTrack, ev: TextTrackEventMap[K]) => any,
    options?: boolean | AddEventListenerOptions,
): void
The addEventListener() method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.

MDN Reference
Type Parameters
- K extends "cuechange"
Parameters
- type: K
- listener: (this: TextTrack, ev: TextTrackEventMap[K]) => any
- Optionaloptions: boolean | AddEventListenerOptions
Returns void
Overrides EventTarget.addEventListener
- Defined in node_modules/typescript/lib/lib.dom.d.ts:32048
addEventListener(
    type: string,
    listener: EventListenerOrEventListenerObject,
    options?: boolean | AddEventListenerOptions,
): void
The addEventListener() method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.

MDN Reference
Parameters
- type: string
- listener: EventListenerOrEventListenerObject
- Optionaloptions: boolean | AddEventListenerOptions
Returns void
Overrides EventTarget.addEventListener
- Defined in node_modules/typescript/lib/lib.dom.d.ts:32049

dispatchEvent

dispatchEvent(event: Event): boolean
The dispatchEvent() method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.

MDN Reference
Parameters
- event: Event
Returns boolean
Inherited from EventTarget.dispatchEvent
- Defined in node_modules/typescript/lib/lib.dom.d.ts:11575
dispatchEvent(event: Event): boolean
The dispatchEvent() method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.

MDN Reference
Parameters
- event: Event
Returns boolean
Inherited from EventTarget.dispatchEvent
- Defined in node_modules/typescript/lib/lib.webworker.d.ts:4019

removeCue

removeCue(cue: TextTrackCue): void
The removeCue() method of the TextTrack interface removes a cue from the list of cues.

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

removeEventListener

removeEventListener<K extends "cuechange">(
    type: K,
    listener: (this: TextTrack, ev: TextTrackEventMap[K]) => any,
    options?: boolean | EventListenerOptions,
): void
The removeEventListener() method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.

MDN Reference
Type Parameters
- K extends "cuechange"
Parameters
- type: K
- listener: (this: TextTrack, ev: TextTrackEventMap[K]) => any
- Optionaloptions: boolean | EventListenerOptions
Returns void
Overrides EventTarget.removeEventListener
- Defined in node_modules/typescript/lib/lib.dom.d.ts:32050
removeEventListener(
    type: string,
    listener: EventListenerOrEventListenerObject,
    options?: boolean | EventListenerOptions,
): void
The removeEventListener() method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.

MDN Reference
Parameters
- type: string
- listener: EventListenerOrEventListenerObject
- Optionaloptions: boolean | EventListenerOptions
Returns void
Overrides EventTarget.removeEventListener
- Defined in node_modules/typescript/lib/lib.dom.d.ts:32051

Interface TextTrack

Hierarchy

Index

Properties

Methods

Properties

ReadonlyactiveCues

Readonlycues

Readonlyid

ReadonlyinBandMetadataTrackDispatchType

Readonlykind

Readonlylabel

Readonlylanguage

mode

oncuechange

Methods

addCue

Parameters

Returns void

addEventListener

Type Parameters

Parameters

Returns void

Parameters

Returns void

dispatchEvent

Parameters

Returns boolean

Parameters

Returns boolean

removeCue

Parameters

Returns void

removeEventListener

Type Parameters

Parameters

Returns void

Parameters

Returns void

Settings

On This Page

`Readonly`activeCues

`Readonly`cues

`Readonly`id

`Readonly`inBandMetadataTrackDispatchType

`Readonly`kind

`Readonly`label

`Readonly`language