Class: shaka.media.DrmEngine

Constructor

new DrmEngine(playerInterface)

Parameters:
Name Type Description
playerInterface shaka.media.DrmEngine.PlayerInterface
Implements:
Source:

Members

(private, static) KEY_STATUS_BATCH_TIME_ :number

The amount of time, in seconds, we wait to batch up rapid key status changes. This allows us to avoid multiple expiration events in most cases.
Type:
  • number
Source:

(private, static) SESSION_LOAD_TIMEOUT_ :number

The amount of time, in seconds, we wait to consider session loaded even if no key status information is available. This allows us to support browsers/CDMs without key statuses.
Type:
  • number
Source:

(private, non-null) activeSessions_ :Map.<MediaKeySession, shaka.media.DrmEngine.SessionMetaData>

Type:
Source:

(private, non-null) allSessionsLoaded_ :shaka.util.PublicPromise

Type:
Source:

(private, non-null) announcedKeyStatusByKeyId_ :Map.<string, string>

The key statuses most recently announced to other classes. We may have more up-to-date information being collected in this.keyStatusByKeyId_, which has not been batched up and released yet.
Type:
  • Map.<string, string>
Source:

(private, nullable) currentDrmInfo_ :shaka.extern.DrmInfo

Type:
Source:

(private, nullable) expirationTimer_ :shaka.util.Timer

Type:
Source:

(private, non-null) finishedDestroyingPromise_ :shaka.util.PublicPromise

A promise that will only resolve once we have finished destroying ourselves, this is used to ensure that subsequent calls to |destroy| don't resolve before the first call to |destroy|.
Type:
Source:

(private) initialized_ :boolean

Type:
  • boolean
Source:

(private) initialRequestsSent_ :boolean

Type:
  • boolean
Source:

(private) isDestroying_ :boolean

A flag to signal when have started destroying ourselves. This will: 1. Stop later calls to |destroy| from trying to destroy the already destroyed (or currently destroying) DrmEngine. 2. Stop in-progress async operations from continuing.
Type:
  • boolean
Source:

(private, non-null) keyStatusByKeyId_ :Map.<string, string>

The most recent key status information we have. We may not have announced this information to the outside world yet, which we delay to batch up changes and avoid spurious "missing key" errors.
Type:
  • Map.<string, string>
Source:

(private) keyStatusTimer_ :shaka.util.Timer

Type:
Source:

(private, non-null) mediaKeyMessageEvents_ :Array.<!MediaKeyMessageEvent>

Type:
  • Array.<!MediaKeyMessageEvent>
Source:

(private) mediaKeys_ :MediaKeys

Type:
  • MediaKeys
Source:

(private, non-null) offlineSessionIds_ :Array.<string>

Type:
  • Array.<string>
Source:

(private, non-null) supportedTypes_ :Set.<string>

Type:
  • Set.<string>
Source:

(private) usePersistentLicenses_ :boolean

Type:
  • boolean
Source:

Methods

(static) areDrmCompatible(drms1non-null, drms2non-null) → {boolean}

Checks if two DrmInfos can be decrypted using the same key system. Clear content is considered compatible with every key system.
Parameters:
Name Type Description
drms1 Array.<!shaka.extern.DrmInfo>
drms2 Array.<!shaka.extern.DrmInfo>
Source:
Returns:
Type
boolean

(private, static) createDrmInfoFor_(keySystem, config) → {shaka.extern.DrmInfo}

Creates a DrmInfo object describing the settings used to initialize the engine.
Parameters:
Name Type Description
keySystem string
config MediaKeySystemConfiguration
Source:
Returns:
Type
shaka.extern.DrmInfo

(static) defaultInitDataTransform(initDatanon-null, drmInfonullable) → (non-null) {Uint8Array}

Parameters:
Name Type Attributes Description
initData Uint8Array
drmInfo shaka.extern.DrmInfo <nullable>
Source:
Returns:
Type
Uint8Array

