THEOplayer > Cache
Inherits from EventDispatcher<CacheEventMap> . See parent page for inherited properties and methods.
The media caching API.
Signature:
export interface Cache extends EventDispatcher<CacheEventMap>
- Available since v2.26.
Property |
Type |
Description |
---|---|---|
The cache's network API which allows intercepting requests and responses made by the cache. |
||
The current status of the cache. |
||
List of caching tasks which control the caching of media. |
Method |
Description |
---|---|
createTask(source: SourceDescription, parameters: CachingTaskParameters): CachingTask |
Create a caching task which controls the caching of media. |
The cache's network API which allows intercepting requests and responses made by the cache.
Signature:
readonly network: NetworkInterceptorController;
The current status of the cache.
Signature:
readonly status: CacheStatus;
List of caching tasks which control the caching of media.
Signature:
readonly tasks: CachingTaskList;
Create a caching task which controls the caching of media.
Signature:
createTask(source: SourceDescription, parameters: CachingTaskParameters): CachingTask;
Parameter |
Type |
Description |
---|---|---|
source |
Describes the media source to be cached. |
|
parameters |
Contains caching task related options. |