跑通 AUIKaraoke 示例项目

  • iOS

更新时间

了解如何快速接入声网解决方案,完成环境准备、参数配置、示例运行和核心流程验证。

声网在 GitHub 上提供一个开源的 AUIKaraoke 示例项目。本文介绍如何快速跑通该示例项目,体验在线 K 歌场景。

前提条件

  • Git

  • Cocoapods 1.12.1 及以上,如果你未安装 Cocoapods,请参考 Getting Started with CocoaPods 进行安装。

    信息

    如果你的 CocoaPods 版本低于 1.12.1,在运行 pod install 命令时可能会报错,详见常见问题。

  • Xcode 13.0 及以上

  • iOS 设备,版本 13.0 及以上

    信息

    声网推荐使用真机运行项目。部分模拟机可能存在功能缺失或者性能问题。

  • 有效的苹果开发者账号

操作步骤

获取示例项目

运行以下命令克隆仓库到本地:

Shell
git clone git@github.com:AgoraIO-Community/AUIKaraoke.git

配置示例项目

  1. 打开终端,在 AUIKaraoke/iOS/Example 目录下运行 pod update 命令来安装 SDK 和相关依赖。安装完成后,终端会显示 Pod installation complete!。使用 Xcode 打开项目文件夹下新生成的 AUIKaraoke.xcworkspace 文件。

  2. 参考开通含 UI K 歌方案相关服务获取你的声网项目的 App ID、证书,以及环信项目的 APPKEY、Client ID 以及 Client Secret,参考部署后端服务获取你的项目的后端服务的 Host URL,然后将上述信息填入项目的 KeyCenter.swift 文件并保存。

信息

你也可以使用声网提供的测试域名 https://service.shengwang.cn/uikit-v2 来快速体验,但请勿用于正式生产环境中。

Swift
static var HostUrl: String = <#你端后服务域名#>
static var AppId: String = <#你的声网 AppID#>
static var AppCertificate: String = <#你的声网App 证书#>
static var IMAppKey: String = <#你的环信 APPKEY#>
static var IMClientId: String = <#你的环信 Client ID#>
static var IMClientSecret: String = <#你的环信 Client Secret#>

编译并运行示例项目

  1. 将 iOS 设备连接至电脑。

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

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

  4. 点击 Start the active scheme 开始编译。

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

  6. 编译成功后,你的 iOS 设备上会安装好 AUIKaraoke app。打开 App,点击创建房间即可开始体验在线 K 歌。

常见问题

本节提供跑通示例项目时可能遇到的常见问题及解决方案。

Xcode 与 CocoaPods 版本不兼容

如果你的 Xcode 与 CocoaPods 版本不兼容,在跑通本示例项目时可能遇到如下报错:

Shell
can't modify frozen string: "[Xcodeproject] unknown object version (56).

解决方案

方案一

请确保将 Minimum Deployments 设为 13.0,Project Document 下的 Project Format 设为 Xcode 13.0-compatible,如下图所示:

方案二

  1. 升级 CocoaPods 版本。你可以通过运行下列命令来安装特定版本的 CocoaPods:

    Shell
    # 指定你需要升级的 CocoaPods 版本,下列命令以 1.12.1 为例。
    gem install cocoapods -v 1.12.1
  2. (可选)重置 CocoaPods 缓存。有时候 CocoaPods 缓存可能导致问题,你可以通过运行以下命令来清除缓存。

    Shell
    pod cache clean --all
  3. 在 AUIKitKaraoke/iOS/Example 目录下运行重新 pod install 命令来安装 SDK 和相关依赖。安装完成后,终端会显示 Pod installation complete!。

这个页面有帮助吗?