Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface PlayReadyDRMConfig

Hierarchy

  • PlayReadyDRMConfig

Index

Properties

Optional LA_URL

LA_URL: undefined | string

An URL to the PlayReady license server for this content (optional). Can be defined in the configuration or taken out from the video manifest if defined there. If the config URL is defined it has precedence over the URL defined in the manifest.

Optional customData

customData: undefined | string

A custom data string sent along with the license request. This is only supported in browsers using the legacy Microsoft prefixed EME (IE, Edge legacy).

Optional forceSSL

forceSSL: undefined | false | true

Specifies whether to upgrade all license requests to use SSL.

Optional headers

headers: HttpHeaders

An object which specifies custom HTTP headers.

DRMtoday by castLabs Specific Example:

headers : {
  'dt-custom-data': 'INSERT-YOUR-BASE64-ENCODED-CUSTOMDATA'
}

Optional licenseRequestRetryDelay

licenseRequestRetryDelay: undefined | number

Specifies how long in milliseconds should be waited before a license request should be retried.

Optional maxLicenseRequestRetries

maxLicenseRequestRetries: undefined | number

Specifies how often a license request should be retried if was not successful (e.g. the license server was not reachable). Default is 1. 0 disables retries.

Optional mediaKeySystemConfig

mediaKeySystemConfig: MediaKeySystemConfiguration

An object which allows to specify configuration options of the DRM key system, such as distinctiveIdentifier or persistentState (refer to MediaKeySystemConfiguration for more details). Please note that these settings need to be supported by the browser or playback will fail.

Optional plaintextChallenge

plaintextChallenge: undefined | false | true

Specifies, whether the Challenge specified in the keymessage is provided in plaintext rather than being Base64 encoded.

On most desktop browsers, the Challenge is Base64 encoded, which requires additional preprocessing before a license request can be sent. Devices like smart TVs or set-top boxes often already provide a plaintext challenge in the key message, so the preprocessing step can be skipped. Default value is false.

Optional utf8message

utf8message: undefined | false | true

Specifies, whether the keymessage provided by the browser is already UTF-8 encoded.

On most desktop browsers, the keymessage is UTF-16 encoded, which requires additional preprocessing before a license request can be sent. Devices like smart TVs or set-top boxes often already provide a UTF-8 encoded key messages, so the preprocessing step can be skipped. Default value is false.

Optional withCredentials

withCredentials: undefined | false | true

Set to true to send credentials such as cookies or authorization headers along with the license requests. Default is false.

Generated using TypeDoc