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

跑通示例源码

更新时间:2022-07-15 21:00

概览

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

准备环境

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

  • Xcode 7.0 或以上版本。
  • iOS 13.0 或以上版本且支持音视频的 iOS 设备或模拟器(推荐使用真机)。
  • iOS 设备已经连接到 Internet。

前提条件

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

示例源码目录结构

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

├── Podfile
├── Podfile.lock
├── ZegoAvatarExample
│   ├── AppDelegate.h
│   ├── AppDelegate.m
│   ├── Assets.xcassets
│   ├── Base.lproj
│   ├── Controller                      # 基础 ViewController
│   ├── Express                         # 使用 Express 进行采集的示例代码
│   ├── Helper                          # ZegoCharacterHelper 放置目录
│   ├── Info.plist
│   ├── Libs                            # Avatar SDK 放置目录
│   ├── LicenseHelper                   # 在线鉴权相关代码
│   ├── SceneDelegate.h
│   ├── SceneDelegate.m
│   ├── Tools
│   ├── View                            # 各种接口示例页面
│   ├── ViewController.h
│   ├── ViewController.m                # 入口页面
│   ├── assets                          # 模型资源
│   └── main.m
├── ZegoAvatarExample.xcodeproj
├── ZegoAvatarExample.xcworkspace
├── ZegoAvatarExampleTests
└── ZegoAvatarExampleUITests

运行示例源码

  1. 打开 “AppStore”,搜索 “Xcode” 并下载安装。

  2. 使用 Xcode 打开 “ZegoAvatarExample.xcworkspace” 文件。

    1. 打开 Xcode,选择左上角的菜单 “File > Open...”。

      /Pics/ZegoAvatar/iOS/ios_open_project.png

    2. 在解压后的示例源码文件夹中,选择 “ZegoAvatarExample.xcworkspace” 文件,并单击 “Open” 打开。

      /Pics/ZegoAvatar/iOS/ios_select_project.png

  3. 示例工程需要使用到 Cocoapods 管理第三方库。如果没有,请前往 Cocoapods 官网,按照安装步骤安装 cocoapods 运行库。

    安装完成后,打开终端,进入 “example” 目录,执行 pod install 命令,安装所需依赖。

    /Pics/ZegoAvatar/iOS/pod_install.png

  1. 登录 Apple 开发者账号。

    1. 打开 Xcode,选择左上角的菜单 “Xcode > Preferences...”。

    2. 单击 “Accounts” 选项卡,单击左下角的 “+”,选择添加 “Apple ID” ,单击 “Continue”。

      /Pics/ZegoAvatar/iOS/add_account.png

    3. 输入 Apple ID 和 Password 登录。

      /Pics/ZegoAvatar/iOS/fill_account.png

  2. 修改 Bundle Identifier 和开发者证书。

    1. 打开 Xcode,单击左侧的 “ZegoAvatarExample” 项目。

      /Pics/ZegoAvatar/iOS/select_proj_sign.png

    2. 选择 “TARGETS” 为 ZegoAvatarExample,单击 “Signing & Capabilities” 选项卡,在 “Team” 中选择自己的开发者证书。

      /Pics/ZegoAvatar/iOS/select_sign.png

    3. 在上图中找到 Bundle Identifier 选项,填入与自己开发者证书对应的 Bundle ID。

      /Pics/ZegoAvatar/iOS/bundleid.png

  3. 下载的示例源码中缺少 SDK 初始化所需的鉴权信息 AppID 和 AppSign,需要修改 “example/ZegoAvatarExample/LicenseHelper” 目录下的 “ZegoAvatarConfig.h” 文件。请使用本文 前提条件 所获取到的信息正确填写,否则源码无法正常运行。

    /Pics/ZegoAvatar/iOS/modify_appid.png

  4. 由于模型资源比较大,没有打包到 “example” 路径下,开发者请在解压后的文件夹中,找到 “assets” 文件夹,把文件夹下面的所有内容都添加到 “example/app/src/main/assets” 路径下。SDK 和 ZegoCharacterHelper 在打包示例源码时已同步更新,不需要再手动复制。

    /Pics/ZegoAvatar/iOS/add_assets.png

    结果如下所示:

    /Pics/ZegoAvatar/iOS/add_assets_result2.png

  1. 将 iOS 设备连接到开发电脑,单击 Xcode 左上角的 “Generic iOS Device” 选择该 iOS 设备(或者模拟器)。

    /Pics/ZegoAvatar/iOS/select_device.png

  2. 单击 Xcode 左上角的 “Build” 按钮编译和运行示例源码。

    /Pics/ZegoAvatar/iOS/start_demo.png