Apsara Video SDK:Bind a license

Prerequisites

A license is applied for, and the license key and license file are obtained. For more information, see the Apply for a license section of the "Manage licenses" topic.

Authentication flowchart

As shown in the preceding figure, ApsaraVideo MediaBox SDK authenticates an application by using a license key and a license file. The following table describes the configuration requirements for a license key and a license file.

If you do not want to configure a built-in license file, skip the related configurations when you bind a license to an application.

Service environments for Player SDK

To meet global compliance requirements, ApsaraVideo Player SDK 6.14.0 and later provides multiple service environments to ensure that your service is localized and compliant. After you select a service environment for ApsaraVideo Player SDK, the service center in the selected service environment provides the data that is required for the license-based authentication and the data related to playback quality. You can select a service environment based on your business requirements. The following table describes the available service environments.

Users of the Alibaba Cloud international site (alibabacloud.com) can use only nodes in the Singapore region. By default, the global environment is configured for ApsaraVideo Player SDK 6.14.0 or later. To ensure smooth license-based authentication, you need to update the service environment to the Alibaba Cloud international site for ApsaraVideo Player SDK.

Bind a license to a web application

1. Obtain the license key in the ApsaraVideo VOD console.

2. Configure the license information when you initialize the player, such as your domain name and the license key.

   var player = new Aliplayer({
     license: {
       domain: "example.com", // The domain name that you specify when you apply for a license.
       key: "example-key" // The license key that is displayed in the ApsaraVideo VOD console after a license is applied.
     }
   });

3. If no error message is returned after you initialize the player, the license is configured.

   Note

   The domain name of the page on which the player is deployed must be a subdomain of or the same as the web domain name that you specified when you applied for the license. Otherwise, the license verification fails. The localhost does not verify the domain name.

Bind a license to an Android application

1. Configure a license.

   1. Recommended. Copy the license file to the assets directory in your Android Studio project.

      Note

      You can also copy the license file to another directory on your device. If you do so, make sure that the value that corresponds to com.aliyun.alivc_license.licensefile in the global environment or com.aliyun.alivc_license.licensefile_SEA on the Alibaba Cloud international site (alibabacloud.com) in Step 2 is the same as the path of the license file.

   2. Add <meta-data> elements to the AndroidManifest.xml file.

      Important

      • If the authentication fails after you configure the license, check whether the <meta-data> elements are added under the <application> element and whether the names in the <meta-data> elements are correct. If the issue persists, troubleshoot the issue by referring to the FAQ about licenses topic.

      • If you want to use ApsaraVideo Player SDK 6.14.0 or later on the Alibaba Cloud international site (alibabacloud.com), you must configure a license for the Alibaba Cloud international site (alibabacloud.com). If you do not use ApsaraVideo Player SDK, you can configure a license for the global environment.

      • You can bind two licenses to your application at the same time, including a license for the global environment and a license for the Alibaba Cloud international site (alibabacloud.com). Then, you can specify the environment to use the player by configuring the service environment for ApsaraVideo Player SDK each time you start your application. You cannot switch the environment when the player is running.

      

      // Configure a license for the global environment. This is the default configuration.
      <meta-data
          android:name="com.aliyun.alivc_license.licensekey"
          android:value="foIVziMaUHaRqgDyhf6b6eb8fcf014af39535d0720a32****"/>  <!-- TODO: Specify the license key.-->
      <meta-data
          android:name="com.aliyun.alivc_license.licensefile"
          android:value="assets/cert/release.crt"/>  <!-- TODO: Specify the path of your license file.-->
      
      
      // Configure a license for the Alibaba Cloud international site (alibabacloud.com) and manually add _SEA to the end of the license name.
      <meta-data
          android:name="com.aliyun.alivc_license.licensekey_SEA"
          android:value="f6b6foIVziMaUHaRqgDyheb8fcf014af39535d0a32720****"/>  <!-- TODO: Specify the license key.-->
      <meta-data
          android:name="com.aliyun.alivc_license.licensefile_SEA"
          android:value="assets/cert/release.crt"/>  <!-- TODO: Specify the path of your license file.-->