(private, static) fillInDrmInfoDefaults_(drmInfo, serversnon-null, advancedConfigsnon-null)

Use |servers| and |advancedConfigs| to fill in missing values in drmInfo that the parser left blank. Before working with any drmInfo, it should be passed through here as it is uncommon for drmInfo to be complete when fetched from a manifest because most manifest formats do not have the required information.
Parameters:
Name Type Description
drmInfo shaka.extern.DrmInfo
servers Map.<string, string>
advancedConfigs Map.<string, shaka.extern.AdvancedDrmConfiguration>
Source:

(static) getCommonDrmInfos(drms1non-null, drms2non-null) → (non-null) {Array.<!shaka.extern.DrmInfo>}

Returns an array of drm infos that are present in both input arrays. If one of the arrays is empty, returns the other one since clear content is considered compatible with every drm info.
Parameters:
Name Type Description
drms1 Array.<!shaka.extern.DrmInfo>
drms2 Array.<!shaka.extern.DrmInfo>
Source:
Returns:
Type
Array.<!shaka.extern.DrmInfo>

(static) isBrowserSupported() → {boolean}

Returns true if the browser has recent EME APIs.
Source:
Returns:
Type
boolean

(static) keySystem(drmInfonullable) → {string}

Parameters:
Name Type Attributes Description
drmInfo shaka.extern.DrmInfo <nullable>
Source:
Returns:
Type
string

(static) probeSupport() → (non-null) {Promise.<!Object.<string, ?shaka.extern.DrmSupportType>>}

Returns a Promise to a map of EME support for well-known key systems.
Source:
Returns:
Type
Promise.<!Object.<string, ?shaka.extern.DrmSupportType>>

(private, static) processDrmInfos_(drmInfosnon-null, licenseServersnon-null, serverCertsnon-null, initDatasnon-null, keyIdsnon-null)

Extract license server, server cert, and init data from |drmInfos|, taking care to eliminate duplicates.
Parameters:
Name Type Description
drmInfos Array.<shaka.extern.DrmInfo>
licenseServers Array.<string>
serverCerts Array.<!Uint8Array>
initDatas Array.<!shaka.extern.InitDataOverride>
keyIds Array.<string>
Source:

(private, static) replaceDrmInfo_(variantsnon-null, keySystemsnon-null)

Replace the drm info used in each variant in |variants| to reflect each key service in |keySystems|.
Parameters:
Name Type Description
variants Array.<shaka.extern.Variant>
keySystems Map.<string, string>
Source:

(private) areAllSessionsLoaded_() → {boolean}

Source:
Returns:
Type
boolean

attach(video) → (non-null) {Promise}

Attach MediaKeys to the video element and start processing events.
Parameters:
Name Type Description
video HTMLMediaElement
Source:
Returns:
Type
Promise

configure(config)

Called by the Player to provide an updated configuration any time it changes. Must be called at least once before init().
Parameters:
Name Type Description
config shaka.extern.DrmConfiguration
Source:

(private) configureClearKey_() → (nullable) {shaka.extern.DrmInfo}

Create a DrmInfo using configured clear keys. The server URI will be a data URI which decodes to a clearkey license.
Source:
See:
Returns:
or null if clear keys are not configured.
Type
shaka.extern.DrmInfo

createOrLoad() → (non-null) {Promise}

Creates the sessions for the init data and waits for them to become ready.
Source:
Returns:
Type
Promise

(private) createTemporarySession_(initDataType, initDatanon-null)

Parameters:
Name Type Description
initDataType string
initData Uint8Array
Source:

(private) delayLicenseRequest_() → {boolean}

Source:
Returns:
Type
boolean

(export) destroy() → (non-null) {Promise}

Request that this object be destroyed, releasing all resources and shutting down all operations. Returns a Promise which is resolved when destruction is complete. This Promise should never be rejected.
Implements:
Source:
Returns:
Type
Promise

(private) destroyNow_()

Destroy this instance of DrmEngine. This assumes that all other checks about "if it should" have passed.
Source:

