ApsaraVideo VOD:Quick integration

Environment requirements

Prerequisites

• A license for ApsaraVideo Player SDK is registered and the license file AliVideoCert-********.crt is obtained. For more information, see Obtain a license.

• The package for ApsaraVideo Player SDK for Android and the source code of a demo are downloaded. ApsaraVideo Player SDK for Android V5.4.6.0 and later versions provide a demo that does not support AndroidX and a demo that supports AndroidX. We recommend that you download the SDK package and the demo of the latest version based on your business requirements. For more information about the download links, see SDK overview and download.

limits

ApsaraVideo Player SDK for Android cannot run on simulators. After you integrate ApsaraVideo Player SDK for Android, you must run the SDK on an Android device.

Integrate the SDK by adding local files

1. Copy the required AAR package to the libs folder of your project. If the libs folder does not exist, create a libs folder.

   

2. In the build.gradle file of the project, add the flatDir setting to the repositories section of the allprojects block. Sample code:

   flatDir {
      dirs 'libs'
   }

3. Add the reference to the AAR package and the Conan package to the dependencies block in the build.gradle file of the application. Sample code:

   dependencies {
         implementation fileTree(dir: 'libs', include: ['*.aar'])
         // You need to add the reference to the Conan package to the dependencies block only for ApsaraVideo Player V5.3.0 and earlier versions. 
         implementation 'com.alivc.conan:AlivcConan:x.x.x'
   }

4. Configure obfuscation rules.

   Add obfuscation rules to the Proguard-rules.pro file of the application. Sample code:

   -keep class com.alivc.**{*;}
   -keep class com.aliyun.**{*;}
   -keep class com.cicada.**{*;}
   -dontwarn com.alivc.**
   -dontwarn com.aliyun.**
   -dontwarn com.cicada.**

Integrate the SDK by using Gradle

1. Add the URL of the Alibaba Cloud Maven repository to the build.gradle file of the project. Sample code:

   maven { url "https://maven.aliyun.com/repository/releases" }

   The following figure shows the result of the preceding operation.

2. Add dependencies to the dependencies block in the build.gradle file of the application. Sample code:

   Note

   Make sure that the version number of the SDK is correct. Otherwise, an error is reported and the dependencies fail to be added. For more information about the versions of ApsaraVideo Player SDK for Android, see Release notes for ApsaraVideo Player SDK for Android.

   implementation 'com.aliyun.sdk.android:AliyunPlayer:x.x.x-full'
   // You need to add the reference to Conan package to the dependencies block only for ApsaraVideo Player V5.3.0 and earlier versions.
   implementation 'com.alivc.conan:AlivcConan:x.x.x'

   The following figure shows the result of the preceding operation.

Bind a license to an Android application

1. Configure a license.

   1. Recommended. Copy the license file to the assets directory of 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 for the global environment or com.aliyun.alivc_license.licensefile_SEA for the international environment 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 FAQ about licenses.

      • If you want to use ApsaraVideo Player SDK V6.14.0 or later on the Alibaba Cloud international site (alibabacloud.com), you must configure a license for the international environment. 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: one for the global environment and one for the international environment. 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 international environment and 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 V6.14.0 and later allows you to select a service environment. By default, the global environment is configured for ApsaraVideo Player SDK V6.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 international environment for ApsaraVideo Player SDK by using the following method each time you start your application. Otherwise, authentication will fail for the license that authorizes your application to use ApsaraVideo Player SDK. You can ignore this step in scenarios such as using ApsaraVideo Player SDK of a version that is earlier than V6.14.0 or using other SDKs.

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

FAQ

FAQ about players

References

Basic features

Advanced features