Integrate the SDK

Prerequisites

Before you integrate the ZegoAvatar SDK, ensure that the development environment meets the following requirements:

• Android Studio 2.1 or later.
• Android SDK 25, Android SDK Build-Tools 25.0.2, or Android SDK Platform-Tools 25.x.x or later is used.
• An real Android device that is running on Android 5.1 or later and supports audio and video.
• The front camera and microphone of the device function normally.

Integrate the SDK

1. Optional: Create a project

2. Import the SDK

Supported platform architectures include armeabi-v7a and arm64-v8a.

1. Go to SDK Downloads to download the latest version of SDK.

2. Decompress the SDK package, copy the ZegoAvatar.aar file in the package to a project directory, such as app/libs.

   

3. Add SDK reference. Go to the app folder, open the build.gradle file, and introduce all JAR files under libs to dependencies.

   

    implementation fileTree(dir: 'libs', include: ['*.jar', "*.aar"]) //Wildcard introduction

3. Set permissions

Based on actual application needs, set permissions required by the application.

Go to the app/src/main directory, open the AndroidManifest.xml file, and add permissions.

<!-- Permissions required by the SDK -->

<uses-permission android:name="android.permission.CAMERA" />
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
<uses-permission android:name="android.permission.RECORD_AUDIO" />

<!-- Some permissions required by the app -->
<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.READ_PHONE_STATE" />

<uses-feature
    android:glEsVersion="0x00020000"
    android:required="true" />

<uses-feature android:name="android.hardware.camera" />
<uses-feature android:name="android.hardware.camera.autofocus" />

String[] permissionNeeded = {
    "android.permission.CAMERA"};

if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.M) {
    if (ContextCompat.checkSelfPermission(this, "android.permission.CAMERA") != PackageManager.PERMISSION_GRANTED) {
        requestPermissions(permissionNeeded, 101);
    }
}

4. Prevent code obfuscation

In the proguard-rules.pro file, add the -keep class configuration for the SDK to prevent obfuscation of the SDK public class names.

-keep class **.zego.**{*;}

Import resource packages

Before using AI capabilities provided by the ZegoAvatar SDK, you need to import the corresponding resource packages. Go to Download to obtain the following resource packages.

You can import resource packages using the dynamic downloading or added from local method.

Dynamic downloading (Recommended)

Added from local

1. Go to SDK Downloads to obtain related resource packages.

2. Decompress obtained resource packages, find the assets folder, and copy it to the assets folder of your project.

   
   

3. During project running, copy the AIModel.bundle, base.bundle, and Packages files to the private directory (/data/data/package name/files) of the device by using the following code. (Note: The assets folder of the Android system is read-only.)

    AssetsFileTransfer.copyAssetsDir2Phone(this.getApplication(),
                "AIModel.bundle"/*The assets root directory in APK.*/, "assets"/* Directory in the SD card. The value is: getFilesDir().getAbsolutePath() + File.separator + destPath. */);
    AssetsFileTransfer.copyAssetsDir2Phone(this.getApplication(),
                "base.bundle", "assets");
    AssetsFileTransfer.copyAssetsDir2Phone(this.getApplication(),
                "Packages", "assets");

    /**
     * Copy all content in the assets/${filePath} directory to the ${destPath}/ directory under the storage directory of the mobile phone.
     *
     * @param activity activity Activity of the CopyFiles class is used.
     * @param filePath String File path corresponding to the assets directory in the Android APK, such as AIModel.bundle.
     * @param destPath String Target to be copied, such as /data/data/package name/files/assets/.
     */
    public static void copyAssetsDir2Phone(Context activity, String filePath, String destPath) {
        try {
            String[] fileList = activity.getAssets().list(filePath);
            if (fileList.length > 0) {//If it is a directory
                File file = new File(activity.getFilesDir().getAbsolutePath() + File.separator + destPath + File.separator + filePath);
                if (file.exists()) {
                    deleteAllFiles(file);
                }
                file.mkdirs();//If the folder does not exist, recursion is performed.
                for (String fileName : fileList) {
                    filePath = filePath + File.separator + fileName;

                    copyAssetsDir2Phone(activity, filePath, destPath);

                    filePath = filePath.substring(0, filePath.lastIndexOf(File.separator));
                    Log.i(TAG, filePath);
                }
            } else {//If it is a file
                InputStream inputStream = activity.getAssets().open(filePath);
                File file = new File(activity.getFilesDir().getAbsolutePath() + File.separator + destPath + File.separator + filePath);
                if (file.exists()) {
                    boolean delete = file.delete();
                }
                if (!file.exists() || file.length() == 0) {
                    FileOutputStream fos = new FileOutputStream(file);
                    int len = -1;
                    byte[] buffer = new byte[1024];
                    while ((len = inputStream.read(buffer)) != -1) {
                        fos.write(buffer, 0, len);
                    }
                    fos.flush();
                    inputStream.close();
                    fos.close();
                }
            }
        } catch (IOException e) {
            Log.e(TAG, "copy file faild, src:" + filePath + " dest:" + destPath);
            e.printStackTrace();
        }
    }

4. After the resources are copied and run on a mobile device, the following structure exists. Note: The returned directory of getFilesDir().getAbsolutePath() may vary depending on the mobile device. For example, for a Huawei mobile phone, the returned directory is /data/data/im.zego.zegoavatarexample.

   

5. To use a feature, introduce the absolute path of the resource required by the corresponding API.