import EMEController from 'hls.js/src/controller/eme-controller.ts'

public class | source

EMEController

Controller to deal with encrypted media extensions (EME)

Static Member Summary

Static Public Members
public static	CDMCleanupPromise: *

Constructor Summary

Public Constructor
public	constructor()

Member Summary

Public Members
public	config: EMEControllerConfig
public	error: *
public	hls: Hls
public	keyFormatPromise: *
public	keyIdToKeySessionPromise: *
public	keySystemAccessPromises: *
public	log: *
public	media: *
public	mediaKeySessions: *
public	onMediaEncrypted: *
public	onWaitingForKey: *
public	setMediaKeysQueue: *
public	warn: *

Private Members
private	_requestLicenseFailureCount: number

Method Summary

Public Methods
public	attemptKeySystemAccess(keySystemsToAttempt: undefined): Promise
public	attemptSetMediaKeys(keySystem: KeySystems, mediaKeys: MediaKeys): Promise
public	createMediaKeySessionContext(undefined: undefined): MediaKeySessionContext
public	destroy()
public	fetchServerCertificate(keySystem: KeySystems): Promise
public	generateLicenseRequestChallenge(keySessionContext: MediaKeySessionContext, keyMessage: ArrayBuffer): *
public	generateRequestWithPreferredKeySession(context: MediaKeySessionContext, initDataType: string, initData: undefined): *
public	getKeyFormatPromise(keyFormats: undefined): Promise
public	getKeyIdString(decryptdata: undefined): *
public	getKeySystemForKeyPromise(decryptdata: LevelKey): Promise
public	getKeySystemSelectionPromise(keySystemsToAttempt: undefined): Promise
public	getLicenseServerUrl(keySystem: KeySystems): *
public	getMediaKeysPromise(keySystem: KeySystems, audioCodecs: undefined, videoCodecs: undefined): Promise
public	getServerCertificateUrl(keySystem: KeySystems): *
public	handleError(error: undefined)
public	handleParsedKeyResponse(mediaKeySessionContext: MediaKeySessionContext, licenseResponse: ArrayBuffer): Uint8Array
public	loadKey(data: KeyLoadedData): Promise
public	onKeyStatusChange(mediaKeySessionContext: MediaKeySessionContext)
public	onManifestLoaded(event: undefined, undefined: ManifestLoadedData)
public	onMediaAttached(event: undefined, data: MediaAttachedData)
public	onMediaDetached()
public	registerListeners()
public	removeSession(mediaKeySessionContext: MediaKeySessionContext): *
public	renewKeySession(mediaKeySessionContext: MediaKeySessionContext)
public	renewLicense(context: MediaKeySessionContext, keyMessage: ArrayBuffer): Promise
public	requestLicense(keySessionContext: MediaKeySessionContext, licenseChallenge: Uint8Array): Promise
public	requestMediaKeySystemAccess(keySystem: KeySystems, supportedConfigurations: undefined): Promise
public	selectKeySystemFormat(frag: Fragment): Promise
public	setMediaKeysServerCertificate(mediaKeys: MediaKeys, keySystem: KeySystems, cert: BufferSource): Promise
public	setupLicenseXHR(xhr: XMLHttpRequest, url: string, keysListItem: MediaKeySessionContext, licenseChallenge: Uint8Array): Promise
public	throwIfDestroyed(message: undefined)
public	unregisterListeners()
public	updateKeySession(mediaKeySessionContext: MediaKeySessionContext, data: Uint8Array): Promise

Private Methods
private	_onMediaEncrypted(event: MediaEncryptedEvent)
private	_onWaitingForKey(event: Event)

Static Public Members

public static CDMCleanupPromise: * source

Public Constructors

public constructor() source

Public Members

public config: EMEControllerConfig source

public error: * source

public hls: Hls source

public keyFormatPromise: * source

public keyIdToKeySessionPromise: * source

public keySystemAccessPromises: * source

public log: * source

public media: * source

public mediaKeySessions: * source

public onMediaEncrypted: * source

public onWaitingForKey: * source

public setMediaKeysQueue: * source

public warn: * source

Private Members

private _requestLicenseFailureCount: number source

Public Methods

public attemptKeySystemAccess(keySystemsToAttempt: undefined): Promise source

Params:

Name	Type	Attribute	Description
keySystemsToAttempt	undefined

Return:

Promise

public attemptSetMediaKeys(keySystem: KeySystems, mediaKeys: MediaKeys): Promise source

Params:

Name	Type	Attribute	Description
keySystem	KeySystems
mediaKeys	MediaKeys

Return:

Promise

public createMediaKeySessionContext(undefined: undefined): MediaKeySessionContext source

Params:

Name	Type	Attribute	Description
undefined	undefined

Return:

MediaKeySessionContext

public destroy() source

public fetchServerCertificate(keySystem: KeySystems): Promise source

Params:

Name	Type	Attribute	Description
keySystem	KeySystems

Return:

Promise

public generateLicenseRequestChallenge(keySessionContext: MediaKeySessionContext, keyMessage: ArrayBuffer): * source

Params:

Name	Type	Attribute	Description
keySessionContext	MediaKeySessionContext
keyMessage	ArrayBuffer

