kotlin-browser/web.mediakey/MediaKeySession

MediaKeySession

class MediaKeySession : EventTarget(source)

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

Properties

closed

val closed: Promise<MediaKeySessionClosedReason>

The closed read-only property of the MediaKeySession interface returns a Promise signaling when a MediaKeySession closes.

expiration

val expiration: EpochTimeStamp

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.

keyStatuses

val 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.

keyStatusesChangeEvent

val MediaKeySession.keyStatusesChangeEvent: EventInstance<Event, MediaKeySession, MediaKeySession>

MDN Reference

messageEvent

val MediaKeySession.messageEvent: EventInstance<MediaKeyMessageEvent, MediaKeySession, MediaKeySession>

MDN Reference

onkeystatuseschange

var onkeystatuseschange: EventHandler<Event, MediaKeySession, MediaKeySession>?

MDN Reference

onmessage

var onmessage: EventHandler<MediaKeyMessageEvent, MediaKeySession, MediaKeySession>?

MDN Reference

sessionId

val 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.

Functions

inline suspend fun MediaKeySession.close()

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.

closeAsync

fun closeAsync(): Promise<Void>

dispatchEvent

fun dispatchEvent(event: Event): Boolean

generateRequest

inline suspend fun MediaKeySession.generateRequest(initDataType: String, initData: BufferSource)

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

generateRequestAsync

fun generateRequestAsync(initDataType: String, initData: BufferSource): Promise<Void>

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

load

inline suspend fun MediaKeySession.load(sessionId: String): 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.

loadAsync

fun loadAsync(sessionId: String): Promise<JsBoolean>

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

remove

inline suspend fun MediaKeySession.remove()

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

removeAsync

fun removeAsync(): Promise<Void>

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

update

inline suspend fun MediaKeySession.update(response: BufferSource)

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

updateAsync

fun updateAsync(response: BufferSource): Promise<Void>

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

when

fun <T : Event> when(type: EventType<T>, options: ObservableEventListenerOptions?): Observable<T>