Class HlsManifestControllerImpl

Implements

HlsManifestController

Index

Constructors

Accessors

[toStringTag] changeId disposed error logPrefix value

Methods

dispose getValue map onData pick refresh reset

Constructors

constructor

new HlsManifestControllerImpl(
manifestProvider: HlsManifestProvider,
): HlsManifestControllerImpl
Parameters
- manifestProvider: HlsManifestProvider
Returns HlsManifestControllerImpl
- Defined in vinyl/dist/types/current/track/hls/HlsManifestController.d.ts:12

Accessors

[toStringTag]

get "[toStringTag]"(): string
Returns string
- Defined in vinyl/dist/types/current/track/hls/HlsManifestController.d.ts:6

changeId

get changeId(): number
A monotonically increasing id that increments before each change notification.

Returns number
Implementation of HlsManifestController.changeId
- Defined in vinyl/dist/types/current/track/hls/HlsManifestController.d.ts:20

disposed

get disposed(): boolean
Returns boolean
- Defined in vinyl/dist/types/current/track/hls/HlsManifestController.d.ts:25

error

get error(): null | Error
The most recent error from the manifest provider, or null.

Returns null | Error
- Defined in vinyl/dist/types/current/track/hls/HlsManifestController.d.ts:16

logPrefix

get logPrefix(): string
Returns string
- Defined in vinyl/dist/types/current/track/hls/HlsManifestController.d.ts:7

value

get value(): Promise<HlsManifestData>
The current value.

Returns Promise<HlsManifestData>
Implementation of HlsManifestController.value
- Defined in vinyl/dist/types/current/track/hls/HlsManifestController.d.ts:19

Methods

dispose

dispose(): void
Returns void
- Defined in vinyl/dist/types/current/track/hls/HlsManifestController.d.ts:26

getValue

getValue(): Promise<HlsManifestData>
Gets the current value.

Returns Promise<HlsManifestData>
Implementation of HlsManifestController.getValue
- Defined in vinyl/dist/types/current/track/hls/HlsManifestController.d.ts:21

map

map<U>(fn: (value: Promise<HlsManifestData>) => U): MutableValue<U>
Creates a data provider transforming this data.
Type Parameters
- U
Parameters
- fn: (value: Promise<HlsManifestData>) => U
Returns MutableValue<U>
Implementation of HlsManifestController.map
- Defined in vinyl/dist/types/current/track/hls/HlsManifestController.d.ts:23

onData

onData(
    callback: (
        value: Promise<HlsManifestData>,
        previous?: Promise<HlsManifestData>,
    ) => void,
): () => void
Invokes a callback immediately and when data has changed.
Parameters
- callback: (value: Promise<HlsManifestData>, previous?: Promise<HlsManifestData>) => void
Returns () => void
Implementation of HlsManifestController.onData
- Defined in vinyl/dist/types/current/track/hls/HlsManifestController.d.ts:22

pick

pick<K extends keyof Promise<HlsManifestData>>(
key: K,
): MutableValue<Promise<HlsManifestData>[K]>
Returns a data provider for a property of T.
Type Parameters
- K extends keyof Promise<HlsManifestData>
Parameters
- key: K
Returns MutableValue<Promise<HlsManifestData>[K]>
Implementation of HlsManifestController.pick
- Defined in vinyl/dist/types/current/track/hls/HlsManifestController.d.ts:24

refresh

refresh(): void
Manually triggers a reload of the manifest. A manifest reload will not clear currently fetched or buffered segments.

Returns void
Implementation of HlsManifestController.refresh
- Defined in vinyl/dist/types/current/track/hls/HlsManifestController.d.ts:17

reset

reset(): void
If the manifest promise has rejected, refresh.

Returns void
Implementation of HlsManifestController.reset
- Defined in vinyl/dist/types/current/track/hls/HlsManifestController.d.ts:18