Class TrackBase<EventMap, LoadOptionsType>`Abstract`

A base class for all tracks.

Constructors

`Protected`constructor

new TrackBase<
    EventMap extends StreamingEventMap = StreamingEventMap,
    LoadOptionsType extends TrackBaseOptions = TrackBaseOptions,
>(
    uri: string,
    type: string,
    deps: TrackBaseDeps,
): TrackBase<EventMap, LoadOptionsType>
Type Parameters
- EventMap extends StreamingEventMap = StreamingEventMap
- LoadOptionsType extends TrackBaseOptions = TrackBaseOptions
Parameters
- uri: string
  The identifier of this track, used as the key in the track cache.
- type: string
  The track type.
- deps: TrackBaseDeps
Returns TrackBase<EventMap, LoadOptionsType>
Overrides EventHostImpl.constructor
- Defined in vinyl/dist/types/current/track/TrackBase.d.ts:71

Properties

`Protected`_error

_error: null | Error

Sets on handleError, cleared on 'reset'.

`Protected` `Readonly`deps

deps: TrackBaseDeps

`Protected` `Readonly`disposer

disposer: Disposer

`Protected`drmSessionAbort

drmSessionAbort: AbortSlot

`Protected` `Readonly`errorHandler

errorHandler: (error: any) => void

`Protected`loadOptions

loadOptions: null | LoadOptionsType

The current load options, if this is an active track.

`Readonly`logPrefix

logPrefix: string

A string prefix for all log statements made by this target.

`Readonly`type

type: string

The track type.

`Readonly`uri

uri: string

The identifier of this track, used as the key in the track cache.

Accessors

[toStringTag]

get "[toStringTag]"(): string
Returns string
Overrides EventHostImpl.[toStringTag]
- Defined in vinyl/dist/types/current/track/TrackBase.d.ts:53

active

get active(): boolean
True if the track is the currently playing track.

Returns boolean
Implementation of Track.active
- Defined in vinyl/dist/types/current/track/TrackBase.d.ts:83

`Abstract`contentTypes

get contentTypes(): Readonly<Omit<Set<ContentType>, "clear" | "delete" | "add">>
The current content types for the active streams, e.g. Set(['audio', 'video'])

Returns Readonly<Omit<Set<ContentType>, "clear" | "delete" | "add">>
Implementation of Track.contentTypes
- Defined in vinyl/dist/types/current/track/TrackBase.d.ts:62

disposed

get disposed(): boolean
True if the track has been disposed.

Returns boolean
Implementation of Track.disposed
- Defined in vinyl/dist/types/current/track/TrackBase.d.ts:84

error

get error(): null | Error
The last error that occurred in this track, or null if no error.

Returns null | Error
Implementation of Track.error
- Defined in vinyl/dist/types/current/track/TrackBase.d.ts:80

extra

get extra(): any
Returns the extra object from the load configuration's config when this track is active, or null if this track is not active.

Returns any
Implementation of Track.extra
- Defined in vinyl/dist/types/current/track/TrackBase.d.ts:82

fetchedRanges

get fetchedRanges(): ReadonlyRanges
The time ranges the track has fetched. This will be a snapshot of the fetched ranges at the time this property is accessed.

Returns ReadonlyRanges
Implementation of Track.fetchedRanges
- Defined in vinyl/dist/types/current/track/TrackBase.d.ts:61

Methods

activate

activate(loadOptions: LoadOptionsType): void
Sets this track as active, deactivating any currently active track. This should set sources on the playback source and add any listeners needed for shared resources.
Parameters
- loadOptions: LoadOptionsType
  Configuration from TrackLoadOptions.config, provided by the Application.
Returns void
Implementation of Track.activate
- Defined in vinyl/dist/types/current/track/TrackBase.d.ts:85

`Abstract`clearPrefetch

clearPrefetch(): void
Clears any buffered or prefetched data, if applicable.

Returns void
Implementation of Track.clearPrefetch
- Defined in vinyl/dist/types/current/track/TrackBase.d.ts:97

`Protected`closeDrmSessions

closeDrmSessions(): void
Returns void
- Defined in vinyl/dist/types/current/track/TrackBase.d.ts:96

deactivate

deactivate(): void
Sets this track as inactive. This should unset sources, and remove any listeners. Tracks do not implement disposable, when they are deactivated they are expected to be free for garbage collection if there are no longer references to the track.

Returns void
Implementation of Track.deactivate
- Defined in vinyl/dist/types/current/track/TrackBase.d.ts:93

dispatch

dispatch<K extends string | number | symbol>(type: K, event: EventMap[K]): void
Dispatches an event.
Type Parameters
- K extends string | number | symbol
Parameters
- type: K
  The key of the event within EventMap
- event: EventMap[K]
  If the passed event is read-only, then it may be re-used/cached. Otherwise, it should be a new event object every dispatch. If no target property is set on the event, the target will be set to this host.
Returns void
Inherited from EventHostImpl.dispatch
- Defined in vinyl-util/dist/types/current/event/EventHost.d.ts:65

dispose

dispose(): void
Returns void
Implementation of Track.dispose
Overrides EventHostImpl.dispose
- Defined in vinyl/dist/types/current/track/TrackBase.d.ts:105

`Abstract`getBufferingQuality

getBufferingQuality(contentType: ContentType): null | MediaQualityMetadata
The currently buffering media quality for the given content stream. This is set immediately before a segment of a new quality is appended.

Listen to TrackEventMap.bufferingQualityChange events for changes.
Parameters
- contentType: ContentType
  'video' | 'audio' | 'text'
Returns null | MediaQualityMetadata
Implementation of Track.getBufferingQuality
- Defined in vinyl/dist/types/current/track/TrackBase.d.ts:64

