本文為您介紹不含UI在線K歌房的iOS端接入操作指引。

源碼說明

源碼地址

源碼地址請參見iOS源碼

源碼結構

需要用到2個組件庫，AUIRoomCore和AUIMessage，結構如下：

├── AUIRoomCore
│   ├── AUIRoomCore.podspec                // pod描述文件
│       ├── Core                           // 場景化API
│           ├── Model                      // 房間、用戶等模型
│           ├── Service                    // 房間&rtc服務
│           ├── VoiceRoom                  // 語聊場景化API
│           ├── KaraokeRoom                // KTV場景化API，不需要可以刪掉
│       ├── Imp                            // 提供房間服務接口的默認實現
│       ├── Login                          // 用于阿里AUI Demo的的登錄，不需要可以刪掉
│   ├── README.md                          // Readme
├── AUIBaseKits
│    ├── AUIMessage

環境要求

• Xcode 14.0 及以上版本，推薦使用最新正式版本

• CocoaPods 1.9.3 及以上版本

• 準備 iOS 10.0 及以上版本的真機

前提條件

需要開通應用，并且在你的服務端上開發相關接口或直接部署提供的Server源碼，請參見前置準備。

快速集成

以下幾個步驟快速集成不包含UI的在線K歌場景API到你的APP中

• 導入AUIRoomCore和AUIMessage：倉庫代碼下載后，拷貝AUIRoomCore和AUIMessage文件夾到你的APP代碼目錄下，與你的Podfile文件在同一層級

• 修改你的Podfile，引入：

  • AliVCSDK_ARTC：適用于實時音視頻的音視頻終端SDK，也可以使用：AliVCSDK_Standard或AliVCSDK_InteractiveLive，參考iOS端

  • AUIRoomCore：互娛與通話場景API源碼，目前支持語聊/在線K歌房，可以去掉不需要的部分代碼（Login）

  • AUIMessage：房間服務接口的默認實現需要用到AUIMessage及互動消息SDK

#需要iOS10.0及以上才能支持
platform :ios, '10.0'

target '你的App target' do
    # 根據自己的業務場景，集成合適的音視頻終端SDK，支持：AliVCSDK_ARTC、AliVCSDK_Standard、AliVCSDK_InteractiveLive
    pod 'AliVCSDK_ARTC', '~> 6.10.2'

    # 互動消息組件源碼，下載源碼后，與你的Podfile文件在同一層級，房間服務接口的默認實現需要用到AUIMessage及互動消息SDK
    pod 'AUIMessage/AliVCIM', :path => "./AUIMessage/"

    # 互娛語聊場景核心組件，指定依賴的SDK為AliVCSDK_ARTC，需要與上面指定的SDK名字一致
    pod 'AUIRoomCore/AliVCSDK_ARTC', :path => "./AUIRoomCore/"

    # 引入在線K歌房API
    pod 'AUIRoomCore/KaraokeRoomAPI', :path => "./AUIRoomCore/"
end

• 執行“pod install --repo-update”

• 源碼集成完成

工程配置

• 打開工程info.Plist，添加NSMicrophoneUsageDescription權限

• 打開工程設置，在”Signing & Capabilities“中開啟“Background Modes”

源碼配置

• 完成前提條件后，進入文件ARTCRoomRTCService.swift，修改實時音視頻應用appID

// ARTCRoomRTCService.swift
@objcMembers public class ARTCRoomConfig: NSObject {
    
    public var appId = "你的appID"
    ...
}

調用API示例

前面工作完成后，在開發自身UI后，可以調用在線K歌房API接口實現業務功能。

可以參考源碼倉庫中的AUIKaraokeRoom組件的AUIKaraokeRoomViewController類。