(private) formatFairPlayRequest_(request)

Formats FairPlay license requests. Modifies the request object.
Parameters:
Name Type Description
request shaka.extern.Request
Source:

getDrmInfo() → (nullable) {shaka.extern.DrmInfo}

Returns the DrmInfo that was used to initialize the current key system.
Source:
Returns:
Type
shaka.extern.DrmInfo

getExpiration() → {number}

Returns the next expiration time, or Infinity.
Source:
Returns:
Type
number

getKeyStatuses() → (non-null) {Object.<string, string>}

Returns the current key statuses.
Source:
Returns:
Type
Object.<string, string>

getSessionIds() → (non-null) {Array.<string>}

Returns the ID of the sessions currently active.
Source:
Returns:
Type
Array.<string>

(private) init_(variantsnon-null) → (non-null) {Promise}

Negotiate for a key system and set up MediaKeys. This will assume that both |usePersistentLicences_| and |offlineSessionIds_| have been properly set.
Parameters:
Name Type Description
variants Array.<shaka.extern.Variant> The variants that we expect to operate with during the drm engine's lifespan of the drm engine.
Source:
Returns:
Resolved if/when a key system has been chosen.
Type
Promise

initForPlayback(variantsnon-null, offlineSessionIdsnon-null) → (non-null) {Promise}

Initialize the drm engine for playback operations.
Parameters:
Name Type Description
variants Array.<shaka.extern.Variant> The variants that we want to support playing.
offlineSessionIds Array.<string>
Source:
Returns:
Type
Promise

initForRemoval(keySystem, licenseServerUri, serverCertificate, audioCapabilitiesnon-null, videoCapabilitiesnon-null) → (non-null) {Promise}

Initializes the drm engine for removing persistent sessions. Only the removeSession(s) methods will work correctly, creating new sessions may not work as desired.
Parameters:
Name Type Description
keySystem string
licenseServerUri string
serverCertificate Uint8Array
audioCapabilities Array.<MediaKeySystemMediaCapability>
videoCapabilities Array.<MediaKeySystemMediaCapability>
Source:
Returns:
Type
Promise

initForStorage(variantsnon-null, usePersistentLicenses) → (non-null) {Promise}

Initialize the drm engine for storing and deleting stored content.
Parameters:
Name Type Description
variants Array.<shaka.extern.Variant> The variants that are going to be stored.
usePersistentLicenses boolean Whether or not persistent licenses should be requested and stored for |manifest|.
Source:
Returns:
Type
Promise

initialized() → {boolean}

Source:
Returns:
Type
boolean

(private) loadOfflineSession_(sessionId) → (non-null) {Promise.<MediaKeySession>}

Parameters:
Name Type Description
sessionId string
Source:
Returns:
Type
Promise.<MediaKeySession>

newInitData(initDataType, initDatanon-null)

Called when new initialization data is encountered. If this data hasn't been seen yet, this will create a new session for it.
Parameters:
Name Type Description
initDataType string
initData Uint8Array
Source:

(private, nullable) onError_()

Source:

(private) onKeyStatusesChange_(eventnon-null)

Parameters:
Name Type Description
event Event
Source:

(private) onPlay_()

Source:

(private) onSessionMessage_(eventnon-null)

Parameters:
Name Type Description
event MediaKeyMessageEvent
Source:

(private) parseFairPlayResponse_(response)

Parse FairPlay license response format. Modifies the response object. This will run after any response filters, so application-specific formats can still be handled by the app.
Parameters:
Name Type Description
response shaka.extern.Response
Source:

(private) pollExpiration_()

Called in an interval timer to poll the expiration times of the sessions. We don't get an event from EME when the expiration updates, so we poll it so we can fire an event when it happens.
Source:

(private) prepareMediaKeyConfigsForVariants_(variantsnon-null) → (non-null) {Map.<string, MediaKeySystemConfiguration>}

Parameters:
Name Type Description
variants Array.<shaka.extern.Variant>
Source:
See:
Returns:
Type
Map.<string, MediaKeySystemConfiguration>

