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

public class | source

EMEController

Extends:

EventHandler → EMEController

Controller to deal with encrypted media extensions (EME)

See:

https://developer.mozilla.org/en-US/docs/Web/API/Encrypted_Media_Extensions_API

Constructor Summary

Public Constructor
public	constructor(hls: Hls)

Member Summary

Public Members
public get	requestMediaKeySystemAccess: *

Private Members
private	_emeEnabled: *
private	_hasSetMediaKeys: boolean
private	_isMediaEncrypted: boolean
private	_licenseXhrSetup: *
private	_media: *
private	_mediaEncryptionInitData: *
private	_mediaEncryptionInitDataType: *
private	_mediaKeysList: *[]
private	_requestLicenseFailureCount: number
private	_requestMediaKeySystemAccess: *
private	_widevineLicenseUrl: *

Method Summary

Public Methods
public	getLicenseServerUrl(keySystem: string): string
public	onManifestParsed(data: *)
public	onMediaAttached(data: *)

Private Methods
private	_attemptKeySystemAccess(keySystem: string, audioCodecs: Array<string>, videoCodecs: Array<string>) Requests access object and adds it to our list upon success
private	_attemptSetMediaKeys()
private	_createLicenseXhr(url: string, keyMessage: ArrayBuffer, callback: function): XMLHttpRequest
private	_generateLicenseRequestChallenge(keysListItem: object, keyMessage: ArrayBuffer): ArrayBuffer
private	_generateRequestWithPreferredKeySession()
private	_onKeySessionMessage(keySession: , message: )
private	_onLicenseRequestReadyStageChange(xhr: XMLHttpRequest, url: string, keyMessage: ArrayBuffer, callback: function)
private	_onMediaEncrypted(initDataType: , initData: )
private	_onMediaKeySystemAccessObtained(keySystem: string, mediaKeySystemAccess: MediaKeySystemAccess) Handles obtaining access to a key-system
private	_onMediaKeysCreated() Handles key-creation (represents access to CDM).
private	_onNewMediaKeySession(keySession: *)
private	_requestLicense(keyMessage: , callback: )

Inherited Summary

From class EventHandler
public	handledEvents: *
public	hls: *
public	useGenericHandler: boolean
public	destroy()
public	isEventHandler(): *
public	onEvent(event: , data: ) arguments: event (string), data (any)
public	onEventGeneric(event: , data: )
public	onHandlerDestroyed()
public	onHandlerDestroying()
public	registerListeners()
public	unregisterListeners()

Public Constructors

public constructor(hls: Hls) source

Override:

EventHandler#constructor

Params:

Name	Type	Attribute	Description
hls	Hls		Our Hls.js instance

Public Members

public get requestMediaKeySystemAccess: * source

Private Members

private _emeEnabled: * source

private _hasSetMediaKeys: boolean source

private _isMediaEncrypted: boolean source

private _licenseXhrSetup: * source

private _media: * source

private _mediaEncryptionInitData: * source

private _mediaEncryptionInitDataType: * source

private _mediaKeysList: *[] source

private _requestLicenseFailureCount: number source

private _requestMediaKeySystemAccess: * source

private _widevineLicenseUrl: * source

Public Methods

public getLicenseServerUrl(keySystem: string): string source

Params:

Name	Type	Attribute	Description
keySystem	string		Identifier for the key-system, see `KeySystems` enum

Return:

string

License server URL for key-system (if any configured, otherwise causes error)

public onManifestParsed(data: *) source

Params:

Name	Type	Attribute	Description
data	*

public onMediaAttached(data: *) source

Params:

Name	Type	Attribute	Description
data	*

Private Methods

private _attemptKeySystemAccess(keySystem: string, audioCodecs: Array<string>, videoCodecs: Array<string>) source

Requests access object and adds it to our list upon success

Params:

Name	Type	Attribute	Description
keySystem	string		System ID (see `KeySystems`)
audioCodecs	Array<string>		List of required audio codecs to support
videoCodecs	Array<string>		List of required video codecs to support

private _attemptSetMediaKeys() source

private _createLicenseXhr(url: string, keyMessage: ArrayBuffer, callback: function): XMLHttpRequest source