2. Configure a service environment for ApsaraVideo Player SDK. This step is required if you use the Alibaba Cloud international site (alibabacloud.com).

   ApsaraVideo Player SDK 6.14.0 and later allows you to select a service environment. By default, the global environment is configured for ApsaraVideo Player SDK 6.14.0 and later. Users of the Alibaba Cloud international site (alibabacloud.com) cannot use the global environment. If you want to use the Alibaba Cloud international site (alibabacloud.com), you must update the service environment to the Alibaba Cloud international site (alibabacloud.com) for ApsaraVideo Player SDK by using the following method each time you start your application. Otherwise, the license that authorizes your application to use ApsaraVideo Player SDK fails the authentication. You can ignore this step if you use ApsaraVideo Player SDK of a version that is earlier than 6.14.0 or in other scenarios.

   // When you use the Alibaba Cloud international site (alibabacloud.com), make sure that you have called the following operation to update the default environment to the Alibaba Cloud international site (alibabacloud.com) before you call an API operation of the player. This ensures that all subsequent services run on the Alibaba Cloud international site (alibabacloud.com).
   // Configure the environment to the Alibaba Cloud international site (alibabacloud.com) by calling the unified API operation of AlivcBase. You cannot change the environment when the player is running.
   AlivcBase.getEnvironmentManager().setGlobalEnvironment(AlivcEnv.GlobalEnv.ENV_SEA);

Bind a license to an iOS application

1. Configure a license.

   1. Copy the license file to the specified directory of the Xcode project and select the current project in Target Membership.

      

   2. Open the Info.plist file. Set the AlivcLicenseKey and AlivcLicenseFile parameters in the global environment, or the AlivcLicenseKey_SEA and AlivcLicenseFile_SEA parameters on the Alibaba Cloud international site (alibabacloud.com) to the license key and license file path that you obtained when you applied for the license.

      Important

      • If you want to use ApsaraVideo Player SDK 6.14.0 or later on the Alibaba Cloud international site (alibabacloud.com), you must configure a license for the Alibaba Cloud international site (alibabacloud.com). If you do not use ApsaraVideo Player SDK, you can configure a license for the global environment.

      • You can bind two licenses to your application at the same time, including a license for the global environment and a license for the Alibaba Cloud international site (alibabacloud.com). Then, you can specify the environment to use the player by configuring the service environment for ApsaraVideo Player SDK each time you start your application. You cannot switch the environment when the player is running.

      // Configure a license for the global environment. This is the default configuration.
      <key>AlivcLicenseFile</key>
      <string>XXX</string>
      <key>AlivcLicenseKey</key>
      <string>foIVziMaUHaRqgDyhf6b6eb8fcf014af39535d0720a32****</string>
      
      
      // Configure a license for the Alibaba Cloud international site (alibabacloud.com) and manually add _SEA to the end of the license name.
      <key>AlivcLicenseFile_SEA</key>
      <string>XXX</string>
      <key>AlivcLicenseKey_SEA</key>
      <string>f6b6efoIVziMaUHaRqgDyhb8fcf014af39535d0a32072****</string>

2. Configure a service environment for ApsaraVideo Player SDK.

   ApsaraVideo Player SDK 6.14.0 and later allows you to select a service environment. By default, the global environment is configured for ApsaraVideo Player SDK 6.14.0 and later. Users of the Alibaba Cloud international site (alibabacloud.com) cannot use the global environment. If you want to use the Alibaba Cloud international site (alibabacloud.com), you must update the service environment to the Alibaba Cloud international site (alibabacloud.com) for ApsaraVideo Player SDK by using the following method each time you start your application. Otherwise, the license that authorizes your application to use ApsaraVideo Player SDK fails the authentication. You can ignore this step if you use ApsaraVideo Player SDK of a version that is earlier than 6.14.0 or in other scenarios.

   // When you use the Alibaba Cloud international site (alibabacloud.com), make sure that you have called the following operation to update the default environment to the Alibaba Cloud international site (alibabacloud.com) before you call an API operation of the player. This ensures that all subsequent services run on the Alibaba Cloud international site (alibabacloud.com).
   // Configure the environment to the Alibaba Cloud international site (alibabacloud.com) by calling the unified API operation of AlivcBase. You cannot change the environment when the player is running.
   AlivcBase.EnvironmentManager.globalEnvironment = ENV_SEA;