Class SegmentDataSlot

A SegmentSlot is a holder for a segment buffer. It may be requested, cleared, and its status observed.

Implements

Disposable

Index

Constructors

Properties

Accessors

Methods

clear dispose request

Constructors

constructor

new SegmentDataSlot(requestSegmentData: SegmentDataProvider): SegmentDataSlot
Parameters
- requestSegmentData: SegmentDataProvider
Returns SegmentDataSlot
- Defined in vinyl/dist/types/current/streaming/SegmentDataSlot.d.ts:37

Properties

onStatusChange

onStatusChange: null | (() => void)

Called when the status has changed.

Accessors

status

get status(): SegmentStatus
This segment's request status.

Returns SegmentStatus
- Defined in vinyl/dist/types/current/streaming/SegmentDataSlot.d.ts:41
set status(value: SegmentStatus): void
Parameters
- value: SegmentStatus
Returns void
- Defined in vinyl/dist/types/current/streaming/SegmentDataSlot.d.ts:42

Methods

clear

clear(): void
Aborts the request if the status is currently SegmentStatus.PENDING, and clears the cached buffer. The status will go back to SegmentStatus.INACTIVE and the segment may be requested again in the future.

Returns void
- Defined in vinyl/dist/types/current/streaming/SegmentDataSlot.d.ts:47

dispose

dispose(): void
Clears this segment and removes its handler.

Returns void
Implementation of Disposable.dispose
- Defined in vinyl/dist/types/current/streaming/SegmentDataSlot.d.ts:56

request

request(): Promise<ArrayBuffer>
Begins the segment request now if it has not already been requested. The promise returned will settle after this slot's status has updated and onStatusChange callback invoked.

Returns Promise<ArrayBuffer>
- Defined in vinyl/dist/types/current/streaming/SegmentDataSlot.d.ts:52