Version: 2.67.0

CachingTask

THEOplayer > CachingTask

CachingTask interface

Inherits from EventDispatcher<CachingTaskEventMap> . See parent page for inherited properties and methods.

Represents a caching task.

Signature:
export interface CachingTask extends EventDispatcher<CachingTaskEventMap>

Properties

Property

Type

Description

bytes

number

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

bytesCached

number

The amount downloaded and stored, in bytes.

cached

TimeRanges

The time ranges cached.

duration

number

The requested cached duration of the media, in seconds.

id

string

The generated identifier for the task.

license

CachingTaskLicense

The API for license related queries and operations

parameters

CachingTaskParameters

The configuration of the task.

percentageCached

number

The percentage cached.

secondsCached

number

The duration cached, in seconds.

source

SourceDescription

The media source associated with the task.

status

CacheTaskStatus

The current status of the task.

Methods

Method

Description

pause()

Pause caching the media.

remove()

Remove the cached media.

start()

Start caching the media.