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.

Configure the license

1. Copy the license file AliVideoCert-********.crt to the Android Studio project. We recommend that you store the file in the assets directory. You can also put the file in the sandbox directory or other directories that you prefer.

2. Add the following metadata to the AndroidManifest.xml file.

   

   • Set the first key to com.aliyun.alivc_license.licensekey and the value to the value of LicenseKey. The key must be in lowercase letters.

   • Set the second key to com.aliyun.alivc_license.licensefile and the value to the path in which the license file is stored. The key must be in lowercase letters.

   <meta-data
       android:name="com.aliyun.alivc_license.licensekey"
       android:value="xxxxxxxxx" />
   <meta-data
       android:name="com.aliyun.alivc_license.licensefile"
       android:value="assets/license.crt" />

FAQ

FAQ about players

References

Basic features

Advanced features