跑通示例源码

1 准备环境

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

• Windows 系统：Windows 8 或以上版本，已安装 Visual Studio 2015 或以上版本。
• macOS 系统：已安装 Xcode 14.0 或以上版本。
• 已安装 CMake。
• 已安装 Qt 5.12 或以上版本，详细信息请参考 Getting Started with Qt。

2 前提条件

• 已在 下载 页面，获取最新版本的 SDK 和示例源码，并且按照 导入资源和模型页面指引，使用 SDK 内的 AI 模型和资源。
• 已在 ZEGO 控制台 创建项目，获取到了接入 ZegoEffects SDK 服务所需的 AppID 和 AppSign，详情请参考 控制台 - 项目管理 中的“项目信息”。
• 已联系 ZEGO 技术支持，开通 ZegoEffects 相关套餐服务权限。

• 安装完 CMake 和 Qt 后需要添加环境变量：

  下面提供的 CMake 和 Qt 路径仅供参考，用户需要根据自己设备上的实际路径填写。

  • Windows 系统：

    1. 修改“环境变量”：在 “Path” 中添加 “C:\Program Files\CMake\bin”。
    2. 修改“环境变量”：在 “Path” 中添加 “C:\Qt\Qt5.12.10\5.12.10\msvc201d5\bin”。
    3. 修改“环境变量”：在 “Path” 中添加 “C:\Qt\Qt5.12.10\5.12.10\msvc2015_64\bin”。
    4. 添加“用户变量”：添加 “QT_DIR” 用户变量为 “C:\Qt\Qt5.12.10\5.12.10\msvc2015”。
    5. 添加“用户变量”：添加 “QT_DIR_x64” 用户变量为 “C:\Qt\Qt5.12.10\5.12.10\msvc2015_64”。

  • macOS 系统：

    export PATH="/Users/<your-name>/Qt5.12.10/5.12.10/clang_64/bin:$PATH"
    export QTDIR="/Users/<your-name>/Qt5.12.10/5.12.10/clang_64/"

3 运行示例源码

1. 已在 下载 页面，获取最新版本的 SDK 和示例源码。

   若获取到的示例源码中已经有对应的 SDK 文件，请跳过此步到下一步操作。

   • Windows 系统：在主目录新建 “/libs/win” 文件路径，将获取到的 SDK 包解压到此目录（可参考 “.pro” 文件里面依赖库的配置）。
     
   • macOS 系统：在主目录新建 “/libs/mac”文件路径，将获取到的 SDK 包解压到此目录（可参考 ”.pro“ 文件里面依赖库的配置）。
     

2. 使用 IDE 打开项目。

   示例源码中自带了 Qt 工程文件，支持在 Windows 和 macOS 上使用 Qt Creator 打开。

   使用 QtCreator 打开 “src/qt/ZegoEffectsExample” 目录下的 “ZegoEffectsExample.pro” 文件。

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

   请注意：此处需要填写鉴权文件，SDK 校验通过才可以正常使用 SDK 的功能。ZEGO 建议开发者定时更新、拉取鉴权数据，防止鉴权文件过期，导致 SDK 校验不通过的问题。

   

4. 编译和运行项目工程。