Params:

Name	Type	Attribute	Description
url	string		License server URL
keyMessage	ArrayBuffer		Message data issued by key-system
callback	function		Called when XHR has succeeded

Return:

XMLHttpRequest

Unsent (but opened state) XHR object

private _generateLicenseRequestChallenge(keysListItem: object, keyMessage: ArrayBuffer): ArrayBuffer source

Params:

Name	Type	Attribute	Description
keysListItem	object
keyMessage	ArrayBuffer

Return:

ArrayBuffer

Challenge data posted to license server

private _generateRequestWithPreferredKeySession() source

private _onKeySessionMessage(keySession: , message: ) source

Params:

Name	Type	Attribute	Description
keySession	*
message	*

private _onLicenseRequestReadyStageChange(xhr: XMLHttpRequest, url: string, keyMessage: ArrayBuffer, callback: function) source

Params:

Name	Type	Attribute	Description
xhr	XMLHttpRequest
url	string		License server URL
keyMessage	ArrayBuffer		Message data issued by key-system
callback	function		Called when XHR has succeeded

private _onMediaEncrypted(initDataType: , initData: ) source

Params:

Name	Type	Attribute	Description
initDataType	*
initData	*

private _onMediaKeySystemAccessObtained(keySystem: string, mediaKeySystemAccess: MediaKeySystemAccess) source

Handles obtaining access to a key-system

Params:

Name	Type	Attribute	Description
keySystem	string
mediaKeySystemAccess	MediaKeySystemAccess		https://developer.mozilla.org/en-US/docs/Web/API/MediaKeySystemAccess

private _onMediaKeysCreated() source

Handles key-creation (represents access to CDM). We are going to create key-sessions upon this for all existing keys where no session exists yet.

private _onNewMediaKeySession(keySession: *) source

Params:

Name	Type	Attribute	Description
keySession	*

private _requestLicense(keyMessage: , callback: ) source

Params:

Name	Type	Attribute	Description
keyMessage	*
callback	*

EMEController

Extends:

See:

Constructor Summary

Member Summary

Method Summary

Inherited Summary

Public Constructors

public constructor(hls: Hls) source

Override:

Params:

Public Members

public get requestMediaKeySystemAccess: * source

Private Members

private _emeEnabled: * source

private _hasSetMediaKeys: boolean source

private _isMediaEncrypted: boolean source

private _licenseXhrSetup: * source

private _media: * source

private _mediaEncryptionInitData: * source

private _mediaEncryptionInitDataType: * source

private _mediaKeysList: *[] source

private _requestLicenseFailureCount: number source

private _requestMediaKeySystemAccess: * source

private _widevineLicenseUrl: * source

Public Methods

public getLicenseServerUrl(keySystem: string): string source

Params:

Return:

public onManifestParsed(data: *) source

Params:

public onMediaAttached(data: *) source

Params:

Private Methods

private _attemptKeySystemAccess(keySystem: string, audioCodecs: Array<string>, videoCodecs: Array<string>) source

Params:

private _attemptSetMediaKeys() source

private _createLicenseXhr(url: string, keyMessage: ArrayBuffer, callback: function): XMLHttpRequest source

Params:

Return:

private _generateLicenseRequestChallenge(keysListItem: object, keyMessage: ArrayBuffer): ArrayBuffer source

Params:

Return:

private _generateRequestWithPreferredKeySession() source

private _onKeySessionMessage(keySession: *, message: *) source

Params:

private _onLicenseRequestReadyStageChange(xhr: XMLHttpRequest, url: string, keyMessage: ArrayBuffer, callback: function) source

Params:

private _onMediaEncrypted(initDataType: *, initData: *) source

Params:

private _onMediaKeySystemAccessObtained(keySystem: string, mediaKeySystemAccess: MediaKeySystemAccess) source

Params:

private _onMediaKeysCreated() source

private _onNewMediaKeySession(keySession: *) source

Params:

private _requestLicense(keyMessage: *, callback: *) source

Params:

private _onKeySessionMessage(keySession: , message: ) source

private _onMediaEncrypted(initDataType: , initData: ) source

private _requestLicense(keyMessage: , callback: ) source