TUIRoomKit

最近更新时间：2024-03-05 10:42:51

我的收藏

本页目录：

Copyright (c) 2021 Tencent. All rights reserved.
﻿
Module：TUIRoomKit
Function：多人音视频主功能接口
Version：1.5
TUIRoomKit
TUIRoomKit
函数列表
描述
﻿createInstance﻿
创建 TUIRoomKit 实例（单例模式）。
﻿destroyInstance﻿
登录接口，您需要先初始化用户信息后才能进入房间，并进行一系列的操作。
﻿setSelfInfo﻿
设置个人信息，包括用户名和头像。
﻿createRoom﻿
创建房间。
﻿enterRoom﻿
进入房间。
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
进入房间是否成功的回调。

上一篇: API 概览下一篇: TUIRoomEngine

函数列表	描述
createInstance	创建 TUIRoomKit 实例（单例模式）。
destroyInstance	登录接口，您需要先初始化用户信息后才能进入房间，并进行一系列的操作。
setSelfInfo	设置个人信息，包括用户名和头像。
createRoom	创建房间。
enterRoom	进入房间。

参数	描述
userName	个人的用户名。
avatarURL	个人的头像链接。
callback	设置个人信息是否成功的回调。

参数	描述
roomInfo	创建房间的参数，包含房间号、房间名称等，其中 roomId 是必填项，其余可为默认值。
callback	创建房间是否成功的回调。

参数	描述
roomId	进入房间的房间号。
enableAudio	true 进房打开麦克风，并推送本地音频数据到远端，其他成员可以正常听到本地声音。 false 进房只打开麦克风，不推送本地音频数据到远端，其他成员无法听到本地声音。
enableVideo	true 进房打开摄像头，并推送本地视频数据到远端，其他成员可以正常看到本地画面。 false 进房不打开摄像头，也不推送本地视频数据到远端，其他成员无法看到本地画面。
isSoundOnSpeaker	是否使用扬声器播放声音，true 则使用扬声器，false 则使用听筒。
callback	进入房间是否成功的回调。