Interface CachingTask

Represents a caching task.

interface CachingTask {
    bytes: number;
    bytesCached: number;
    cached: TimeRanges;
    duration: number;
    id: string;
    license: CachingTaskLicense;
    parameters: CachingTaskParameters;
    percentageCached: number;
    secondsCached: number;
    source: SourceDescription;
    status: CacheTaskStatus;
    addEventListener<TType extends keyof CachingTaskEventMap>(
        type: TType | readonly TType[],
        listener: EventListener<CachingTaskEventMap[TType]>,
    ): void;
    pause(): void;
    remove(): void;
    removeEventListener<TType extends keyof CachingTaskEventMap>(
        type: TType | readonly TType[],
        listener: EventListener<CachingTaskEventMap[TType]>,
    ): void;
    start(): void;
}

Hierarchy (View Summary)

EventDispatcher<CachingTaskEventMap>
- CachingTask

Index

Properties

bytes bytesCached cached duration id license parameters percentageCached secondsCached source status

Methods

addEventListener pause remove removeEventListener start

Properties

`Readonly`bytes

bytes: number

The estimation of the amount this task will download and store, in bytes.

Remarks

- Returns -1 if the estimate is not available yet.

`Readonly`bytesCached

bytesCached: number

The amount downloaded and stored, in bytes.

`Readonly`cached

cached: TimeRanges

The time ranges cached.

`Readonly`duration

duration: number

The requested cached duration of the media, in seconds.

`Readonly`id

id: string

The generated identifier for the task.

`Readonly`license

license: CachingTaskLicense

The API for license related queries and operations

`Readonly`parameters

parameters: CachingTaskParameters

The configuration of the task.

`Readonly`percentageCached

percentageCached: number

The percentage cached.

`Readonly`secondsCached

secondsCached: number

The duration cached, in seconds.

`Readonly`source

source: SourceDescription

The media source associated with the task.

`Readonly`status

status: CacheTaskStatus

The current status of the task.

Methods

addEventListener

addEventListener<TType extends keyof CachingTaskEventMap>(
type: TType | readonly TType[],
listener: EventListener<CachingTaskEventMap[TType]>,
): void
Add the given listener for the given event type(s).
Type Parameters
- TType extends keyof CachingTaskEventMap
Parameters
- type: TType | readonly TType[]
  The type of the event.
- listener: EventListener<CachingTaskEventMap[TType]>
  The callback which is executed when the event occurs.
Returns void
Inherited from EventDispatcher.addEventListener

pause

pause(): void
Pause caching the media.

Returns void
Remarks

- A paused task can be resumed with CachingTask.start.

remove

remove(): void
Remove the cached media.

Returns void

removeEventListener

removeEventListener<TType extends keyof CachingTaskEventMap>(
type: TType | readonly TType[],
listener: EventListener<CachingTaskEventMap[TType]>,
): void
Remove the given listener for the given event type(s).
Type Parameters
- TType extends keyof CachingTaskEventMap
Parameters
- type: TType | readonly TType[]
  The type of the event.
- listener: EventListener<CachingTaskEventMap[TType]>
  The callback which will be removed.
Returns void
Inherited from EventDispatcher.removeEventListener

start

start(): void
Start caching the media.

Returns void

Interface CachingTask

Hierarchy (View Summary)

Index

Properties

Methods

Properties

`Readonly`bytes

Remarks

`Readonly`bytesCached

`Readonly`cached

`Readonly`duration

`Readonly`id

`Readonly`license

`Readonly`parameters

`Readonly`percentageCached

`Readonly`secondsCached

`Readonly`source

`Readonly`status

Methods

addEventListener

Type Parameters

Parameters

Returns void

pause

Returns void

Remarks

remove

Returns void

removeEventListener

Type Parameters

Parameters

Returns void

start

Returns void

Settings

On This Page

Interface CachingTask

Hierarchy (View Summary)

Index

Properties

Methods

Properties

Readonlybytes

Remarks

ReadonlybytesCached

Readonlycached

Readonlyduration

Readonlyid

Readonlylicense

Readonlyparameters

ReadonlypercentageCached

ReadonlysecondsCached

Readonlysource

Readonlystatus

Methods

addEventListener

Type Parameters

Parameters

Returns void

pause

Returns void

Remarks

remove

Returns void

removeEventListener

Type Parameters

Parameters

Returns void

start

Returns void

Settings

On This Page

`Readonly`bytes

`Readonly`bytesCached

`Readonly`cached

`Readonly`duration

`Readonly`id

`Readonly`license

`Readonly`parameters

`Readonly`percentageCached

`Readonly`secondsCached

`Readonly`source

`Readonly`status