Class StandardCommonMediaKeySession

CommonMediaKeySession for unprefixed EME implementations.

Hierarchy (View Summary)

EventHostImpl<CommonMediaKeySessionEventMap>
- StandardCommonMediaKeySession

Implements

Index

Constructors

constructor

new StandardCommonMediaKeySession(
    session: MediaKeySession,
    mimeType: string,
    initDataType: string,
    initData: EncryptedInitData,
): StandardCommonMediaKeySession
Parameters
- session: MediaKeySession
- mimeType: string
- initDataType: string
- initData: EncryptedInitData
Returns StandardCommonMediaKeySession
Overrides EventHostImpl.constructor
- Defined in vinyl/src/drm/commonEme/StandardCommonEme.ts:124

Properties

`Readonly`initData

initData: EncryptedInitData

`Readonly`initDataType

initDataType: string

`Readonly`logPrefix

logPrefix: string = ...

A string prefix for all log statements made by this target.

`Readonly`mimeType

mimeType: string

Accessors

[toStringTag]

get "[toStringTag]"(): string
Returns string
Overrides EventHostImpl.[toStringTag]
- Defined in vinyl/src/drm/commonEme/StandardCommonEme.ts:112

disposed

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

Returns boolean
Implementation of CommonMediaKeySession.disposed
- Defined in vinyl/src/drm/commonEme/StandardCommonEme.ts:165

Methods

dispatch

dispatch<K extends keyof CommonMediaKeySessionEventMap>(
type: K,
event: CommonMediaKeySessionEventMap[K],
): void
Dispatches an event.
Type Parameters
- K extends keyof CommonMediaKeySessionEventMap
Parameters
- type: K
  The key of the event within EventMap
- event: CommonMediaKeySessionEventMap[K]
  If the passed event is read-only, then it may be re-used/cached. Otherwise, it should be a new event object every dispatch. If no target property is set on the event, the target will be set to this host.
Returns void
Inherited from EventHostImpl.dispatch
- Defined in vinyl-util/src/event/EventHost.ts:108

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
Implementation of Disposable.dispose

Overrides EventHostImpl.dispose
- Defined in vinyl/src/drm/commonEme/StandardCommonEme.ts:169

hasAnyListeners

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

Returns boolean
Implementation of CommonMediaKeySession.hasAnyListeners

Inherited from EventHostImpl.hasAnyListeners
- Defined in vinyl-util/src/event/EventHost.ts:88

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
Implementation of CommonMediaKeySession.hasListeners

Inherited from EventHostImpl.hasListeners
- Defined in vinyl-util/src/event/EventHost.ts:95

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.
Implementation of CommonMediaKeySession.on

Inherited from EventHostImpl.on
- Defined in vinyl-util/src/event/EventHost.ts:99

update

update(key: ArrayBufferLike): Promise<void>
Updates the session with the license data.
Parameters
- key: ArrayBufferLike
Returns Promise<void>
Implementation of CommonMediaKeySession.update
- Defined in vinyl/src/drm/commonEme/StandardCommonEme.ts:160

Class StandardCommonMediaKeySession

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns StandardCommonMediaKeySession

Properties

ReadonlyinitData

ReadonlyinitDataType

ReadonlylogPrefix

ReadonlymimeType

Accessors

[toStringTag]

Returns string

disposed

Returns boolean

Methods

dispatch

Type Parameters

Parameters

Returns void

dispose

Returns void

hasAnyListeners

Returns boolean

hasListeners

Parameters

Returns boolean

on

Type Parameters

Parameters

Returns Unsubscribe

update

Parameters

Returns Promise<void>

Settings

On This Page

`Readonly`initData

`Readonly`initDataType

`Readonly`logPrefix

`Readonly`mimeType