文档中心
Avatar 虚拟形象
快速开始
跑通示例源码

跑通示例源码

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

概览

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

准备环境

在运行示例源码前，请确保开发环境满足以下要求：

Xcode 7.0 或以上版本。
iOS 11.0 或以上版本且支持音视频的 iOS 设备或模拟器（推荐使用真机）。

如果为模拟器，跑通示例源码后，将无法体验部分功能，如表情随动。
iOS 设备已经连接到 Internet。

前提条件

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

示例源码目录结构

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

├── Podfile
├── ZegoAvatarExample
│   ├── AppDelegate.h
│   ├── AppDelegate.m
│   ├── Assets.xcassets
│   ├── Base.lproj
│   ├── Camera
│   ├── Controller
│   ├── Express
│   ├── FaceMask
│   ├── Helper
│   ├── Info.plist
│   ├── Libs                 # Avatar SDK 放置目录
│   ├── LicenseHelper        # 鉴权信息修改
│   ├── Resource
│   ├── SceneDelegate.h
│   ├── SceneDelegate.m
│   ├── Tools
│   ├── View
│   ├── ViewController.h
│   ├── ViewController.m     # APP 入口 viewController
│   ├── ZegoAvatarExample.entitlements
│   ├── assets                # 模型资源
│   └── main.m
├── ZegoAvatarExample.xcodeproj
│   ├── project.pbxproj
│   ├── project.xcworkspace
│   ├── xcshareddata
│   └── xcuserdata
├── ZegoAvatarExample.xcworkspace
│   ├── contents.xcworkspacedata
│   ├── xcshareddata
│   └── xcuserdata
├── ZegoAvatarExampleTests
│   ├── Info.plist
│   └── ZegoAvatarExampleTests.m
└── ZegoAvatarExampleUITests
    ├── Info.plist
    └── ZegoAvatarExampleUITests.m

运行示例源码

打开 “AppStore”，搜索 “Xcode” 并下载安装。
解压获取的示例源码压缩包，得到 “ZegoAvatarExample” 文件夹，并根据以下步骤打开工程：
1. 打开 Xcode，选择左上角的菜单 “File > Open...”。
2. 选择 “ZegoAvatarExample.xcworkspace” 文件，并单击 “Open” 打开。
示例工程需要使用到 Cocoapods 管理第三方库。如果没有，请前往 Cocoapods 官网，按照安装步骤安装 Cocoapods 运行库。

安装完成后，打开终端，进入 “ZegoAvatarExample” 目录，执行 pod install 命令，安装所需依赖。
登录 Apple 开发者账号。
1. 打开 Xcode，选择左上角的菜单 “Xcode > Preferences...”。
2. 单击 “Accounts” 选项卡，单击左下角的 “+”，选择添加 “Apple ID” ，单击 “Continue”。
3. 输入 Apple ID 和 Password 登录。
修改 Bundle Identifier 和开发者证书。
1. 打开 Xcode，单击左侧的 “ZegoAvatarExample” 项目。
2. 选择 “TARGETS” 为 ZegoAvatarExample，单击 “Signing & Capabilities” 选项卡，在 “Team” 中选择自己的开发者证书和 Bundle Identifier。
解压获取的 SDK 压缩包，在文件夹下找到 “ZegoAvatar.framework” 并拷贝到 “ZegoAvatarExample/Libs” 路径下。
下载的示例源码中缺少 SDK 初始化所需的鉴权信息 AppID 和 AppSign，需要修改 “ZegoAvatarExample/LicenseHelper” 目录下的 “ZegoAvatarConfig.h” 文件。请使用本文前提条件所获取到的信息正确填写，否则源码无法正常运行。
由于模型资源比较大，没有打包到 “ZegoAvatarExample” 路径下，需要将以下资源拷贝到 “ZegoAvatarExample/assets” 目录下。
- 美妆、挂件、装饰、动画等资源：请联系 ZEGO 技术支持获取 Packages 文件夹。
- AI 模型资源和 Q 版风格美术资源：解压 SDK zip 包后，找到 “assets” 文件夹即可获得。
- 默认情况下，SDK 包仅携带 Q 版风格的资源，需要其他风格相关的人模或素材，请联系 ZEGO 技术支持获取。