Interface DRMConfiguration

Describes the configuration of the DRM.

interface DRMConfiguration {
    aes128?: AES128KeySystemConfiguration;
    clearkey?: ClearkeyKeySystemConfiguration;
    fairplay?: FairPlayKeySystemConfiguration;
    integration?: string;
    integrationParameters?: {
        [parameterName: string]: any;
    };
    playready?: PlayReadyKeySystemConfiguration;
    preferredKeySystems?: string[];
    queryParameters?: {
        [key: string]: any;
    };
    widevine?: KeySystemConfiguration;
}

Properties

aes128? clearkey? fairplay? integration? integrationParameters? playready? preferredKeySystems? queryParameters? widevine?

Properties

Optional aes128

aes128?: AES128KeySystemConfiguration

The configuration of the AES key system.

Optional clearkey

clearkey?: ClearkeyKeySystemConfiguration

The configuration of the ClearKey key system.

Optional fairplay

fairplay?: FairPlayKeySystemConfiguration

The configuration of the FairPlay key system.

Optional integration

integration?: string

The identifier of the DRM integration.

Optional integrationParameters

integrationParameters?: {
    [parameterName: string]: any;
}

An object of key/value pairs which can be used to pass in specific parameters related to a source into a ContentProtectionIntegration.

Type declaration

  • [parameterName: string]: any

Optional playready

playready?: PlayReadyKeySystemConfiguration

The configuration of the PlayReady key system.

Optional preferredKeySystems

preferredKeySystems?: string[]

An ordered list of URNs of key systems as specified by https://dashif.org/identifiers/content_protection/, or one of the following identifiers:

"widevine" alias for "urn:uuid:edef8ba9-79d6-4ace-a3c8-27dcd51d21ed" "fairplay" alias for "urn:uuid:94ce86fb-07bb-4b43-adb8-93d2fa968ca2" "playready" alias for "urn:uuid:9a04f079-9840-4286-ab92-e65be0885f95"

The first key system in this list which is supported on the given platform will be used for playback.

Default value is ['widevine', 'playready', 'fairplay'].

Optional queryParameters

queryParameters?: {
    [key: string]: any;
}

Record of default query parameters for the license acquisition request. Each entry contains a query parameter name with associated value.

Type declaration

  • [key: string]: any

Remarks

These parameters will be merged with any query parameters specified in the individual key system configurations, with the latter taking precedence.

Optional widevine

widevine?: KeySystemConfiguration

The configuration of the Widevine key system.

Settings

Member Visibility

Theme

On This Page

aes128clearkeyfairplayintegrationintegrationParametersplayreadypreferredKeySystemsqueryParameterswidevine