Bitmovin Player API 8.268.0
    Preparing search index...

    Interface TVKeyDRMConfig

    interface TVKeyDRMConfig {
        headers?: HttpHeaders;
        keySystemPriority?: string[];
        LA_URL?: string;
        licenseRequestRetryDelay?: number;
        maxLicenseRequestRetries?: number;
        mediaKeySystemConfig?: MediaKeySystemConfiguration;
        prepareLicense?: (licenseObject: any) => any;
        prepareMessage?: (keyMessage: any) => any;
        withCredentials?: boolean;
    }
    Index
    headers? keySystemPriority? LA_URL? licenseRequestRetryDelay? maxLicenseRequestRetries? mediaKeySystemConfig? prepareLicense? prepareMessage? withCredentials?
    headers?: HttpHeaders

    An object which specifies custom HTTP headers.

    Example:

    headers: {
      'Authorization': 'Bearer Here'
    }
    keySystemPriority?: string[]

    Specify the priority of TVKey DRM key system strings for this source. Non-specified strings which the player knows will be put at the end of the list. The player will use the first key system string from this list that is supported on the current platform.

    LA_URL?: string

    A URL to the TVKey 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.

    licenseRequestRetryDelay?: number

    Specifies how long (in milliseconds) it should be waited before a license request is retried.

    maxLicenseRequestRetries?: number

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

    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 otherwise playback will fail.

    prepareLicense?: (licenseObject: any) => any

    A function which gets the TVKey license from the server response.

    prepareMessage?: (keyMessage: any) => any

    A function to prepare the license acquisition message which will be sent to the license acquisition server.

    withCredentials?: boolean

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

    Settings
    Member Visibility

    On This Page
    Properties