`Abstract`getPlaybackQuality

getPlaybackQuality(contentType: ContentType): null | MediaQualityMetadata
When this track is active, provides the currently playing media metadata for the given content type.

Listen to TrackEventMap.playbackQualityChange events for changes.
Parameters
- contentType: ContentType
  'video' | 'audio' | 'text'
Returns null | MediaQualityMetadata
Implementation of Track.getPlaybackQuality
- Defined in vinyl/dist/types/current/track/TrackBase.d.ts:65

`Abstract`getStreamingQuality

getStreamingQuality(contentType: ContentType): null | MediaQualityMetadata
The currently streaming media quality for the given content stream. This is set when a new quality is being requested.

Quality metadata progresses as follows: streamingQuality -> bufferingQuality -> playbackQuality

Listen to TrackEventMap.streamingQualityChange events for changes.
Parameters
- contentType: ContentType
  'video' | 'audio' | 'text'
Returns null | MediaQualityMetadata
Implementation of Track.getStreamingQuality
- Defined in vinyl/dist/types/current/track/TrackBase.d.ts:63

hasAnyListeners

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

Returns boolean
Implementation of Track.hasAnyListeners
Inherited from EventHostImpl.hasAnyListeners
- Defined in vinyl-util/dist/types/current/event/EventHost.d.ts:62

hasListeners

hasListeners(type: keyof EventMap): boolean
Returns true if the event host has any listeners for the given type.
Parameters
- type: keyof EventMap
Returns boolean
Implementation of Track.hasListeners
Inherited from EventHostImpl.hasListeners
- Defined in vinyl-util/dist/types/current/event/EventHost.d.ts:63

on

on<K extends string | number | symbol>(
    type: K,
    handler: EventHandler<EventMap[K]>,
    options?: SignalOptions,
): Unsubscribe
Adds an event handler for the given typed event.
Type Parameters
- K extends string | number | symbol
Parameters
- type: K
  The key representing the event type to listen for.
- handler: EventHandler<EventMap[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.
Implementation of Track.on
Inherited from EventHostImpl.on
- Defined in vinyl-util/dist/types/current/event/EventHost.d.ts:64

`Abstract`onActivated

onActivated(loadOptions: LoadOptionsType): void
The track has been activated. Operations on shared resources such as the playback controller may only be done while the track is currently active. For example if there is a loading operation before the playback source is set, isActive must be checked before the property is changed.
Parameters
- loadOptions: LoadOptionsType
Returns void
- Defined in vinyl/dist/types/current/track/TrackBase.d.ts:92

`Abstract`onDeactivated

onDeactivated(): void
Returns void
- Defined in vinyl/dist/types/current/track/TrackBase.d.ts:94

preload

preload(_trackOptions: TrackPreloadOptions, _loadOptions: LoadOptionsType): void
Provides configuration to the track and begins preloading (if applicable).
Parameters
- _trackOptions: TrackPreloadOptions
  Configuration provided by the TrackController.
- _loadOptions: LoadOptionsType
  Configuration from TrackLoadOptions.config, provided by the Application.
Returns void
Implementation of Track.preload
- Defined in vinyl/dist/types/current/track/TrackBase.d.ts:81

reset

reset(): void
Resets the track to recover from error states. Base implementation does nothing.

Overrides should dispatch 'reset' after resetting error state.

Returns void
Implementation of Track.reset
- Defined in vinyl/dist/types/current/track/TrackBase.d.ts:104

toString

toString(): string
Returns a string representation of an object.

Returns string
- Defined in vinyl/dist/types/current/track/TrackBase.d.ts:95

Class TrackBase<EventMap, LoadOptionsType>Abstract

Type Parameters

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

Protectedconstructor

Type Parameters

Parameters

Returns TrackBase<EventMap, LoadOptionsType>

Properties

Protected_error

Protected Readonlydeps

Protected Readonlydisposer

ProtecteddrmSessionAbort

Protected ReadonlyerrorHandler

ProtectedloadOptions

ReadonlylogPrefix

Readonlytype

Readonlyuri

Accessors

[toStringTag]

Returns string

active

Returns boolean

AbstractcontentTypes

Returns Readonly<Omit<Set<ContentType>, "clear" | "delete" | "add">>

disposed

Returns boolean

error

Returns null | Error

extra

Returns any

fetchedRanges

Returns ReadonlyRanges

Methods

activate

Parameters

Returns void

AbstractclearPrefetch

Returns void

ProtectedcloseDrmSessions

Returns void

deactivate

Returns void

dispatch

Type Parameters

Parameters

Returns void

dispose

Returns void

AbstractgetBufferingQuality

Parameters

Returns null | MediaQualityMetadata

AbstractgetPlaybackQuality

Parameters

Returns null | MediaQualityMetadata

AbstractgetStreamingQuality

Parameters

Returns null | MediaQualityMetadata

hasAnyListeners

Returns boolean

hasListeners

Parameters

Returns boolean

on

Type Parameters

Parameters

Returns Unsubscribe

AbstractonActivated

Parameters

Returns void

AbstractonDeactivated

Returns void

preload

Parameters

Class TrackBase<EventMap, LoadOptionsType>`Abstract`

`Protected`constructor

`Protected`_error

`Protected` `Readonly`deps

`Protected` `Readonly`disposer

`Protected`drmSessionAbort

`Protected` `Readonly`errorHandler

`Protected`loadOptions

`Readonly`logPrefix

`Readonly`type

`Readonly`uri

`Abstract`contentTypes

`Abstract`clearPrefetch

`Protected`closeDrmSessions

`Abstract`getBufferingQuality

`Abstract`getPlaybackQuality

`Abstract`getStreamingQuality

`Abstract`onActivated

`Abstract`onDeactivated