All Products
Search
Document Center

Integrate the SDK

Last Updated: May 19, 2022

This topic describes the SDK reference of the short video SDK for Android and shows you how to integrate the SDK.

Prerequisites

The development environment is set up. The following table describes the requirements for the development environment.

Prerequisites

Item

Description

Operating system

Android 4.3 or later.

Java

Java 1.7 or later.

API LEVEL

Android API level 18 or later.

Android Studio

Android Studio 2.3 or later. To download Android Studio, visit Android Studio.

(Recommended) Integrate the SDK by using Maven dependencies

  1. Add the Alibaba Cloud Maven repository.

    Add the URL of the Alibaba Cloud Maven repository to the build.gradle file of your project.

    allprojects {
        repositories {
            maven {
                url 'http://maven.aliyun.com/nexus/content/repositories/releases/'
           }
        }
    }

  2. Add dependencies to the Maven project.

    dependencies{
        implementation 'com.aliyun.video.android:svideopro:3.30.+' // Required dependency for the short video SDK.
        implementation 'com.aliyun.video.android:core:1.2.2' // Required dependency for the core library.
        implementation  'com.alivc.conan:AlivcConan:1.0.3' // Required dependency for the core library.
       // AlivcFFmpeg V4.3.0 or later must be used. Select one of the following versions. 
        implementation 'com.aliyun.video.android:AlivcFFmpeg:4.3.2.0-part' // Dedicated dependency for the short video SDK, which has a small package size. 
        implementation 'com.aliyun.video.android:AlivcFFmpeg:4.3.2'// Dependency that is used by both the short video SDK and ApsaraVideo Player SDK. If the two SDKs are integrated at the same time, use this version. 
        implementation  'com.aliyun.video.android:upload:1.6.4' // Optional dependency for an upload library.
        implementation 'com.google.code.gson:gson:2.8.0' // Dependency for a third-party library.
        implementation 'com.squareup.okhttp3:okhttp:3.2.0' // Dependency for a third-party library.
    }

Note

The short video SDK supports only the armeabi-v7a and arm64-v8a instruction sets. To ensure compatibility with armeabi, copy the .so files in the armeabi-v7a folder to the armeabi folder. Compatibility with ARMv5 and ARMv6 devices is not required because Android rapidly develops and the short video SDK is applicable only to Android 4.3 or later.

Manually integrate the SDK

Import AAR packages

  1. Create a module.

    In Android Studio, choose File>New> New Module to create a library module. In this example, the library module is named AliyunSvideoLibrary.

    SDK_1
  2. Copy AliyunSdk-RCE.aar, AlivcConan-x.x.x.aar, and AlivcCore.jar from the SDK directory to the created module and add the module to your project.

    SDK_2
  3. Add AAR and JAR packages by using Gradle.

    dependencies {
     implementation fileTree(include: ['*.jar','*.aar'], dir: 'libs')
    }
  4. Add the dependency of the AliyunSvideoLibrary module to the app module.

     dependencies {
        implementation project(":AliyunSvideoLibrary")
    }

Import .so files

  1. Copy the jniLibs folder from the decompressed SDK package to the main folder of the app module. Then, declare the path of jniLibs in the build.gradle file of the app module.

    The following code provides an example:

    android {
     sourceSets.main {
         jni.srcDirs = []
         jniLibs.srcDir "src/main/jniLibs" 
     }
    }
  2. Load the dynamic-link libraries that are required for the SDK.

    These dynamic-link libraries have been loaded in the latest version of the SDK. You do not need to load the dynamic-link libraries.

    The following content describes the library files:

    libalivcffmpeg.so-------------Required third-party library for the SDK.
    libaliresample.so-------------------The library that is required for audio resampling. This library is optional.
  3. Add the dependencies that are required to upload short videos.

    The upload SDK and Object Storage Service (OSS) are required to upload short videos. If you do not need to upload short videos, skip this step.

    implementation 'com.aliyun.video.android:upload:1.6.4'
    implementation 'com.google.code.gson:gson:2.8.0'
    implementation 'com.squareup.okhttp3:okhttp:3.2.0'
    implementation 'com.aliyun.dpa:oss-android-sdk:+'
  4. Initialize the configurations.

    Call the onCreate method of the Application class in the app module. The following code provides an example:

    com.aliyun.vod.common.httpfinal.QupaiHttpFinal.getInstance().initOkHttpFinal();

Add permissions

<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" />
<uses-permission android:name="android.permission.CAMERA" />
<uses-permission android:name="android.permission.FLASHLIGHT" />
<uses-permission android:name="android.permission.RECORD_VIDEO" />
<uses-permission android:name="android.permission.RECORD_AUDIO" />
<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
Note

Permissions need to be requested at runtime in Android 6.0 or later.

Obfuscation configuration

You can perform the obfuscation configuration in the proguard-rules.pro file. The following code provides an example:

######################Obfuscation configuration of the short video SDK#########################
-keep class com.aliyun.**{*;}
-keep class com.duanqu.**{*;}
-keep class com.qu.**{*;}
-keep class com.alibaba.**{*;}
-keep class component.alivc.**{*;}
-keep class com.alivc.**{*;}

API reference

For more information, see API references.