(private) processKeyStatusChanges_()

Source:

(private) queryMediaKeys_(configsByKeySystemnon-null) → (non-null) {Promise}

Parameters:
Name Type Description
configsByKeySystem Map.<string, MediaKeySystemConfiguration> A dictionary of configs, indexed by key system, with an iteration order (insertion order) that reflects the preference for the application.
Source:
Returns:
Resolved if/when a key system has been chosen.
Type
Promise

removeSession(sessionId) → (non-null) {Promise}

Remove an offline session and delete it's data. This can only be called after a successful call to |init|. This will wait until the 'license-release' message is handled. The returned Promise will be rejected if there is an error releasing the license.
Parameters:
Name Type Description
sessionId string
Source:
Returns:
Type
Promise

(private) sendLicenseRequest_(eventnon-null)

Sends a license request.
Parameters:
Name Type Description
event MediaKeyMessageEvent
Source:

setServerCertificate() → (non-null) {Promise}

Sets the server certificate based on the current DrmInfo.
Source:
Returns:
Type
Promise

supportsVariant(variantnon-null) → {boolean}

Check if a variant is likely to be supported by DrmEngine. This will err on the side of being too accepting and may not reject a variant that it will later fail to play.
Parameters:
Name Type Description
variant shaka.extern.Variant
Source:
Returns:
Type
boolean

(private) unpackPlayReadyRequest_(request)

Unpacks PlayReady license requests. Modifies the request object.
Parameters:
Name Type Description
request shaka.extern.Request
Source:

willSupport(contentType) → {boolean}

Check if DrmEngine (as initialized) will likely be able to support the given content type.
Parameters:
Name Type Description
contentType string
Source:
Returns:
Type
boolean

Type Definitions

PlayerInterface

Type:
Properties:
Name Type Description
netEngine shaka.net.NetworkingEngine The NetworkingEngine instance to use. The caller retains ownership.
onError function Called when an error occurs. If the error is recoverable (see shaka.util.Error) then the caller may invoke either StreamingEngine.switch*() or StreamingEngine.seeked() to attempt recovery.
onKeyStatus function Called when key status changes. The argument is a map of hex key IDs to statuses.
onExpirationUpdated function Called when the session expiration value changes.
onEvent function Called when an event occurs that should be sent to the app.
Source:

PlayerInterface

Type:
Properties:
Name Type Description
netEngine shaka.net.NetworkingEngine The NetworkingEngine instance to use. The caller retains ownership.
onError function Called when an error occurs. If the error is recoverable (see shaka.util.Error) then the caller may invoke either StreamingEngine.switch*() or StreamingEngine.seeked() to attempt recovery.
onKeyStatus function Called when key status changes. The argument is a map of hex key IDs to statuses.
onExpirationUpdated function Called when the session expiration value changes.
onEvent function Called when an event occurs that should be sent to the app.
Source:

SessionMetaData

A record to track sessions and suppress duplicate init data.
Type:
Properties:
Name Type Description
loaded boolean True once the key status has been updated (to a non-pending state). This does not mean the session is 'usable'.
initData Uint8Array The init data used to create the session.
session MediaKeySession The session object.
oldExpiration number The expiration of the session on the last check. This is used to fire an event when it changes.
updatePromise shaka.util.PublicPromise An optional Promise that will be resolved/rejected on the next update() call. This is used to track the 'license-release' message when calling remove().
Source:

SessionMetaData

A record to track sessions and suppress duplicate init data.
Type:
Properties:
Name Type Description
loaded boolean True once the key status has been updated (to a non-pending state). This does not mean the session is 'usable'.
initData Uint8Array The init data used to create the session.
session MediaKeySession The session object.
oldExpiration number The expiration of the session on the last check. This is used to fire an event when it changes.
updatePromise shaka.util.PublicPromise An optional Promise that will be resolved/rejected on the next update() call. This is used to track the 'license-release' message when calling remove().
Source: