文档中心
体验 AppSDK 中心API 中心常见问题代码市场
中文
中文 English
文档中心
体验 App
SDK 中心
API 中心
常见问题
代码市场
进入控制台
立即注册
登录控制台
中文站 English
Avatar 虚拟形象
产品

云通讯产品

  • 实时音视频 Hot
  • 实时语音
  • 畅直播 Hot
  • 即时通讯

AIGC

  • Avatar 虚拟形象
  • MetaWorld 虚拟世界
  • 数智人直播平台 New
  • 数智人创作平台 New
  • 数智人 PaaS 服务 New
  • 实时互动数智人 New

扩展服务

  • 超级白板
  • 小游戏平台 New
  • 云端播放器 New
  • AI 美颜
  • 云端录制
  • 数据流录制
  • 本地服务端录制
  • 星图

低代码互动产品

  • RoomKit
  • Go 课堂
云市场

标准 AI 产品

  • 数美内容审核 New
  • 大饼 AI 变声 New
  • 实时传译 New
解决方案

AIGC

  • 虚拟直播
  • 虚拟语聊
  • 虚拟小窝

社交娱乐

  • 语聊房
  • 秀场直播
  • 在线KTV
  • 在线健身
  • 互动播客
  • 直播答题

电商直播

  • 电商直播

在线教育

  • 小班课
  • 大班课
  • AI教育
  • 超级小班
  • 在线音乐教学
  • 在线美术教学
  • 在线编程教学

医疗健康

  • 远程医疗

互动游戏

  • 游戏直播
  • 游戏语音

协同办公

  • 语音通话
  • 视频通话
  • 视频会议

物联网

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

集成 SDK

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

准备环境

在开始集成 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 能力之前，需要导入相应的资源。根据获取途径不同，资源可分为从 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
是
必须在创建 IZegoCharacter 前完成下载。

从 ZEGO 技术支持获取的资源

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

从本地添加

  1. 请前往 下载 页面，获取 ZEGO Avatar SDK 压缩包。

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

    /Pics/ZegoAvatar/iOS/11.png

    上图仅为拖拽操作的示意，图中 assets 包含的资源可能与您实际获取的不符，请以实际资源为准。

  3. 联系 ZEGO 技术支持获取 “Packages”，并将该文件拖到工程中的上述 “assets” 文件夹下。

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

    /Pics/ZegoAvatar/iOS/22.png

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

    /Pics/ZegoAvatar/iOS/33.png

    上图仅为示意，图中 assets 包含的资源可能与您实际获取的不符，请以实际资源为准。

相关文档

本篇目录
  • 免费试用

  • 联系我们