UIKit API
API 简介
VoiceRoomKit 是语音聊天室组件的含UI接口，使用 VoiceRoomKit API，您可以通过简单接口快速实现一个语音聊天室，如果您想要体验并调试语音聊天室效果，请阅读 Demo 快速跑通。如果您想把我们的功能直接集成到您的项目中，请阅读 快速接入(TUILiveKit)。
API 概述
API | 描述 |
获取一个 VoiceRoomKit 对象实例。 | |
创建一个语音聊天室直播间。 | |
通过 roomId 进入一个语音聊天室直播间。 |
API 详情
createInstance
获取一个 VoiceRoomKit 对象实例。
static func createInstance() -> VoiceRoomKit
返回值：VoiceRoomKit
createRoom
创建一个语音聊天室直播间。
func createRoom(roomId: String, params: CreateRoomParams)
参数：
参数 | 类型 | 说明 | 默认值 | 含义 |
roomId | String | 必填 | - | 直播间 ID |
params | 必填 | - | 创建直播间参数 |
返回值：void
enterRoom
通过 roomId 进入一个语音聊天室直播间。
func enterRoom(roomId: String)
参数：
参数 | 类型 | 说明 | 默认值 | 含义 |
roomId | String | 必填 | - | 直播间 ID |
返回值：void
VoiceRoomDefine 简介
VoiceRoomKit 是语音聊天室的 UIKit 层 数据模型类，主要包含如下数据结构:
CreateRoomParams
创建语音聊天室直播间时的参数对象，主要包含如下配置参数：
参数 | 类型 | 说明 | 默认值 | 含义 |
roomName | String | | "" | 语音聊天室名称 |
maxAnchorCount | Int | | 10 | 最大上麦的用户数 |
seatMode | | 必填 | | 上麦模式，分为如下两种： TUISeatModeFreeToTake：自由上麦模式，台下观众可以自由上麦，无需申请。 TUISeatModeApplyToTake：申请上麦模式，台下观众上麦需要房主或者管理员同意后才能上麦。 |