快速集成

  • iOS

更新时间

了解如何快速接入 1v1 私密房 RTM 方案,完成环境准备、参数配置、示例运行和核心流程验证。

在实现 1v1 私密房和秀场转 1v1 之前,你需要将声网 CallAPI 集成到项目中。本文介绍如何将源码添加到你的项目中,并进行必要的项目设置。

前提条件

开始前,请确保满足如下前提条件:

  • CocoaPods。
  • Xcode 12.0 及以上。
  • 有效的苹果开发者账号。

集成步骤

1. 创建项目

如果你没有 iOS 项目,参考如下步骤先创建一个。如果本地已有项目,可以跳过本步骤,直接参考 2. 添加依赖。

  1. 参考 Create a project 在 Xcode 中创建一个项目。

  2. 为你的项目设置自动签名。

  3. 设置部署你的 App 的目标设备。

  4. 在项目导航栏中打开 info.plist 文件,编辑属性列表,添加 1v1 私密房所需的录音和摄像头权限。

    keytypevalue
    Privacy - Microphone Usage DescriptionString使用麦克风的目的,例如:for 1v1。
    Privacy - Camera Usage DescriptionString使用摄像头的目的,例如:for 1v1。
    表格内容超出当前宽度,可横向滚动查看更多列。

2. 添加依赖

参考如下步骤将 CallAPI 添加到项目中。

  1. 下载或克隆 CallAPI 源码。

  2. 将 iOS 下的 CallAPI 文件夹和 CallAPI.podspec 文件拷贝到项目文件夹中,和 Podfile 文件同级。

  3. 在 Podfile 文件中添加如下行,添加对 CallAPI 的依赖:

    Ruby
    pod 'CallAPI', :path => 'CallAPI.podspec'
  4. 打开 Terminal,执行如下命令,将 CallAPI 代码集成进你的项目中:

    Shell
    pod install

3.(可选)检查版本兼容性

如果你的项目之前集成过声网的 RTC 或者 RTM SDK,请确保 SDK 的版本号与 CallAPI 兼容:

  • RTC SDK:不低于 4.1.1.26
  • RTM SDK:不低于 2.2.0

如果版本号与 CallAPI 不兼容,可以直接在 CallAPI.podspec 文件中修改对应的 SDK 版本:

Ruby
s.dependency 'AgoraRtcEngine_Special_iOS', '4.1.1.26'
s.dependency 'AgoraRtm_iOS', '2.2.0'

信息

如需使用 AudioScenarioAPI 提升音频体验,需要将 RTC SDK 版本设置为 4.1.1.29,详情可参考 设置优质音频体验。

后续步骤

完成集成后,你就可以根据业务需要添加相应的功能到你的项目中: