实时音视频
  • iOS : Objective-C
  • Android
  • macOS
  • Windows
  • HarmonyOS
  • Linux
  • Web
  • 小程序
  • Flutter
  • Electron
  • Unity3D
  • uni-app
  • React Native
  • Cocos Creator
  • 产品简介
  • 下载
  • 体验 App
  • 快速开始
    • 跑通示例源码
    • 集成 SDK
    • 实现视频通话
    • 实时音视频 SDK 与实时语音 SDK 差异
    • 场景化音视频配置
  • 基础功能
  • 进阶功能
  • 最佳实践
  • 常见错误码
  • 服务端 API
  • 客户端 API
  • 常见问题

集成 SDK

更新时间:2023-01-31 16:54

1 准备环境

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

  • Xcode 13.0 或以上版本。
  • iOS 9.0 或以上版本且支持音视频的 iOS 设备。
  • iOS 设备已经连接到 Internet。

2 集成 SDK

2.1 (可选)新建项目

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

  2. 填写表单并选取各个选项来配置项目,完成后,单击 “Next”。

    必须提供 “Product Name” 和 “Organization Identifier”,用于创建 App 的唯一标识 “Bundle Identifier”。

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

2.2 导入 SDK

开发者可通过以下任意一种方式实现集成 SDK。

方式一: 使用 Swift Package Manager 自动集成(推荐)

  1. 打开 Xcode 并点击菜单栏 “File > Add Packages...”,在 “Apple Swift Packages” 弹窗的 “Search or Enter Package URL” 输入框中填写如下 URL 并敲击回车键确认:

    https://github.com/zegolibrary/express-video-ios
  2. 在 “Dependency Rule” 中指定你想要集成的 SDK 版本(建议使用默认的 “Up to Next Major Version”),然后点击 “Add Package“ 导入 SDK。你也可以参考 Apple 官方文档 进行设置。

方式二: 使用 CocoaPods 自动集成

  1. 安装 CocoaPods,安装时的常见问题请参考 CocoaPods 常见问题 - 安装 CocoaPods

  2. 打开终端,进入项目根目录,执行 pod init 命令创建 Podfile 文件。

  3. 打开 Podfile 文件,在 “target” 下添加 pod 'ZegoExpressEngine',需要将 “MyProject” 替换为开发者的 Target 名称。

    • 由于 SDK 为 XCFramework,需要 CocoaPods v1.10.0 或以上版本才能集成该 SDK。

    • 从 v3.2.0 版本开始, Express 实时音视频 Video SDK 的 Pod 名称由 ZegoExpressEngine/Video 变更为 ZegoExpressEngine;Express 实时语音 Audio SDK 的 Pod 名称由 ZegoExpressEngine/Audio 变更为 ZegoExpressAudio

    target 'MyProject' do
      use_frameworks!
      # 请填写具体的 SDK 版本号
      # 请从发布日志查询 SDK 最新版本,并将 x.y.z 修改为具体的版本号
      pod 'ZegoExpressEngine', '~> x.y.z'
    end
  4. 执行 pod repo update 命令更新本地索引,确保能安装最新版本的 SDK,最新版本号请参考 下载 SDK 包 中的发布历史。

  5. 执行 pod install 命令安装 SDK。

方式三: 复制 SDK 文件手动集成

  1. 请参考 下载 SDK 包,下载最新版本的 SDK 并解压。

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

    • ios-arm64_armv7:支持 iOS 平台的 arm64、armv7 架构的真机。
    • ios-arm64_x86_64-maccatalyst:支持 Mac Catalyst 方式的 arm64、x86_64 架构。
    • ios-arm64_x86_64-simulator:支持 iOS 平台的 arm64、x86_64 架构的模拟器。
  3. 打开 Xcode,选择 “File > Add Files to "xxx"(xxx 为项目名)” 菜单,添加 SDK 库文件到项目。

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

    Dylibembed

3 设置权限

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

  1. 在 Xcode 中,选择 “TARGETS > Info > Custom iOS Target Properties” 菜单。

    AddPrivacy

  2. 单击 “+” 添加按钮,添加摄像头和麦克风权限。

    • Privacy - Camera Usage Description

    • Privacy - Microphone Usage Description

      AddPrivacy Done

相关文档