MediaKeySession

This article needs a technical review. How you can help.

This is an experimental technology
Because this technology's specification has not stabilized, check the compatibility table for usage in various browsers. Also note that the syntax and behavior of an experimental technology is subject to change in future versions of browsers as the specification changes.

The MediaKeySession interface of the EncryptedMediaExtensions API represents a context for message exchange with a content decryption module (CDM).

Properties

MediaKeySession.closed Read only
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. 
MediaKeySession.expiration Read only
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. This value is determined by the CDM and measured in milliseconds since January 1, 1970, UTC. This value may change during a session lifetime, such as when an action triggers the start of a window.
MediaKeySession.keyStatuses Read only
Contains a reference to a read-only MediaKeyStatusMap of the current session's keys and their statuses.
MediaKeySession.sessionId Read only
Contains a unique string generated by the CDM for the current media object and its associated keys or licenses.

Event handlers

MediaKeySession.onkeystatuseschange
Sets the EventHandler called when there has been a change in the keys in a session or their statuses.
MediaKeySession.onmessage
Sets the EventHandler called when the content decryption module has generated a message for the session.

Methods

MediaKeySession.close()

Returns a Promise after notifying the current media session is no longer needed and that the CDM should release any resources associated with this object and close it.

MediaKeySession.generateRequest()
Returns a Promise after generating a media request based on initialization data.
MediaKeySession.load()
Returns a Promise that resolves to a boolean value after loading data for a specified session object. 
MediaKeySession.remove()
Returns a Promise after removing any session data associated with the current object.
MediaKeySession.update()
Returns a Promise after loading messages and licenses to the CDM.

Examples

// TBD

Specifications

Specification Status Comment
Encrypted Media Extensions
The definition of 'MediaKeySession' in that specification.
Working Draft Initial definition.

Browser compatibility

Feature Chrome Edge Firefox (Gecko) Internet Explorer Opera Safari (WebKit)
Basic support 42.0 (Yes) ? ? (Yes) ?
onkeystatuseschange and onmessage 55.0 ? ? ? 42 ?
Feature Android Android Webview Edge Firefox Mobile (Gecko) Firefox OS IE Mobile Opera Mobile Safari Mobile Chrome for Android
Basic support No support 43.0 (Yes) ? ? ? (Yes) ? 42.0
onkeystatuseschange and onmessage No support 55.0 ? ? ? ? 42 ? 55.0

Document Tags and Contributors

 Contributors to this page: libbymc, jpmedley, Sebastianz, kscarfone
 Last updated by: libbymc,