Interface CommonMediaKeySession

This provides a common interface for MediaKeySession EME implementations.

interface CommonMediaKeySession {
    initData: EncryptedInitData;
    initDataType: string;
    mimeType: string;
    get disposed(): boolean;
    dispose(): void;
    hasAnyListeners(): boolean;
    hasListeners(type: keyof CommonMediaKeySessionEventMap): boolean;
    on<K extends keyof CommonMediaKeySessionEventMap>(
        type: K,
        handler: EventHandler<CommonMediaKeySessionEventMap[K]>,
        options?: SignalOptions,
    ): Unsubscribe;
    update(key: ArrayBuffer): Promise<void>;
}

Hierarchy (View Summary)

ReadonlyEventHost<CommonMediaKeySessionEventMap>
- CommonMediaKeySession

Implemented by

StandardCommonMediaKeySession

Index

Properties

initData initDataType mimeType

Accessors

Methods

dispose hasAnyListeners hasListeners on update

Properties

`Readonly`initData

initData: EncryptedInitData

`Readonly`initDataType

initDataType: string

`Readonly`mimeType

mimeType: string

Accessors

disposed

get disposed(): boolean
Returns true if the session has been disposed.

Returns boolean
- Defined in vinyl/src/drm/commonEme/CommonEme.ts:138

Methods

dispose

dispose(): void
Closes the session, and removes session handling and event listeners, freeing this session handler for GC.

Note: The audio source should be cleared first.

Returns void
- Defined in vinyl/src/drm/commonEme/CommonEme.ts:146

hasAnyListeners

hasAnyListeners(): boolean
Returns true if the event host has any listeners.

Returns boolean
Inherited from ReadonlyEventHost.hasAnyListeners
- Defined in vinyl-util/src/event/EventHost.ts:45

hasListeners

hasListeners(type: keyof CommonMediaKeySessionEventMap): boolean
Returns true if the event host has any listeners for the given type.
Parameters
- type: keyof CommonMediaKeySessionEventMap
Returns boolean
Inherited from ReadonlyEventHost.hasListeners
- Defined in vinyl-util/src/event/EventHost.ts:50

on

on<K extends keyof CommonMediaKeySessionEventMap>(
    type: K,
    handler: EventHandler<CommonMediaKeySessionEventMap[K]>,
    options?: SignalOptions,
): Unsubscribe
Adds an event handler for the given typed event.
Type Parameters
- K extends keyof CommonMediaKeySessionEventMap
Parameters
- type: K
  The key representing the event type to listen for.
- handler: EventHandler<CommonMediaKeySessionEventMap[K]>
  A callback to invoke when the event with the given type is dispatched.
- Optionaloptions: SignalOptions
  Options for changing listening behavior.
Returns Unsubscribe
Returns a method, when invoked, removes the handler.
Inherited from ReadonlyEventHost.on
- Defined in vinyl-util/src/event/EventHost.ts:36

update

update(key: ArrayBuffer): Promise<void>
Updates the session with the license data.
Parameters
- key: ArrayBuffer
Returns Promise<void>
- Defined in vinyl/src/drm/commonEme/CommonEme.ts:133