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>(type: TType | readonly TType[], listener: EventListener<CachingTaskEventMap[TType]>): void;
    pause(): void;
    remove(): void;
    removeEventListener<TType>(type: TType | readonly TType[], listener: EventListener<CachingTaskEventMap[TType]>): void;
    start(): void;
}

Hierarchy (view full)

Properties

bytes bytesCached cached duration id license parameters percentageCached secondsCached source status

Methods

addEventListener pause remove removeEventListener start

Properties

Readonlybytes

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.

ReadonlybytesCached

bytesCached: number

The amount downloaded and stored, in bytes.

Readonlycached

cached: TimeRanges

The time ranges cached.

Readonlyduration

duration: number

The requested cached duration of the media, in seconds.

Readonlyid

id: string

The generated identifier for the task.

Readonlylicense

license: CachingTaskLicense

The API for license related queries and operations

Readonlyparameters

parameters: CachingTaskParameters

The configuration of the task.

ReadonlypercentageCached

percentageCached: number

The percentage cached.

ReadonlysecondsCached

secondsCached: number

The duration cached, in seconds.

Readonlysource

source: SourceDescription

The media source associated with the task.

Readonlystatus

status: CacheTaskStatus

The current status of the task.

Methods

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

start

  • start(): void

  • Start caching the media.

    Returns void

Settings

Member Visibility

On This Page

Properties
Methods