Return:

public generateRequestWithPreferredKeySession(context: MediaKeySessionContext, initDataType: string, initData: undefined): * source

Params:

Name	Type	Attribute	Description
context	MediaKeySessionContext
initDataType	string
initData	undefined

Return:

public getKeyFormatPromise(keyFormats: undefined): Promise source

Params:

Name	Type	Attribute	Description
keyFormats	undefined

Return:

Promise

public getKeyIdString(decryptdata: undefined): * source

Params:

Name	Type	Attribute	Description
decryptdata	undefined

Return:

public getKeySystemForKeyPromise(decryptdata: LevelKey): Promise source

Params:

Name	Type	Attribute	Description
decryptdata	LevelKey

Return:

Promise

public getKeySystemSelectionPromise(keySystemsToAttempt: undefined): Promise source

Params:

Name	Type	Attribute	Description
keySystemsToAttempt	undefined

Return:

Promise

public getLicenseServerUrl(keySystem: KeySystems): * source

Params:

Name	Type	Attribute	Description
keySystem	KeySystems

Return:

public getMediaKeysPromise(keySystem: KeySystems, audioCodecs: undefined, videoCodecs: undefined): Promise source

Params:

Name	Type	Attribute	Description
keySystem	KeySystems
audioCodecs	undefined
videoCodecs	undefined

Return:

Promise

public getServerCertificateUrl(keySystem: KeySystems): * source

Params:

Name	Type	Attribute	Description
keySystem	KeySystems

Return:

public handleError(error: undefined) source

Params:

Name	Type	Attribute	Description
error	undefined

public handleParsedKeyResponse(mediaKeySessionContext: MediaKeySessionContext, licenseResponse: ArrayBuffer): Uint8Array source

Params:

Name	Type	Attribute	Description
mediaKeySessionContext	MediaKeySessionContext
licenseResponse	ArrayBuffer

Return:

Uint8Array

public loadKey(data: KeyLoadedData): Promise source

Params:

Name	Type	Attribute	Description
data	KeyLoadedData

Return:

Promise

public onKeyStatusChange(mediaKeySessionContext: MediaKeySessionContext) source

Params:

Name	Type	Attribute	Description
mediaKeySessionContext	MediaKeySessionContext

public onManifestLoaded(event: undefined, undefined: ManifestLoadedData) source

Params:

Name	Type	Attribute	Description
event	undefined
undefined	ManifestLoadedData

public onMediaAttached(event: undefined, data: MediaAttachedData) source

Params:

Name	Type	Attribute	Description
event	undefined
data	MediaAttachedData

public onMediaDetached() source

public registerListeners() source

public removeSession(mediaKeySessionContext: MediaKeySessionContext): * source

Params:

Name	Type	Attribute	Description
mediaKeySessionContext	MediaKeySessionContext

Return:

public renewKeySession(mediaKeySessionContext: MediaKeySessionContext) source

Params:

Name	Type	Attribute	Description
mediaKeySessionContext	MediaKeySessionContext

public renewLicense(context: MediaKeySessionContext, keyMessage: ArrayBuffer): Promise source

Params:

Name	Type	Attribute	Description
context	MediaKeySessionContext
keyMessage	ArrayBuffer

Return:

Promise

public requestLicense(keySessionContext: MediaKeySessionContext, licenseChallenge: Uint8Array): Promise source

Params:

Name	Type	Attribute	Description
keySessionContext	MediaKeySessionContext
licenseChallenge	Uint8Array

Return:

Promise

public requestMediaKeySystemAccess(keySystem: KeySystems, supportedConfigurations: undefined): Promise source

Params:

Name	Type	Attribute	Description
keySystem	KeySystems
supportedConfigurations	undefined

Return:

Promise

public selectKeySystemFormat(frag: Fragment): Promise source

Params:

Name	Type	Attribute	Description
frag	Fragment

Return:

Promise

public setMediaKeysServerCertificate(mediaKeys: MediaKeys, keySystem: KeySystems, cert: BufferSource): Promise source

Params:

Name	Type	Attribute	Description
mediaKeys	MediaKeys
keySystem	KeySystems
cert	BufferSource

Return:

Promise

public setupLicenseXHR(xhr: XMLHttpRequest, url: string, keysListItem: MediaKeySessionContext, licenseChallenge: Uint8Array): Promise source

Params:

Name	Type	Attribute	Description
xhr	XMLHttpRequest
url	string
keysListItem	MediaKeySessionContext
licenseChallenge	Uint8Array

Return:

Promise

public throwIfDestroyed(message: undefined) source

Params:

Name	Type	Attribute	Description
message	undefined

public unregisterListeners() source

public updateKeySession(mediaKeySessionContext: MediaKeySessionContext, data: Uint8Array): Promise source

Params:

Name	Type	Attribute	Description
mediaKeySessionContext	MediaKeySessionContext
data	Uint8Array

Return:

Promise

Private Methods

private _onMediaEncrypted(event: MediaEncryptedEvent) source

Params:

Name	Type	Attribute	Description
event	MediaEncryptedEvent

private _onWaitingForKey(event: Event) source

Params:

Name	Type	Attribute	Description
event	Event