Interface ReadonlyTrackController<TrackLoadOptionsType>

A readonly interface to the track controller.

interface ReadonlyTrackController<TrackLoadOptionsType extends TrackLoadOptions> {
    activeTrack: ReadonlyTrack | null;
    queue: readonly TrackLoadOptionsType[];
    getCachedTrack(uri: string): ReadonlyTrack | null;
    getCachedTracks(): IterableIterator<ReadonlyTrack>;
    hasAnyListeners(): boolean;
    hasListeners(
        type: keyof TrackControllerEventMap<TrackLoadOptionsType>,
    ): boolean;
    hasNext(): boolean;
    isTrackCached(uri: string): boolean;
    on<K extends keyof TrackControllerEventMap<TrackLoadOptionsType>>(
        type: K,
        handler: EventHandler<TrackControllerEventMap<TrackLoadOptionsType>[K]>,
        options?: SignalOptions,
    ): Unsubscribe;
}

Type Parameters

TrackLoadOptionsType extends TrackLoadOptions

Hierarchy (View Summary)

ReadonlyEventHost<TrackControllerEventMap<TrackLoadOptionsType>>
- ReadonlyTrackController
  - TrackController

Index

Properties

activeTrack queue

Methods

getCachedTrack getCachedTracks hasAnyListeners hasListeners hasNext isTrackCached on

Properties

`Readonly`activeTrack

activeTrack: ReadonlyTrack | null

The active track, or null when the selected track has not yet activated (e.g. behind a preroll) or nothing is loaded.

`Readonly`queue

queue: readonly TrackLoadOptionsType[]

Returns the current queue of TrackLoadOptions. Observe 'queueChange' for changes to this queue.

Methods

getCachedTrack

getCachedTrack(uri: string): ReadonlyTrack | null
Returns the cached track for the given URI, or null if the track is not cached.
Parameters
- uri: string
Returns ReadonlyTrack | null
- Defined in vinyl/src/track/TrackController.ts:129

getCachedTracks

getCachedTracks(): IterableIterator<ReadonlyTrack>
Returns an iterator of currently cached tracks.

Returns IterableIterator<ReadonlyTrack>
- Defined in vinyl/src/track/TrackController.ts:134

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 TrackControllerEventMap<TrackLoadOptionsType>): boolean
Returns true if the event host has any listeners for the given type.
Parameters
- type: keyof TrackControllerEventMap<TrackLoadOptionsType>
Returns boolean
Inherited from ReadonlyEventHost.hasListeners
- Defined in vinyl-util/src/event/EventHost.ts:50

hasNext

hasNext(): boolean
Returns true if there is at least one track in the queue.

Returns boolean
- Defined in vinyl/src/track/TrackController.ts:119

isTrackCached

isTrackCached(uri: string): boolean
Returns true if the track with the given URI is cached.
Parameters
- uri: string
Returns boolean
- Defined in vinyl/src/track/TrackController.ts:124

on

on<K extends keyof TrackControllerEventMap<TrackLoadOptionsType>>(
    type: K,
    handler: EventHandler<TrackControllerEventMap<TrackLoadOptionsType>[K]>,
    options?: SignalOptions,
): Unsubscribe
Adds an event handler for the given typed event.
Type Parameters
- K extends keyof TrackControllerEventMap<TrackLoadOptionsType>
Parameters
- type: K
  The key representing the event type to listen for.
- handler: EventHandler<TrackControllerEventMap<TrackLoadOptionsType>[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