Avatar 虚拟形象
  • iOS : Objective-C
  • Android
  • Unity3D
  • 产品简介
  • 下载
  • 下载体验 App
  • 快速开始
    • 跑通示例源码
    • 集成 SDK
    • 创建虚拟形象
    • ZegoCharacterHelper 使用说明
  • 基本功能
  • 进阶功能
  • 最佳实践
  • 常见错误码
  • 客户端 API
  • 常见问题

集成 SDK

更新时间:2022-06-14 19:46

准备环境

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

  • Xcode 5.0 或以上版本。
  • iOS 11.0 或以上版本,且支持音视频功能的 iOS 真机设备。
  • 设备的前置摄像头和麦克风功能正常。

集成 SDK

1(可选)新建项目

此步骤以如何创建新项目为例,如果是集成到已有项目,可忽略此步。
  1. 启动 Xcode,在 “Welcome to Xcode” 窗口中单击 “Create a new Xcode project” 或选择 “File > New > Project” 菜单。在出现的表单中,选择 iOS 平台,并在 “Application” 下选择 “App”,单击 “Next”。
  1. 填写表单并选取各个选项来配置项目,单击 “Next”。

    必须提供 “Product Name” 和 “Organization Identifier”,用于创建在整个系统中标识 App 的 “Bundle Identifier”。

  1. 选择项目存储路径,单击 “Create” 创建项目。

2 导入 SDK

  1. 请前往 下载 页面,获取最新版本的 SDK,下载完成后进行解压。

    ZEGO 目前提供的是 XCFramework 形式的 SDK ,内含 “arm64” 的架构,不包含 “armv7” 架构。

  2. 手动将 SDK 动态库文件 “ZegoAvatar.xcframework” 拷贝到开发者的项目目录下。

  3. 打开 Xcode,选择 “File > Add Files to "xxx"(xxx 为项目名)” 菜单,添加 SDK 库文件到项目。

    /Pics/ZegoAvatar/iOS/add_files.png

  4. 选择 “TARGETS > General > Frameworks,Libraries,and Embedded Content” 菜单,添加 “ZegoAvatar.xcframework”,将 “Embed” 设置为 “Embed & Sign”。

    /Pics/ZegoAvatar/iOS/embed_and_sign.png

  5. 选择 “TARGETS > Build Settings > Bulid Options” 菜单,找到 Enable Bitcode,改为 “NO”。

    /Pics/ZegoAvatar/iOS/6.png

3 设置权限

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

  1. 在 Xcode 中,选择 “TARGETS > Info > Custom iOS Target Properties” 菜单。
    AddPrivacy
  1. 单击 “+” 添加按钮,添加摄像头和麦克风权限。

    • 摄像头(表情随动时使用):Privacy - Camera Usage Description

    • 麦克风(语音驱动时使用):Privacy - Microphone Usage Description

      AddPrivacy Done

导入资源包

使用 Avatar 提供的各项 AI 能力之前,需要导入相应的资源包,请前往 下载 页面,获取下列资源包。

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

(推荐)动态下载

资源名称 说明 资源大小 是否支持
动态下载
建议下载时机
AIModel.bundle
Avatar 的 AI 模型资源。当使用表情随动、声音随动、AI 捏脸等能力时,必须先将该资源的绝对路径设置给 Avatar SDK。
  • 表情随动:8.2 MB
  • 声音随动:2.4 MB
  • AI 捏脸:12.4 MB
必须在 ZegoAvatarService 初始化前完成下载。
base.bundle
美术资源,包含基础 3D 人物模型资源、资源映射表、人物模型默认外形等。
  • Android: 13 MB
  • iOS: 14.4 MB
必须在创建 ZegoCharacterHelper 前完成下载。
Packages
美妆、挂件、装饰等资源。
每个资源 200 KB ~ 1 MB 不等,跟资源复杂度相关。
建议在需要使用相关资源时再去下载,不使用时可不下载,减少对本地存储空间的占用。

Packages 中包含了部分美术资源,开发者如有需要,请联系 ZEGO 商务人员,获取所有的美术资源。

从本地添加

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

  2. 解压获取到的资源包,找到 “assets” 文件夹,拖到工程中。

    /Pics/ZegoAvatar/iOS/11.png

  3. 在弹出的对话框中,选择 “Create folder references” 选项,添加此文件。

    /Pics/ZegoAvatar/iOS/22.png

  4. 添加后的目录结构如下所示。

    /Pics/ZegoAvatar/iOS/33.png

相关文档