Interface MediaKeySession

This EncryptedMediaExtensions API interface represents a context for message exchange with a content decryption module (CDM). Available only in secure contexts.

MDN Reference

interface MediaKeySession {
    $destroyListeners?: any[];
    closed: Promise<MediaKeySessionClosedReason>;
    expiration: number;
    keyStatuses: MediaKeyStatusMap;
    onkeystatuseschange: Object;
    onmessage: Object;
    sessionId: string;
    addEventListener<K>(type, listener, options?): void;
    addEventListener(type, listener, options?): void;
    close(): Promise<void>;
    dispatchEvent(event): boolean;
    generateRequest(initDataType, initData): Promise<void>;
    load(sessionId): Promise<boolean>;
    remove(): Promise<void>;
    removeEventListener<K>(type, listener, options?): void;
    removeEventListener(type, listener, options?): void;
    update(response): Promise<void>;
}

Hierarchy

Properties

$destroyListeners? closed expiration keyStatuses onkeystatuseschange onmessage sessionId

Methods

addEventListener close dispatchEvent generateRequest load remove removeEventListener update

Properties

Optional $destroyListeners

$destroyListeners?: any[]

Readonly closed

closed: Promise<MediaKeySessionClosedReason>

MDN Reference

Readonly expiration

expiration: number

MDN Reference

Readonly keyStatuses

keyStatuses: MediaKeyStatusMap

MDN Reference

onkeystatuseschange

onkeystatuseschange: Object

MDN Reference

onmessage

onmessage: Object

MDN Reference

Readonly sessionId

sessionId: string

MDN Reference

Methods

addEventListener

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

  • Type Parameters

    Parameters

    Returns void

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

  • Parameters

    Returns void

close

dispatchEvent

  • dispatchEvent(event): boolean

  • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

    MDN Reference

    Parameters

    Returns boolean

generateRequest

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

  • MDN Reference

    Parameters

    Returns Promise<void>

load

  • load(sessionId): Promise<boolean>

  • MDN Reference

    Parameters

    • sessionId: string

    Returns Promise<boolean>

remove

removeEventListener

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

  • Type Parameters

    Parameters

    Returns void

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

  • Parameters

    Returns void

update

Settings

Member Visibility

Theme

On This Page

$destroyListenersclosedexpirationkeyStatusesonkeystatuseschangeonmessagesessionIdaddEventListenerclosedispatchEventgenerateRequestloadremoveremoveEventListenerupdate