MediaKeySession

The MediaKeySession interface of the Encrypted Media Extensions API represents a context for message exchange with a content decryption module (CDM). Available only in secure contexts.

MDN Reference

Extends

• EventTarget

Methods

addEventListener()

Call Signature

addEventListener<K>(
   type, 
   listener, 
   options?
): void;

The addEventListener() method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.

MDN Reference

Type Parameters

Type Parameter
K extends keyof MediaKeySessionEventMap

Parameters

Parameter	Type
type	K
listener	(this, ev) => any
options?	boolean | AddEventListenerOptions

Returns

void

Overrides

EventTarget.addEventListener

Call Signature

addEventListener(
   type, 
   listener, 
   options?
): void;

The addEventListener() method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.

MDN Reference

Parameters

Parameter	Type
type	string
listener	EventListenerOrEventListenerObject
options?	boolean | AddEventListenerOptions

Returns

void

Overrides

EventTarget.addEventListener

---

close()

close(): Promise<void>;

The close() method of the MediaKeySession interface notifies that the current media session is no longer needed, and that the content decryption module should release any resources associated with this object and close it. Then, it returns a Promise.

MDN Reference

Returns

Promise<void>

---

dispatchEvent()

dispatchEvent(event): boolean;

The dispatchEvent() method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order. The normal event processing rules (including the capturing and optional bubbling phase) also apply to events dispatched manually with dispatchEvent().

MDN Reference

Parameters

Parameter	Type
event	Event

Returns

boolean

Inherited from

EventTarget.dispatchEvent

---

generateRequest()

generateRequest(initDataType, initData): Promise<void>;

The generateRequest() method of the MediaKeySession interface returns a Promise after generating a license request based on initialization data.

MDN Reference

Parameters

Parameter	Type
initDataType	string
initData	BufferSource

Returns

Promise<void>

---

load()

load(sessionId): Promise<boolean>;

The load() method of the MediaKeySession interface returns a Promise that resolves to a boolean value after loading data for a specified session object.

MDN Reference

Parameters

Parameter	Type
sessionId	string

Returns

Promise<boolean>

---

remove()

remove(): Promise<void>;

The remove() method of the MediaKeySession interface returns a Promise after removing any session data associated with the current object.

MDN Reference

Returns

Promise<void>

---

removeEventListener()

Call Signature

removeEventListener<K>(
   type, 
   listener, 
   options?
): void;

The removeEventListener() method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target. The event listener to be removed is identified using a combination of the event type, the event listener function itself, and various optional options that may affect the matching process; see Matching event listeners for removal.

MDN Reference

Type Parameters

Type Parameter
K extends keyof MediaKeySessionEventMap

Parameters

Parameter	Type
type	K
listener	(this, ev) => any
options?	boolean | EventListenerOptions

Returns

void

Overrides

EventTarget.removeEventListener

Call Signature

removeEventListener(
   type, 
   listener, 
   options?
): void;

The removeEventListener() method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target. The event listener to be removed is identified using a combination of the event type, the event listener function itself, and various optional options that may affect the matching process; see Matching event listeners for removal.

MDN Reference

Parameters

Parameter	Type
type	string
listener	EventListenerOrEventListenerObject
options?	boolean | EventListenerOptions

Returns

void

Overrides

EventTarget.removeEventListener

---

update()

update(response): Promise<void>;

The update() method of the MediaKeySession interface loads messages and licenses to the CDM, and then returns a Promise.

MDN Reference

Parameters

Parameter	Type
response	BufferSource

Returns

Promise<void>

Properties

closed

readonly closed: Promise<MediaKeySessionClosedReason>;

The closed read-only property of the MediaKeySession interface returns a Promise signaling when a MediaKeySession closes. This promise can only be fulfilled and is never rejected. Closing a session means that licenses and keys associated with it are no longer valid for decrypting media data.

MDN Reference

---

expiration

readonly expiration: number;

The expiration read-only property of the MediaKeySession interface returns the time after which the keys in the current session can no longer be used to decrypt media data, or NaN if no such time exists.

MDN Reference

---

keyStatuses

readonly keyStatuses: MediaKeyStatusMap;

The keyStatuses read-only property of the MediaKeySession interface returns a reference to a read-only MediaKeyStatusMap of the current session's keys and their statuses.

MDN Reference

---

onkeystatuseschange

onkeystatuseschange: ((this, ev) => any) | null;

MDN Reference

---

onmessage

onmessage: ((this, ev) => any) | null;

MDN Reference

---

sessionId

readonly sessionId: string;

The sessionId read-only property of the MediaKeySession interface contains a unique string generated by the content decryption module (CDM) for the current media object and its associated keys or licenses.

MDN Reference