Android

最近更新时间:2024-09-24 17:43:31

我的收藏

API 简介

VoiceRoomKit 是语音聊天室组件的含UI接口,使用 VoiceRoomKit API,您可以通过简单接口快速实现一个语音聊天室,如果您想要体验并调试语音聊天室效果,请阅读 Demo 快速跑通。如果您想把我们的功能直接集成到您的项目中,请阅读 快速接入(TUILiveKit)
说明:
如果您有自己的 UI 设计,想结合 VoiceRoomKit 业务自行开发,我们同时提供有灵活性更好,功能更全面的 RTC Room Engine SDK,您可以通过查看 RTC Room Engine SDK API 文档,了解更多功能。

API 概述

API
描述
获取一个 VoiceRoomKit 对象实例。
创建一个语音聊天室直播间。
enterRoom
通过 roomId 进入一个语音聊天室直播间。
说明:
如果这组含 UI 的 API 并不能满足您的需求,我们同时提供有灵活性更好,功能更全面的 RTC Room Engine SDK,您可以通过查看我们的 API 文档,了解更多功能。

API 详情

createInstance

获取一个 VoiceRoomKit 对象实例。
static VoiceRoomKit createInstance(Context context)
参数:
参数
类型
说明
默认值
含义
context
Context
必填
-
android 上下文对象
返回值:VoiceRoomKit

createRoom

创建一个语音聊天室直播间。
void createRoom(String roomId, VoiceRoomDefine.CreateRoomParams params);
参数:
参数
类型
说明
默认值
含义
roomId
String
必填
-
直播间 ID
params
必填
-
创建直播间参数
返回值:void

enterRoom

通过 roomId 进入一个语音聊天室直播间。
void enterRoom(String roomId);
参数:
参数
类型
说明
默认值
含义
roomId
String
必填
-
直播间 ID
返回值:void

VoiceRoomDefine 简介

VoiceRoomKit 是语音聊天室的 UIKit 层 数据模型类,主要包含如下数据结构:

CreateRoomParams

创建语音聊天室直播间时的参数对象,主要包含如下配置参数:
参数
类型
说明
默认值
含义
roomName
String

""
语音聊天室名称
maxAnchorCount
int

10
最大上麦的用户数
seatMode
String
必填

上麦模式,分为如下两种:
FREE_TO_TAKE(1):自由上麦模式,台下观众可以自由上麦,无需申请。
APPLY_TO_TAKE(2):申请上麦模式,台下观众上麦需要房主或者管理员同意后才能上麦。