简介
TUIRoomKit API 是多人视频会议组件的含 UI 接口,使用 TUIRoomKit API,您可以通过简单接口快速实现一个会议 app。
说明:
如果您有自己的 UI 设计,想结合 RoomKit 业务自行开发,我们同时提供有灵活性更好,功能更全面的 RTC Room Engine SDK,您可以通过查看我们的 RTC Room Engine SDK API 文档,了解更多功能。
TUIRoomKit
TUIRoomKit
函数列表 | 描述 |
创建 TUIRoomKit 实例(单例模式)。 | |
销毁 TUIRoomKit 实例。 | |
设置个人信息,包括用户名和头像。 | |
创建房间。 | |
进入房间。 |
createInstance
初始化 TUIRoomKit 单例对象。
public static TUIRoomKit createInstance();
destroyInstance
销毁 TUIRoomKit 实例。
public static void destroyInstance();
setSelfInfo
设置个人信息,包括用户名和头像。
public abstract void setSelfInfo(String userName, String avatarURL,TUIRoomDefine.ActionCallback callback);
参数 | 描述 |
userName | 个人的用户名。 |
avatarURL | 个人的头像链接。 |
callback | 设置个人信息是否成功的回调。 |
createRoom
创建房间。
public abstract void createRoom(TUIRoomDefine.RoomInfo roomInfo, TUIRoomDefine.ActionCallback callback);
参数 | 描述 |
roomInfo | 创建房间的参数,包含房间号、房间名称等,其中 roomId 是必填项,其余可为默认值。 |
callback | 创建房间是否成功的回调。 |
enterRoom
进入房间。
public abstract void enterRoom(String roomId,boolean enableAudio,boolean enableVideo,boolean isSoundOnSpeaker, TUIRoomDefine.GetRoomInfoCallback callback);
参数 | 描述 |
roomId | 进入房间的房间号。 |
enableAudio | true 进房打开麦克风,并推送本地音频数据到远端,其他成员可以正常听到本地声音;
false 进房只打开麦克风,不推送本地音频数据到远端,其他成员无法听到本地声音。 |
enableVideo | true 进房打开摄像头,并推送本地视频数据到远端,其他成员可以正常看到本地画面;
false 进房不打开摄像头,也不推送本地视频数据到远端,其他成员无法看到本地画面。 |
isSoundOnSpeaker | 是否使用扬声器播放声音,true 则使用扬声器,false 则使用听筒。 |
callback | 进入房间是否成功的回调。 |