集成智能云会议

  • iOS

更新时间

了解如何快速接入智能云会议,完成环境准备、参数配置、示例运行和核心流程验证。

本文介绍如何将智能云会议集成到你的 iOS 项目中。

前提条件

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

  • Xcode 12.0 或以上版本。
  • 有效的 Apple 开发者账号。
  • iOS 设备,版本 11.0 或以上。
  • 可以访问互联网的计算机。确保你的网络环境没有部署防火墙,否则无法正常使用声网服务。
  • 已开通智能云会议服务。

(可选)创建项目

如需创建一个新的 iOS 项目来集成智能云会议,你可以参考如下步骤在 Xcode 创建项目:

  1. 创建一个新的项目,Application 选择 App,Interface 选择 Storyboard,Language 选择 Swift。

    注意

    如果你没有添加过开发团队信息,会看到 Add account… 按钮。点击该按钮并按照屏幕提示登入 Apple ID,点击 Next,完成后即可选择你的 Apple 账户作为开发团队。

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

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

  4. 在 General 标签页中设置 Minimum Deployments 为 iOS 11.0。

通过 CocoaPods 集成依赖

  1. 开始前,确保你已安装 CocoaPods。如果尚未安装,可参考 Getting Started with CocoaPods 进行安装操作。

    在终端输入以下命令检查 CocoaPods 是否安装成功:

    Shell
    pod --version

    如果安装成功,终端会打印出版本信息,例如 1.11.3。

  2. 在终端里进入项目文件夹(即 *.xcodeproj 文件所在目录),并运行 pod init 命令。项目文件夹下会生成一个 Podfile 文本文件。

  3. 打开 Podfile 文件,修改文件为如下内容,以引用智能云会议所依赖的库:

    Ruby
    platform :ios, '11.0'
    use_frameworks!
    
    target 'YourTargetName' do
        pod 'FcrUIScene', '3.1.0'
        pod "AgoraRtm_OC_Special", '2.2.1.1'
    end
  4. 在终端里进入项目文件夹,运行如下命令安装依赖。

    Shell
    pod install

    以灵动会议 v3.1.0 为例,安装过程中终端会打印如下信息:

    Shell
    Analyzing dependencies
    Downloading dependencies
    Installing FcrUIScene (3.1.0)
    Installing FcrCore (3.1.0)
    Generating Pods project
    Integrating client project

添加设备权限

为确保智能云会议能正常使用,你需要添加必要的设备权限。在 Xcode 项目导航栏中打开 Info.plist 文件,编辑属性列表,添加以下属性:

keytypevalue
Privacy - Camera Usage DescriptionString填写使用相机的目的
Privacy - Microphone Usage DescriptionString填写使用麦克风的目的
Privacy - Photo Library Additions Usage DescriptionString填写访问和添加照片或视频到图库的目的
Privacy - Photo Library Usage DescriptionString填写访问图库的目的
表格内容超出当前宽度,可横向滚动查看更多列。

启动智能云会议

本节介绍如何调用客户端 API 启动智能云会议。开始前,请确保已通过服务端 RESTful API 创建了房间。

  1. 创建一个 FcrUISceneCreator 对象,并调用 launch 启动智能云会议。
import FcrUIScene

let config = FcrUISceneCreatorConfig(appId: appId,
                                     userId: userId)

let creator = FcrUISceneCreator(config: config)

let sceneConfig = FcrUISceneConfig(roomId: roomId,
                                   roomToken: token,
                                   userName: userName,
                                   userRole: userRole,
                                   inviteLink: inviteLink,
                                   userProperties: nil,
                                   resource: resource)

creator.launch(config: sceneConfig,
               cancel: {
                   print("cancel")
               }, success: { scene in
                   print("success")
               }, failure: { error in
                   print("failure")
               }, parent: viewController)

填写参数时可参考 FcrUISceneCreatorConfig 和 FcrUISceneConfig 的 API 文档。需关注的核心参数如下:

参数类型描述
appIdString项目的 App ID。详见获取 App ID。
userIdString

用户 ID,是用户的唯一标识符,不可重复取值。长度在 64 字符以内。支持的字符集范围(共 36 个字符):

  • 26 个小写英文字母 a~z
  • 10 个数字 0-9
roomTokenString

用于鉴权的 Token。详见控制台生成临时 Token 或服务端生成正式 Token。

注意

临时 Token 仅适用于集成测试和体验。在生产环境中,请使用正式 Token 以确保安全。无论是临时 Token 还是正式 Token,有效期最长都是 24 小时,请尽快使用。

表格内容超出当前宽度,可横向滚动查看更多列。
  1. (可选)如需主动退出会议,调用 exit 退出智能云会议。
// 退出会议
scene.exit()

// 释放 FcrUISceneCreator 与 FcrUIScene 对象
// ...

日志文件路径

智能云会议默认的日志文件在 App Sandbox/Library/Caches/AgoraLog/ 目录下。

开发注意事项

在 Xcode 14.0 及更高版本中,如果遇到以下问题,可以在你的 Podfile 中添加代码来解决:

  • Bundle 需要签名:例如 FcrUIScene-FcrUIScene 的 Bundle 在构建时需要进行签名。
  • Pod 引用的库版本过低:引用的库不满足项目所需的最低 iOS 版本要求(11.0),导致兼容性问题。
  • 启用 bitcode 支持导致错误:启用 bitcode 支持可能导致构建错误或其他兼容性问题,因此需要关闭 bitcode 支持。
  • 依赖库中会多导入一个 aosl.xcframework:目前通过 pre_install 移除重复导入的 aosl.xcframework。

Podfile 中添加的代码示例如下:

Ruby
post_install do |installer|
  installer.pods_project.targets.each do |target|
    target.build_configurations.each do |config|

      # 针对 Xcode 14 及以上版本,禁用对 Bundle 类型目标的签名,以避免构建错误
      if target.respond_to?(:product_type) and target.product_type == "com.apple.product-type.bundle"
        config.build_settings['CODE_SIGNING_ALLOWED'] = 'NO'
      end

      # 确保 iOS 部署版本至少为 11.0,以避免兼容性问题
      deployment = config.build_settings['IPHONEOS_DEPLOYMENT_TARGET']
      if deployment.to_f < 11.0
        config.build_settings['IPHONEOS_DEPLOYMENT_TARGET'] = '11.0'
      end

      # 关闭 bitcode 支持
      config.build_settings['ENABLE_BITCODE'] = 'NO'
    end
  end
end

pre_install do |installer|
  # 移除重复导入的 aosl.xcframework
  pods_root = installer.sandbox.root
  duplicated_frameworks = Dir.glob("#{pods_root}/**/aosl.xcframework")

  if duplicated_frameworks.size > 1
    duplicated_frameworks.drop(1).each do |framework_path|
      FileUtils.rm_rf(framework_path)
    end
  end
end