Interface ReadonlyTextTrackController

Read-only view of available text tracks and the active selection.

interface ReadonlyTextTrackController {
    activeTextTrack: TextTrackInfo | null;
    textTracks: readonly TextTrackInfo[];
    get active(): boolean;
    hasAnyListeners(): boolean;
    hasListeners(type: keyof TextTrackEventMap): boolean;
    on<K extends keyof TextTrackEventMap>(
        type: K,
        handler: EventHandler<TextTrackEventMap[K]>,
        options?: SignalOptions,
    ): Unsubscribe;
}

Hierarchy (View Summary)

ReadonlyEventHost<TextTrackEventMap>
- ReadonlyTextTrackController
  - TextTrackController

Index

Properties

activeTextTrack textTracks

Accessors

Methods

hasAnyListeners hasListeners on

Properties

`Readonly`activeTextTrack

activeTextTrack: TextTrackInfo | null

The currently active text track, or null if none is active.

`Readonly`textTracks

textTracks: readonly TextTrackInfo[]

The list of currently discovered text tracks.

Accessors

active

get active(): boolean
Returns true if this text track controller is active.

Returns boolean
- Defined in vinyl/src/text/TextTrack.ts:222

Methods

hasAnyListeners

hasAnyListeners(): boolean
Returns true if the event host has any listeners.

Returns boolean
Inherited from ReadonlyEventHost.hasAnyListeners
- Defined in vinyl-util/src/event/EventHost.ts:45

hasListeners

hasListeners(type: keyof TextTrackEventMap): boolean
Returns true if the event host has any listeners for the given type.
Parameters
- type: keyof TextTrackEventMap
Returns boolean
Inherited from ReadonlyEventHost.hasListeners
- Defined in vinyl-util/src/event/EventHost.ts:50

on

on<K extends keyof TextTrackEventMap>(
    type: K,
    handler: EventHandler<TextTrackEventMap[K]>,
    options?: SignalOptions,
): Unsubscribe
Adds an event handler for the given typed event.
Type Parameters
- K extends keyof TextTrackEventMap
Parameters
- type: K
  The key representing the event type to listen for.
- handler: EventHandler<TextTrackEventMap[K]>
  A callback to invoke when the event with the given type is dispatched.
- Optionaloptions: SignalOptions
  Options for changing listening behavior.
Returns Unsubscribe
Returns a method, when invoked, removes the handler.
Inherited from ReadonlyEventHost.on
- Defined in vinyl-util/src/event/EventHost.ts:36