Skip to content

@ralphschuler.webgl shader factory.<internal>.TextTrack

github-actions edited this page Nov 26, 2023 · 1 revision

Interface: TextTrack

@ralphschuler/webgl-shader-factory.<internal>.TextTrack

This interface also inherits properties from EventTarget.

MDN Reference

Hierarchy

  • EventTarget

    TextTrack

Table of contents

Properties

Methods

Properties

activeCues

Readonly 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

Defined in

node_modules/typescript/lib/lib.dom.d.ts:22073


cues

Readonly cues: null | TextTrackCueList

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

MDN Reference

Defined in

node_modules/typescript/lib/lib.dom.d.ts:22079


id

Readonly 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

Defined in

node_modules/typescript/lib/lib.dom.d.ts:22089


inBandMetadataTrackDispatchType

Readonly inBandMetadataTrackDispatchType: string

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

MDN Reference

Defined in

node_modules/typescript/lib/lib.dom.d.ts:22095


kind

Readonly kind: TextTrackKind

Returns the text track kind string.

MDN Reference

Defined in

node_modules/typescript/lib/lib.dom.d.ts:22101


label

Readonly 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

Defined in

node_modules/typescript/lib/lib.dom.d.ts:22107


language

Readonly language: string

Returns the text track language string.

MDN Reference

Defined in

node_modules/typescript/lib/lib.dom.d.ts:22113


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

Defined in

node_modules/typescript/lib/lib.dom.d.ts:22121


oncuechange

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

MDN Reference

Defined in

node_modules/typescript/lib/lib.dom.d.ts:22123

Methods

addCue

addCue(cue): void

Adds the given cue to textTrack's text track list of cues.

MDN Reference

Parameters

Name Type
cue TextTrackCue

Returns

void

Defined in

node_modules/typescript/lib/lib.dom.d.ts:22129


addEventListener

addEventListener<K>(type, listener, options?): void

Type parameters

Name Type
K extends "cuechange"

Parameters

Name Type
type K
listener (this: TextTrack, ev: TextTrackEventMap[K]) => any
options? boolean | AddEventListenerOptions

Returns

void

Overrides

EventTarget.addEventListener

Defined in

node_modules/typescript/lib/lib.dom.d.ts:22136

addEventListener(type, listener, options?): void

Parameters

Name Type
type string
listener EventListenerOrEventListenerObject
options? boolean | AddEventListenerOptions

Returns

void

Overrides

EventTarget.addEventListener

Defined in

node_modules/typescript/lib/lib.dom.d.ts:22137


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

Name Type
event Event

Returns

boolean

Inherited from

EventTarget.dispatchEvent

Defined in

node_modules/typescript/lib/lib.dom.d.ts:8217


removeCue

removeCue(cue): void

Removes the given cue from textTrack's text track list of cues.

MDN Reference

Parameters

Name Type
cue TextTrackCue

Returns

void

Defined in

node_modules/typescript/lib/lib.dom.d.ts:22135


removeEventListener

removeEventListener<K>(type, listener, options?): void

Type parameters

Name Type
K extends "cuechange"

Parameters

Name Type
type K
listener (this: TextTrack, ev: TextTrackEventMap[K]) => any
options? boolean | EventListenerOptions

Returns

void

Overrides

EventTarget.removeEventListener

Defined in

node_modules/typescript/lib/lib.dom.d.ts:22138

removeEventListener(type, listener, options?): void

Parameters

Name Type
type string
listener EventListenerOrEventListenerObject
options? boolean | EventListenerOptions

Returns

void

Overrides

EventTarget.removeEventListener

Defined in

node_modules/typescript/lib/lib.dom.d.ts:22139

Typescript Libraries

Modules

Namespaces

Clone this wiki locally