Avatar 虚拟形象
  • iOS
  • Android : Java
  • 产品简介
  • 下载
  • 下载体验 App
  • 快速开始
    • 跑通示例源码
    • 集成 SDK
    • 创建虚拟形象
  • 基本功能
  • 最佳实践
  • 客户端 API
  • 服务端 API
  • 常见错误码
  • 常见问题
  • 文档中心
  • Avatar 虚拟形象
  • 快速开始
  • 集成 SDK

集成 SDK

更新时间:2024-01-23 22:53

准备环境

在开始集成 ZegoAvatar SDK 前,请确保开发环境满足以下要求:

  • Android Studio 2.1 或以上版本。
  • Android SDK 25、Android SDK Build-Tools 25.0.2、Android SDK Platform-Tools 25.x.x 或以上版本。
  • Android 5.1 或以上版本,且支持音视频的 Android 真机设备。
  • 设备的前置摄像头和麦克风功能正常。
  • 1 GB+ RAM。
  • 图形 API 为 OpenGL ES 2.0+、OpenGL ES 3.0+ 或 VulKan。

集成 SDK

1(可选)新建项目

此步骤以如何创建新项目为例,如果是集成到已有项目,可忽略此步。
  1. 打开 Android Studio,选择 “File > New > New Project” 菜单。

  2. 填写项目名及项目存储路径。

  3. 其它按照默认设置,单击 “Next”,最后单击 “Finish” 完成新工程创建。

2 导入 SDK

目前支持的平台架构包括:armeabi-v7a、arm64-v8a。

  1. 请前往 下载 页面,获取最新版本的 SDK。

  2. 解压 SDK 压缩包,将 ZegoAvatar 的制品包中的 ZegoAvatar.aar 拷贝至自己的项目目录下,如 “app/libs”。

    /Pics/ZegoAvatar/Android/SDK_cap.png

  3. 添加 SDK 引用。进入到 “app” 目录,打开 “build.gradle” 文件,在 “dependencies” 节点引入 “libs” 下所有的 jar。

    implementation fileTree(dir: 'libs', include: ['*.jar', "*.aar"]) // 通配引入

    /Pics/Avatar_Android/avatar_aar_in_project.png

3 设置权限

根据实际应用需要,设置应用所需权限。

进入 “app/src/main” 目录,打开 “AndroidManifest.xml” 文件,添加权限。

<!-- 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" />
<uses-permission android:name="android.permission.INTERNET" />

<!-- App 需要使用的部分权限 -->
<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" /> 

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

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

因为 Android 6.0 及以后版本在一些比较重要的权限上要求必须申请动态权限,不能只通过 “AndroidMainfest.xml” 文件申请静态权限。因此还需要参考执行如下代码,其中 “requestPermissions” 是 “Activity” 的方法。

private final static int CAMERA_CODE = 101;
private String permissions[] = new String[]{
            Manifest.permission.INTERNET,
            Manifest.permission.CAMERA,
            Manifest.permission.WRITE_EXTERNAL_STORAGE,
            Manifest.permission.READ_EXTERNAL_STORAGE,
            Manifest.permission.RECORD_AUDIO};



/**
 * 申请权限
 */
private void getPermission() {
    if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.M) {
        if (!checkCameraPermision()) {
            // 先判断有没有权限 ,没有就在这里进行权限的申请
            ActivityCompat.requestPermissions(this, permissions, CAMERA_CODE);

        } else {
            // 说明已经获取摄像头权限了
            Log.i("MainActivity", "已经获取了权限");
        }
    } else {
        // 这个说明系统版本在6.0之下,不需要动态获取权限。
        Log.i("MainActivity", "这个说明系统版本在6.0之下,不需要动态获取权限。");
    }
}

/**
 * 检查是否有权限
 * @return
 */
private boolean checkCameraPermision() {
    for (String p : permissions) {
        if (ContextCompat.checkSelfPermission(this, p) != PackageManager.PERMISSION_GRANTED) {
            return false;
       }
    }
    return true;
}

    /**
     * 申请权限回调
     * @param requestCode
     * @param permissions
     * @param grantResults
     */
    @Override
    public void onRequestPermissionsResult(int requestCode, @NonNull String[] permissions, @NonNull int[] grantResults) {
        super.onRequestPermissionsResult(requestCode, permissions, grantResults);
        if (requestCode == CAMERA_CODE) {
            boolean isAllGrant = true;
            for (int i = 0;i<grantResults.length ;i++) {
                if (grantResults[i] != PackageManager.PERMISSION_GRANTED) {
                    isAllGrant = false;
                    break;
                }
            }
            if (isAllGrant) {
                //申请权限成功,执行操作
            }
        }
    }
必要性 权限 权限说明 申请原因
必要权限
CAMERA
访问相机权限。
通过摄像头画面推理面部表情时,需要使用该权限。
RECORD_AUDIO
录制音频权限。
通过声音波动推理面部表情时,需要使用该权限。
WRITE_EXTERNAL_STORAGE
内置 SDK 写权限。
SDK 会将日志和相关配置文件保存在内置 SDK 内。需要保存截图或录制的视频时,也需要使用该权限。
INTERNET
访问网络权限。
SDK 鉴权获取时,需要使用该权限。
非必要权限
READ_EXTERNAL_STORAGE
文件读取权限。
SDK 需要读取资源包时,需要使用该权限。

