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?: (KeySystemId | string & {})[];
    useOipfDrmAgent?: boolean;
    widevine?: KeySystemConfiguration;
}

Hierarchy (view full)

Properties

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

Properties

Optionalaes128

aes128?: AES128KeySystemConfiguration

The configuration of the AES key system.

Optionalclearkey

clearkey?: ClearkeyKeySystemConfiguration

The configuration of the ClearKey key system.

Optionalfairplay

fairplay?: FairPlayKeySystemConfiguration

The configuration of the FairPlay key system.

Optionalintegration

integration?: string

The identifier of the DRM integration.

OptionalintegrationParameters

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.

Optionalplayready

playready?: PlayReadyKeySystemConfiguration

The configuration of the PlayReady key system.

OptionalpreferredKeySystems

preferredKeySystems?: (KeySystemId | 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'].

OptionaluseOipfDrmAgent

useOipfDrmAgent?: boolean

A flag that affects HbbTV enabled devices and indicates whether the OIPF DRM agent should be used for handling DRM protection, even when EME is available.

Default value is false.

Optionalwidevine

widevine?: KeySystemConfiguration

The configuration of the Widevine key system.

Settings

Member Visibility

On This Page

Properties