Interface MediaCacheAPI

The media cache API.

interface MediaCacheAPI {
    status: CacheStatus;
    tasks: CachingTaskList;
    addEventListener<TType extends keyof CacheEventMap>(
        type: TType | readonly TType[],
        listener: EventListener<CacheEventMap[TType]>,
    ): void;
    createTask(
        source: SourceDescription,
        parameters: CachingTaskParameters,
    ): Promise<CachingTask>;
    removeEventListener<TType extends keyof CacheEventMap>(
        type: TType | readonly TType[],
        listener: EventListener<CacheEventMap[TType]>,
    ): void;
}

Hierarchy (View Summary)

EventDispatcher<CacheEventMap>
- MediaCacheAPI

Index

Properties

Methods

addEventListener createTask removeEventListener

Properties

`Readonly`status

status: CacheStatus

The current status of the cache.

`Readonly`tasks

tasks: CachingTaskList

List of caching tasks which control the caching of media.

Methods

addEventListener

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

createTask

createTask(
source: SourceDescription,
parameters: CachingTaskParameters,
): Promise<CachingTask>
Create a caching task which controls the caching of media.
Parameters
- source: SourceDescription
  Describes the media source to be cached.
- parameters: CachingTaskParameters
  Contains caching task related options.
Returns Promise<CachingTask>
- Defined in api/cache/MediaCacheAPI.ts:44

removeEventListener

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