跑通 API 示例项目

  • iOS

更新时间

了解如何快速接入实时互动 RTC,完成环境准备、参数配置、示例运行和核心流程验证。

声网提供开源示例项目演示 RTC SDK 的 API 使用示例,以帮助开发者更好地理解和运用声网 SDK 的功能。本文以跑通视频通话示例项目为例,帮助你快速体验声网视频通话效果。

前提条件

  • 可以访问互联网的计算机。请确保你的网络环境未部署防火墙,否则可能无法正常使用声网服务。

  • Xcode 13.0 或以上版本。

  • 已安装 Cocoapods。如尚未安装 Cocoapods,参考 Getting Started with CocoaPods 安装说明。

  • 两台 iOS 14.0 以上版本的设备。

  • 一个有效的声网账号以及声网项目。请参考开通 RTC 服务从声网控制台获得以下信息:

    • App ID:声网随机生成的字符串,用于识别你的项目。
    • App 证书(可选):用于生成 Token 的字符串。如果你的项目启用了允许仅 App ID 加入,则不需要获取该字段。
  • Apple 开发者账号。

操作步骤

获取示例项目

你可以从如下两种方式中任选一种获取示例项目:

  • 前往下载页面,下载最新版的 iOS 视频 SDK,然后解压。

  • 前往声网在 GitHub 上提供的示例项目,然后运行以下命令将仓库克隆至本地。

    Shell
    git clone git@github.com:AgoraIO/API-Examples.git

    信息

    声网在仓库中为 iOS 平台提供了视频示例项目和音频示例项目,分别位于 /iOS/APIExample 和 /iOS/APIExample-Audio 路径下。

配置示例项目

  1. 打开示例项目文件夹,在 samples/APIExample/APIExample/Common/KeyCenter.swift 文件中填写你从声网控制台获取到的 App ID 和 App 证书(如果项目启用了允许仅 App ID 加入,则 Certificate 字段留空)。

    Swift
    class KeyCenter: NSObject {
        // 把 <#Your App ID#> 替换成你的 App ID,并加引号,如 "xxxxxx"
        static let AppId: String = <#Your App ID#>
        // 把 #YOUR Certificate# 替换成你的 App 证书,并加引号,如 "xxxxxx";该字段可为空
        static let Certificate: String? = <#YOUR Certificate#>
      }
  2. 打开终端,在 samples/API-Example 目录下运行 pod install 安装 SDK 或相关依赖。安装完成后,终端会显示 Pod installation complete!。按照如下提示,使用 Xcode 打开项目文件夹下新生成的 APIExample.xcworkspace 文件。

    Ruby
    [!] Please close any current Xcode sessions and use `APIExample.xcworkspace` for this project from now on.
    Pod installation complete! There are 4 dependencies from the Podfile and 4 total pods installed.

编译并运行示例项目

  1. 将 iOS 设备连接至电脑,在设备上打开 设备 > 隐私与安全性 > 安全性,打开开发者模式。

  2. 在 Xcode 界面顶部的 iOS Device 选项中勾选你的 iOS 设备。

  3. 在项目 TARGETS 下的 Signing & Capabilities 界面勾选 Automatically manage signing,然后在每一个 Target 下配置你的苹果开发者账号和 Bundle Identifier。

  4. 点击 开始图标 开始编译。

  5. 编译成功后,你的 iOS 设备上会出现 APIExample App 图标。

  6. (可选)如果设备上弹出不受信任的开发者提示,则首先点击取消关闭该提示,然后在 iOS设备上打开设置 > 通用 > VPN 与设备管理,在开发者 APP 中选择信任该开发者。

  7. 打开 API Example,选择一个你想要尝试的场景,然后输入频道名(如 test),并点击加入频道按钮。

  8. 为更好地体验各种音视频互动场景,你可以邀请一位朋友使用另一台设备运行该示例项目(需确保 samples/APIExample/APIExample/Common/KeyCenter.swift 中的 App ID 和 App 证书不变)。当你们输入相同的频道名加入频道后,即可在同一频道中体验各种互动场景。