Interface MediaKeySession

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

interface MediaKeySession {
    closed: Promise<MediaKeySessionClosedReason>;
    expiration: number;
    keyStatuses: MediaKeyStatusMap;
    onkeystatuseschange: ((this, ev) => any);
    onmessage: ((this, ev) => any);
    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

  • EventTarget
    • MediaKeySession

Properties

closed expiration keyStatuses onkeystatuseschange onmessage sessionId

Methods

addEventListener close dispatchEvent generateRequest load remove removeEventListener update

Properties

Readonly closed

closed: Promise<MediaKeySessionClosedReason>

Readonly expiration

expiration: number

Readonly keyStatuses

keyStatuses: MediaKeyStatusMap

onkeystatuseschange

onkeystatuseschange: ((this, ev) => any)

Type declaration

onmessage

onmessage: ((this, ev) => any)

Type declaration

Readonly sessionId

sessionId: string

Methods

addEventListener

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

  • Type Parameters

    Parameters

    Returns void

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

  • Parameters

    Returns void

close

  • close(): Promise<void>

  • Returns Promise<void>

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.

    Parameters

    • event: Event

    Returns boolean

generateRequest

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

  • Parameters

    Returns Promise<void>

load

  • load(sessionId): Promise<boolean>

  • Parameters

    • sessionId: string

    Returns Promise<boolean>

remove

  • remove(): Promise<void>

  • Returns Promise<void>

removeEventListener

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

  • Type Parameters

    Parameters

    Returns void

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

  • Parameters

    Returns void

update

  • update(response): Promise<void>

  • Parameters

    Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc