Example

AUIKaraoke iOS 示例工程快速跑通

本文档主要介绍如何快速跑通 AUIKaraoke 示例工程，体验在线 K 歌场景，包括麦位管理、用户管理、歌曲管理、歌曲播放等，更详细的介绍，请参考AUIKit

架构图

AUIKitKaraoke 依赖于 ASceneKit，ASceneKit 依赖于底层的 AUIKit。详细说明如下：

• AUIKitKaraoke：代表K歌 App（开发者自行开发维护的部分）。
  • ViewController App 中房间列表页面和单个房间的详情页面。
  • KaraokeUIKit：负责统一调度 KaraokeRoomView 和 AUIKaraokeRoomService，并管理房间。
• AScenesKit：为K歌场景提供业务逻辑的组装模块（由声网提供并维护）。
  • KaraokeRoomView：K歌的容器 View。用于管理 AUIKit 提供的 UI。
  • AUIKaraokeRoomService：K歌的 Service。用于管理 AUIKit 提供的 Service。
  • ViewBinder：用于将 KaraokeRoomView 和 AUIKaraokeRoomService 绑定。
• AUIKit：基础库（由声网提供并维护） 。
  • UI：基础 UI 组件。
  • Service：上麦、聊天、送礼物等业务能力。
  • Manager：RTM管理（AUIRtmManager）、房间（AUIRoomMananager）管理等

目录结构

┌─ Example                     // Demo代码集成目录
│  └─ AUIKaraoke               // 主要提供 Karaoke 的集成页面
├─ AUiScenesKit                // 场景业务组装模块，目前只包含Karaoke
│  ├─ AUIKaraokeRoomView       // Karaoke房间容器View，用于拼接各个基础组件以及基础组件与Service的绑定
│  ├─ AUIKaraokeRoomService    // Karaoke房间Service，用于创建各个基础Service以及RTC/RTM/KTVAPi等的初始化
│	 └─ Binder                   // 把UI Components和Service关联起来的业务绑定模块
└─ AUIKit                      // 包含基础组件和基础服务
   ├─ Service                  // 相关基础组件服务类，包括麦位、点歌器、用户管理、合唱等
   ├─ UI Widgets               // 基础UI组件，支持通过配置文件进行一键换肤
   └─ UI Components            // 相关基础业务UI模块，包括麦位、点歌、歌曲播放等，这些UI模块不包含任何业务逻辑，是纯UI模块

环境准备

• Xcode 13.0及以上版本
• 最低支持系统：iOS 13.0
• 请确保您的项目已设置有效的开发者签名

运行示例

运行示例

• 克隆或者直接下载项目源码

• 获取声网 App ID 和 App 证书 -------- 声网 Docs - 解决方案 - 声动语聊 - 快速开始 - 开通服务

  • 登录声网控制台，如果没有账号则注册一个

  • 点击创建应用

    

  • 选择K歌场景

    

  • 保存 App ID 和 App 证书

    

• 配置实时消息RTM

  • 进入声网控制台

  • 启用实时消息RTM -------- 进入控制台 -> 选择项目 -> 全部产品 -> 基础能力 -> 实时消息 —> 功能配置 -> 启用

    

  • 启用 Storage 和 Lock

    

• 获取环信 AppKey、Client ID和Client Secret

  • 登录环信通讯云控制台，如果没有账号则创建一个

  • 创建项目

    

  • 复制AppKey、Client ID和Client Secret

    

• 联系销售给 AppID 开通 K 歌权限(如果您没有销售人员的联系方式可通过智能客服联系销售人员 Agora 支持)

    注: 拉取声网版权榜单、歌单、歌曲、歌词等功能是需要开通权限的

• 获取后台服务域名

  本项目依赖一个后台服务，该后台服务主要提供下面几个功能：

  • 房间管理
  • Rtc/Rtm Token生成
  • 环信IM聊天房创建

  后台代码完全开源，部署教程见后台部署，部署完即可拿到后台服务域名。

  如果开发者不想或者不熟悉怎么部署后台服务，在已经获取到上面配置的App ID、App 证书等后，可以使用声网提供的测试域名：https://service.shengwang.cn/uikit

  但是注意这个域名仅供测试，不能商用！

4. 配置并运行项目

• 克隆或者直接下载项目源码

• 在项目的KeyCenter.swift 里配置上面获取到的 App ID、App 证书等

  static var HostUrl: String = <#您的后台服务域名#>
  static var AppId: String = <#您的声网AppID#>
  static var AppCertificate: String = <#您的声网App证书#>
  static var AppBasicAuth: String = <#您的声网认证Basic Auth#>
  static var IMAppKey: String = <#您的环信IM AppKey#>
  static var IMClientId: String = <#您的环信IM Client ID#>
  static var IMClientSecret: String = <#您的环信IM Client Secret#>
  

• 打开终端，进入到Podfile目录下，执行pod update命令

  • 建议cocoapods升级到1.12.0以上，如果您的cocoapods版本低于1.12.0，可能会遇到如下错误

  the version of cocoapods to generate the lockfile(1.12.0) is higher than the version of the current executable(1.11.2). 
  

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

  请打开AUIKaraoke.xcodeproj并按照下图修改为"Xcode 13.0-compatible"

• 最后打开AUIKaraoke.xcworkspace，运行即可开始您的体验

  • 如果您的cocoapods版本低于1.12.0，会遇到如下错误，请在"Team"里手动设置签名

快速集成及自定义功能

如果需要在自己的项目里集成KaraokeUIKit或者自定义功能，请查看KaraokeUIKit

常见问题

• 常见问题
• 如有其他问题请反馈至 开发者社区

许可证

版权所有 Agora, Inc. 保留所有权利。 使用 MIT 许可证