THEOplayer Web SDK
    Preparing search index...

    Interface XstreamDRMConfiguration

    Describes the configuration of the Xstream DRM integration.

    const drmConfiguration = {
        integration : 'xstream',
        sessionId: 'yourSessionId',
        streamId: 'yourStreamId'
        fairplay: {
             licenseAcquisitionURL: 'yourLicenseAcquisitionURL'
             certificateURL: 'yourCertificateAcquisitionURL'
        },
    }
    interface XstreamDRMConfiguration {
        aes128?: AES128KeySystemConfiguration;
        clearkey?: ClearkeyKeySystemConfiguration;
        fairplay?: FairPlayKeySystemConfiguration;
        integration: "xstream";
        integrationParameters?: { [parameterName: string]: any };
        playready?: PlayReadyKeySystemConfiguration;
        preferredKeySystems?: (KeySystemId | string & {})[];
        queryParameters?: { [key: string]: any };
        sessionId: string;
        streamId: string;
        ticketAcquisitionURL: string;
        useOipfDrmAgent?: boolean;
        widevine?: KeySystemConfiguration;
    }

    Hierarchy (View Summary)

    Index

    Properties

    aes128? clearkey? fairplay? integration integrationParameters? playready? preferredKeySystems? queryParameters? sessionId streamId ticketAcquisitionURL useOipfDrmAgent? widevine?

    Properties

    aes128?: AES128KeySystemConfiguration

    The configuration of the AES key system.

    clearkey?: ClearkeyKeySystemConfiguration

    The configuration of the ClearKey key system.

    fairplay?: FairPlayKeySystemConfiguration

    The configuration of the FairPlay key system.

    integration: "xstream"

    The identifier of the DRM integration.

    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.

    playready?: PlayReadyKeySystemConfiguration

    The configuration of the PlayReady key system.

    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'].

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

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


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

    sessionId: string

    The identifier of the session.

    streamId: string

    The identifier of the stream.

    ticketAcquisitionURL: string

    The ticket acquisition URL.

    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.

    widevine?: KeySystemConfiguration

    The configuration of the Widevine key system.

    Settings

    Member Visibility

    On This Page

    Properties