Apsara Video SDK:Integrate a license

Prerequisites

You have applied for a license and obtained the license file and license key. For more information, see Manage Licenses.

Authentication flowchart

As the figure shows, the ApsaraVideo MediaBox SDK license authentication uses the license key and the license file.

If you choose not to embed a license file, leave its configuration options empty. For more information, see the platform-specific instructions below.

Environments for ApsaraVideo Player SDK

To meet global compliance requirements, ApsaraVideo Player SDK V6.14.0 and later provides multiple service environments. The environment you select determines which regional service center handles license authentication and playback quality data. Choose the service environment that meets your needs.

Note that Alibaba Cloud International site users can only use the International environment (Singapore region). By default, ApsaraVideo Player SDK V6.14.0 and later uses the China environment. To ensure successful license authentication, you must switch to the International environment as described in this topic.

Integrate the license on the web

1. Obtain the license key from the console.

2. When you initialize the player, pass the license object, which includes your registered domain name and license key:

   var player = new Aliplayer({
     license: {
       domain: "example.com", // The domain name you provided when applying for the license.
       key: "example-key"     // The license key from the console after your application is approved.
     }
   });

3. If no errors are reported after initialization, the license is configured correctly.

   Note

   Ensure the domain is the same as, or a subdomain of, the domain you provided when applying for the license. Otherwise, license verification will fail.

Integrate the license on Android

1. Configure the license.

   1. (Recommended) Copy the license file to the assets directory of your Android Studio project.

      Note

      You can also copy the file to another location on the device, but you must ensure that the value for com.aliyun.alivc_license.licensefile (for China environment) or com.aliyun.alivc_license.licensefile_SEA (for International environment) matches the license path in the next step.

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

      Important

      • If verification fails after you configure the license, check whether the <meta-data> node is under the <application> element and whether the name of the <meta-data> is correct. If the issue persists, see FAQ about license for troubleshooting.

      • For International site users, to use ApsaraVideo Player SDK V6.14.0 or later, you must configure a license for the International environment. If you do not use ApsaraVideo Player SDK, you can configure a license only for the China environment.

      • You can integrate licenses for both the International and China environments. After each app startup, you can specify the player's service environment. The environment cannot be switched at runtime.

      

      // Configure the license for the China environment (default configuration for Alibaba Cloud China site)
      <meta-data
          android:name="com.aliyun.alivc_license.licensekey"
          android:value="foIVziMaUHaRqgDyhf6b6eb8fcf014af39535d0720a32****"/>  <!-- TODO: Set your License Key -->
      <meta-data
          android:name="com.aliyun.alivc_license.licensefile"
          android:value="assets/cert/release.crt"/>  <!-- TODO: Set the path to your License File -->
      
      
      // Configure the license for International environment. Manually append _SEA to the name.
      <meta-data
          android:name="com.aliyun.alivc_license.licensekey_SEA"
          android:value="f6b6foIVziMaUHaRqgDyheb8fcf014af39535d0a32720****"/>  <!-- TODO: Set your License Key -->
      <meta-data
          android:name="com.aliyun.alivc_license.licensefile_SEA"
          android:value="assets/cert/release.crt"/>  <!-- TODO: Set the path to your License File -->

2. Configure the service environment for ApsaraVideo Player SDK (required for the International environment).

   ApsaraVideo Player SDK V6.14.0 and later supports selecting a service environment. By default, the China environment is used. To switch to International environment (currently, International site users can only use this environment), you must choose one of the following methods to update the configuration. Otherwise, license authentication for ApsaraVideo Player SDK will fail. For other SDKs and versions, you can skip this step.

   1. Method 1: Call the following API to switch from the default to the International environment.

      // To use the International environment, call this API before any other player APIs to set the International environment. This ensures that all subsequent services run in the international environment.
      // This setting cannot be changed at runtime.
      AlivcBase.getEnvironmentManager().setGlobalEnvironment(AlivcEnv.GlobalEnv.ENV_SEA);

   2. Method 2 (Recommended): For ApsaraVideo Player SDK V7.6.0 and later, you can configure via XML.

      In the AndroidManifest.xml file, add the following information to the <meta-data> node.

      <meta-data
        android:name="com.aliyun.alivc_env"
        android:value="SEA"/>

      The following figure shows a configuration example:

Integrate the license on iOS

1. Configure the license.

   1. In your Xcode project, copy the downloaded license file AliVideoCert-********.crt into your project. We recommend placing it in the AppSupportFiles directory, but you can also place it in the Sandbox or another path. Under Target Membership, select your project's target.

      

   2. Open the Info.plist file. Modify the values for AlivcLicenseKey and AlivcLicenseFile (for the China environment) or AlivcLicenseKey_SEA and AlivcLicenseFile_SEA (for the International environment) to your license key and the path to your license file.

      Important

      • For International site users, to use ApsaraVideo Player SDK V6.14.0 or later, you must configure a license for the International environment. If you do not use ApsaraVideo Player SDK, you can configure a license only for the China environment.

      • You can integrate licenses for both the International and China environments. After each app startup, you can specify the player's service environment. The environment cannot be switched at runtime.

      // Configure the license for the China environment (default).
      <key>AlivcLicenseFile</key>
      <string>XXX</string>
      <key>AlivcLicenseKey</key>
      <string>foIVziMaUHaRqgDyhf6b6eb8fcf014af39535d0720a32****</string>
      
      
      // Configure the license for the International environment. Manually append _SEA to the key name.
      <key>AlivcLicenseFile_SEA</key>
      <string>XXX</string>
      <key>AlivcLicenseKey_SEA</key>
      <string>f6b6efoIVziMaUHaRqgDyhb8fcf014af39535d0a32072****</string>

2. Configure the service environment for ApsaraVideo Player SDK (required for the International environment).

   ApsaraVideo Player SDK V6.14.0 and later supports selecting a service environment. By default, the China environment is used. To switch to the International environment (currently, International site users can only use this environment), you must choose one of the following methods to update the configuration. Otherwise, license authentication for ApsaraVideo Player SDK will fail. For other SDKs and versions, you can skip this step.

   1. Method 1: Call the following API to switch from the default to the International environment.

      // To use the International environment, call this API before any other player APIs to set the International environment. This ensures that all subsequent services run in the international environment.
      // This setting cannot be changed at runtime.
      AlivcBase.EnvironmentManager.globalEnvironment = ENV_SEA;

   2. Method 2 (Recommended): For ApsaraVideo Player SDK V7.6.0 and later, you can configure the International environment via the Info.plist file.

      Open the Info.plist file and change the value of the AlivcEnv key to SEA.

      // Configure the environment as the International environment.
      <key>AlivcEnv</key>
      <string>SEA</string>

      The following figure shows a configuration example:

Integrate the license on Flutter

Flutter is a multi-platform solution from Google. For Flutter apps, you must integrate the license natively for each target platform (Android and iOS). For more information, see Integrate the license on Android and Integrate the license on iOS.