4 防止混淆代码

在 “proguard-rules.pro” 文件中,为 SDK 添加 -keep 类的配置,防止混淆 SDK 公共类名称。

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

5 选择架构

ZEGO Avatar SDK 支持 arm64-v8a 和 armeabi-v7a 架构。建议您使用其中一种架构即可,以节省您项目的 apk 体积。

ndk {
    // abiFilters 'arm64-v8a' , 'armeabi-v7a'
    abiFilters 'arm64-v8a'
}

导入资源

使用 Avatar 提供的各项 AI 能力之前,需要导入相应的资源。根据获取途径不同,资源可分为从 SDK 压缩包获取,和从 ZEGO 技术支持获取。

开发者可以通过 动态下载从本地添加 两种方式,导入资源。

(推荐)动态下载

从 SDK 压缩包获取的资源

资源名称 说明 资源大小 是否支持
动态下载
建议下载时机
AIModel.bundle
Avatar 的 AI 模型资源。当使用表情随动、声音随动、AI 捏脸等能力时,必须先将该资源的绝对路径设置给 Avatar SDK。
  • 表情随动:12.6 MB
  • 声音随动:1.13 MB
  • AI 捏脸:5.65 MB
必须在 ZegoAvatarService 初始化前完成下载。
qhuman.bundle
美术资源,包含基础 Q 版头套模型资源、资源映射表、Q 版模型默认外形等。
  • Android: 10.6 MB
  • iOS: 10.6 MB
必须在创建 ZegoCharacter 前完成下载。

从 ZEGO 技术支持获取的资源

资源名称 说明  资源大小 是否支持动态下载 建议下载时机
Packages
美妆、挂件、装饰、动画等资源。
每个资源 200 KB - 1 MB 不等,跟资源复杂度相关。
建议在需要使用相关资源时再去下载,不使用时可不下载,减少对本地存储空间的占用。
其他风格素材
目前已支持二次元风格。
5 MB - 10 MB。
建议角色上屏前完成其他风格人模包的下载,确保设置角色时可以成功在本地加载角色。

从本地添加

  1. 请前往 下载 页面,获取相关的资源包。

  2. 解压获取到的资源包,找到 “assets” 文件夹,将该文件夹下的内容拷贝到您项目的 “assets” 文件夹下。

  3. 联系 ZEGO 技术支持获取 “Packages”,并将该文件夹拷贝到您项目的 “assets” 文件夹下。

  4. 运行项目时,将 “AIModel.bundle”、“qhuman.bundle” 、"Packages" 文件,通过以下代码,拷贝到设备的私有目录(/data/data/包名/files)下。(注意:Android 系统的 assets 文件夹只能读取。)

    copyAssetsDir2Phone(this.getApplication(),
                "AIModel.bundle"/*apk 里的 assets 根目录*/, "assets"/* sd 卡里的目录, 值为:getFilesDir().getAbsolutePath() + File.separator + destPath */);
    copyAssetsDir2Phone(this.getApplication(),
                "qhuman.bundle", "assets");
    // Packages 通过 ZEGO 技术支持获取
    copyAssetsDir2Phone(this.getApplication(),
                "Packages", "assets");
    /**
     * 把 assets/${filePath} 目录中的所有内容拷贝到 手机的 Storage 的 ${destPath}/ 目录中
     *
     * @param activity activity 使用 CopyFiles 类的 Activity
     * @param filePath String 相对于 Android APK 内的 assets 目录的文件路径,如:AIModel.bundle
     * @param destPath String 拷贝的目标,如:/data/data/包名/files/assets/
     */
    public static void copyAssetsDir2Phone(Context activity, String filePath, String destPath) {
        try {
            String[] fileList = activity.getAssets().list(filePath);
            if (fileList.length > 0) {//如果是目录
                File file = new File(activity.getFilesDir().getAbsolutePath() + File.separator + destPath + File.separator + filePath);
                if (file.exists()) {
                    deleteAllFiles(file);
                }
                file.mkdirs();//如果文件夹不存在,则递归
                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 {//如果是文件
                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();
        }
    }
    private static void deleteAllFiles(File root) {
        File files[] = root.listFiles();
        if (files != null)
            for (File f : files) {
                if (f.isDirectory()) { // 判断是否为文件夹
                    deleteAllFiles(f);
                    try {
                        f.delete();
                    } catch (Exception e) {
                    }
                } else {
                    if (f.exists()) { // 判断是否存在
                        deleteAllFiles(f);
                        try {
                            f.delete();
                        } catch (Exception e) {
                        }
                    }
                }
            }
    }
  5. 拷贝资源后,在移动设备上运行时,会存在如下的结构。注意:不同的移动设备,getFilesDir().getAbsolutePath() 返回的目录可能不一样。这里以华为手机为例,其返回的是:/data/data/im.zego.zegoavatarexample

    /Pics/ZegoAvatar/Android/android_assets.png

  6. 使用某一功能时,在对应接口中,传入接口要求的资源的 绝对路径 即可。

相关文档

本篇目录