跑通示例源码

概览

本文介绍如何快速跑通示例源码，体验 Avatar 虚拟形象服务。

准备环境

在运行示例源码前，请确保开发环境满足以下要求（以下说明皆以 macOS 开发电脑为例)：

• Android Studio 4.0 或以上版本。

• Android SDK 30、Android SDK Platform-Tools 30.x.x 或以上版本。

• Android 5.1 或以上版本，且支持音视频的 Android 设备或模拟器，推荐使用真机。

  • 如果为真机，请开启“允许调试”选项。
  • 如果为模拟器，跑通示例源码后，将无法体验部分功能，如表情随动。

前提条件

• 已在 ZEGO 控制台 创建项目，并申请有效的 AppID 和 AppSign，详情请参考 控制台 - 项目管理 中的“项目信息”。
• 已联系 ZEGO 商务人员，提供自己项目的包名，开通 Avatar 权限。
• 已在 下载 页面，获取 SDK 和示例源码。

示例源码目录结构

下列结构为 Avatar 源码 ZegoAvatarExample 的子目录结构，下文所涉及的文件路径均为相对于此目录的路径。

.
├── app
│   ├── build.gradle
│   ├── libs                                          # Avatar SDK 放置的目录
│   ├── proguard-rules.pro
│   └── src
│       │── androidTest
│       │── main
│       │   │── AndroidManifest.xml
│       │   │── assets                                 # 模型资源
│       │   │── java
│       │   │   └── im
│       │   │       └── zego
│       │   │           ├── apiservice.text            # 文本驱动业务源码，仅供参考
│       │   │           └── zegoavatarexample
│       │   │               ├── activrty               # 各项功能页面
│       │   │               ├── adapter                # 一些一面的适配器
│       │   │               ├── entity                 # 封装的一些数据类
│       │   │               ├── gl                     # 纹理渲染的封装 
│       │   │               ├── helper                 # 视频录制和文件拷贝的helper放置目录
│       │   │               ├── licensehelper          # 鉴权相关配置
│       │   │               ├── util                   # 工具目录
│       │   │               ├── view                   # view的工具
│       │   │               ├── MainActivety.java      # 首页
│       │   │               └── SettingActivity.java   # 设置页
│       │   └── res
│       └── test
│── build.gradle
│── gradle
│── gradle.properties
│── gradlew
│── gradlew.bat
│── local.properties
└── settings.gradle

运行示例源码

1. 解压获取的示例源码压缩包，得到 “ZegoAvatarExample” 文件夹。

2. 解压获取的 SDK 压缩包，在文件夹下找到 “SDK” 目录即可获得 ZegoAvatar.aar。

   

   将该文件拷贝到 “ZegoAvatarExample” 文件夹的的 “app/libs” 路径下。

   

3. 打开 Android Studio 软件。

   
   在开发电脑上安装 Android Studio 的方式

   • 方式 1：登录 Android Studio 官网 下载并安装 Android Studio 及其相关的 SDK Tools。由于国内运营商网络限制等原因，开发者需要确保本机能连接该网站，若无法访问建议选择“方式 2”。
   • 方式 2：使用搜索引擎搜索 “Android Studio 下载”、“Android Studio 安装” 和 “Android Studio SDK Tools 安装”，查找可下载的源网站，并安装相关软件和工具。

4. 单击 “Open” 或 “Open an existing Android Studio project”。

   

5. 选择 “ZegoAvatarExample” 文件夹，并单击 “Open” 打开。

6. 示例源码中缺少 SDK 初始化所需的鉴权信息 AppID 和 AppSign，需要修改 “ZegoAvatarExample/app/src/main/java/im/zego/zegoavatarexample/licensehelper” 目录下的 “ZegoAvatarConfig.java” 文件。请使用本文 前提条件 所获取到的信息正确填写，否则源码无法正常运行。

   

6. 找到 “app/build.gradle” 文件，将 “applicationId” 设置为申请权限时所提供的包名。

   

7. 由于模型资源比较大，没有打包到 “ZegoAvatarExample” 路径下，需要将以下资源拷贝到 “ZegoAvatarExample/app/src/main/assets” 目录下。

   • 美妆、挂件、装饰、动画等资源：请联系 ZEGO 技术支持获取 Packages 文件夹。

   • AI 模型资源和 Q 版风格美术资源：解压 SDK zip 包后，找到 “assets” 文件夹即可获得。

   • 默认情况下，SDK 包仅携带 Q 版风格的资源，需要其他风格相关的人模或素材，请联系 ZEGO 技术支持获取。

     

   结果如下所示：

   

8. 选择一台 Android 真机设备连接到开发电脑，当该设备成功开启“开发者模式”和“USB 调试功能”后，可以看到 Android Studio 界面已检测到该设备，如下图所示：

   

   说明 Android Studio 软件已成功连接到 Android 设备，可以将源码运行到该设备上了。

   • 当开发电脑连接 Android 设备后，大部分设备会弹出提示，不同 Android 厂商的提示信息有所不同，可根据情况选择 USB 模式。
   • 当 Android 设备连接开发电脑后，需要根据情况在该设备上开启开发者模式和 USB 调试功能（不同厂商的 Android 设备开启方式不同）。具体开启方式可以使用搜索引擎搜索。 例如：目前存在一台未开启过开发者模式与 USB 调试功能的某设备，可以在搜索引擎搜索“某设备开启开发者模式”，查看具体的开启教程。

9. 单击 Android Studio 软件上的 “build and run” 按钮，编译并运行源码。