集成 SDK
准备环境
在开始集成 ZEGO Express SDK 前,请确保开发环境满足以下要求:
- Xcode 15.0 或以上版本。
- iOS 12.0 或以上版本且支持音视频的 iOS 设备。
- iOS 设备已经连接到 Internet。
集成 SDK
(可选)新建项目
-
启动 Xcode,在 “Welcome to Xcode” 窗口中单击 “Create a new Xcode project” 或选择 “File > New > Project” 菜单。
-
在出现的表单中,选择 iOS 平台,并在 “Application” 下选择 “App”。
-
填写表单并选取各个选项来配置项目,完成后,单击 “Next”。
必须提供 “Product Name” 和 “Organization Identifier”,用于创建 App 的唯一标识 “Bundle Identifier”。
-
选择项目存储路径,单击 “Create” 创建项目。
导入 SDK
开发者可通过以下任意一种方式实现集成 SDK。
方式 1:使用 Swift Package Manager 自动集成(推荐)
-
打开 Xcode ,在菜单栏选择 “File > Add Packages...”,在 “Apple Swift Packages” 弹窗的 “Search or Enter Package URL” 输入框中,填写如下 URL 并敲击回车键确认:
https://github.com/zegolibrary/express-video-ios
-
在 “Dependency Rule” 中,指定您想要集成的 SDK 版本(建议使用默认的 “Up to Next Major Version”),然后单击 “Add Package“ 导入 SDK,您也可以参考 Apple 官方文档 进行设置。
方式 2:使用 CocoaPods 自动集成
-
安装 CocoaPods,安装时的常见问题请参考 CocoaPods 常见问题 - 安装 CocoaPods。
-
打开终端,进入项目根目录,执行
pod init
命令创建 Podfile 文件。 -
打开 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
-
执行
pod repo update
命令更新本地索引,确保能安装最新版本的 SDK,最新版本号请参考 下载 SDK 包 中的发布历史。 -
执行
pod install
命令安装 SDK。说明- 若出现 “CDN: trunk URL couldn't be downloaded” 问题,请参考 CocoaPods 常见问题 - 连接不上 trunk CDN 的问题。
- 若出现 “Unable to find a specification for 'ZegoExpressEngine'” 问题,请参考 CocoaPods 常见问题 - 无法找到项目的问题。
- 若出现 “CocoaPods could not find compatible versions for pod "ZegoExpressEngine"” 问题,请参考 CocoaPods 常见问题 - 无法找到项目的问题。
方式 3:复制 SDK 文件手动集成
-
请参考 下载 文档,下载最新版本的 SDK 并解压。
-
手动将 SDK 动态库文件 “ZegoExpressEngine.xcframework” 拷贝到开发者的项目目录下。
XCFramework 文件说明XCFramework 是一个同时包含真机、模拟器等多平台架构的全新封装形式,请将其作为一个整体集成到工程内,不建议拆开使用。但如果您确实仅需要单独集成真机架构、或单独集成模拟器架构,也可以将 XCFramework 内的 .framework 单独取出使用。
- ios-arm64:适用于 iOS 真机。
- ios-arm64_x86_64-maccatalyst:适用于 macOS 的 Mac Catalyst 包。Mac Catalyst 是 Apple 在 2019 年推出的新框架,即 UIKit for Mac,旨在让 iPad App 运行在 macOS 上。详情请参考 Apple 开发者 - Mac Catalyst
- ios-arm64_x86_64-simulator:适用于 iOS 模拟器。
-
打开 Xcode,选择 “File > Add Files to "xxx"(xxx 为项目名)” 菜单,添加 SDK 库文件到项目。
-
选择 “TARGETS > General > Frameworks,Libraries,and Embedded Content” 菜单,添加 “ZegoExpressEngine.xcframework”,将 “Embed” 设置为 “Embed & Sign”。
设置权限
根据实际应用需要,设置应用所需权限。
-
在 Xcode 中,选择 “TARGETS > Info > Custom iOS Target Properties” 菜单。
-
单击 “+” 添加按钮,添加摄像头和麦克风权限。
-
Privacy - Camera Usage Description
-
Privacy - Microphone Usage Description
-