腾讯云实时音视频TUIRoomEngine_音视频解决方案_同尘科技

Copyright (c) 2021 Tencent. All rights reserved.
Module: TUIRoomEngine @ TUIKitEngineFunction: TUIRoomEngine 主功能接口Version: 1.5
TUIRoomEngine

TUIRoomEngine

函数列表	描述
createInstance	创建 TUIRoomEngine 实例
destroyInstance	销毁 TUIRoomEngine 实例
login	登录接口，您需要先初始化用户信息后才能进入房间，并进行一系列的操作
logout	退出登录接口，会有主动离开房间操作、销毁资源
setSelfInfo	设置本地用户名称和头像
getSelfInfo	获取本地用户登录的基本信息
setSelfInfo	设置本地用户信息
addObserver	设置事件回调
removeObserver	移除事件回调
createRoom	创建房间
destroyRoom	解散房间
enterRoom	进入房间
exitRoom	离开房间
connectOtherRoom	连接其他房间
disconnectOtherRoom	断开与其他房间的连接
fetchRoomInfo	获取房间信息
updateRoomNameByAdmin	更新房间名称（只有管理员或房主能够调用）
updateRoomSpeechModeByAdmin	设置房间麦控模式（只有管理员或房主能够调用）
setLocalVideoView	设置本地用户视频渲染的视图控件
openLocalCamera	打开本地摄像头
closeLocalCamera	关闭本地摄像头
startPushLocalVideo	开始推送本地视频。默认开启
stopPushLocalVideo	停止推送本地视频
updateVideoQuality	更新本地视频编码质量设置
updateVideoQualityEx	设置视频编码器的编码参数
setVideoResolutionMode	设置视频编码器分辨率模式（横屏分辨率 or 竖屏分辨率）
enableGravitySensor	开启重力感应模式
startScreenSharing	开始屏幕分享（该接口仅支持移动端）
stopScreenSharing	结束屏幕分享
openLocalMicrophone	打开本地麦克风
closeLocalMicrophone	关闭本地麦克风
muteLocalAudio	暂停发布本地的音频流
unmuteLocalAudio	恢复发布本地的音频流
setRemoteVideoView	设置远端用户视频渲染的视图控件
startPlayRemoteVideo	开始播放远端用户视频
stopPlayRemoteVideo	停止播放远端用户视频
muteRemoteAudioStream	将远端用户禁音
getUserList	获取房间内的成员列表
getUserInfo	获取成员信息
changeUserRole	修改用户角色（只有管理员或房主能够调用）
kickRemoteUserOutOfRoom	将远端用户踢出房间（只有管理员或房主能够调用）
addCategoryTagForUsers	为用户增加标记（只有房主能够调用）
removeCategoryTagForUsers	为用户移除标记（只有房主能够调用）
getUserListByTag	根据标记获取房间内用户信息
disableDeviceForAllUserByAdmin	全体用户媒体设备管理
openRemoteDeviceByAdmin	请求远端用户打开媒体设备（只有管理员或房主能够调用）
closeRemoteDeviceByAdmin	关闭远端用户媒体设备（只有管理员或房主能够调用）
applyToAdminToOpenLocalDevice	请求打开本地媒体设备（普通用户可用）
setMaxSeatCount	设置最大麦位数（仅支持进房前和创建房间时设置）
getSeatList	获取麦位列表
lockSeatByAdmin	锁定麦位（只有管理员或群主能够调用，包括位置锁定、音频状态锁定和视频状态锁定）
takeSeat	上麦（上麦发言模式下，需要申请）
leaveSeat	下麦
takeUserOnSeatByAdmin	主持人/管理员 邀请用户上麦
kickUserOffSeatByAdmin	主持人/管理员 将用户下麦
sendTextMessage	发送本文消息
sendCustomMessage	发送自定义消息
disableSendingMessageByAdmin	禁用远端用户的发送文本消息能力（只有管理员或房主能够调用）
disableSendingMessageForAllUser	禁用所有用户的发送文本消息能力（只有管理员或房主能够调用）
cancelRequest	取消请求
responseRemoteRequest	回复请求
switchCamera	切换前置或后置摄像头（仅适用于移动端）
setBeautyLevel	设置美颜级别
setWhitenessLevel	设置美白级别
callExperimentalAPI	调用实验性接口



createInstance

createInstance

创建 TUIRoomEngine 实例

注意如果您使用 createInstance 获取 TUIRoomEngine 实例，并请使用 destroyInstance 释放对象指针。

destroyInstance

destroyInstance

销毁 TUIRoomEngine 实例

注意使用 destroyInstance 释放对象指针。

login

login

void login	(Context context
	int sdkAppId
	String userId
	String userSig
	TUIRoomDefine.ActionCallback callback)

登录接口，您需要先初始化用户信息后才能进入房间，并进行一系列的操作

参数	描述
callback	调用接口的回调，用于通知接口调用的成功或者失败
context	仅适用于 Android 平台，SDK 内部会将其转化为 Android 平台的 ApplicationContext 用于调用 Android System API。
sdkAppId	它是腾讯云用于区分客户的唯一标识，进入腾讯云实时音视频 控制台创建应用，即可看到SDKAppId
userId	用户ID，用于区分不同用户
userSig	用户签名，用于腾讯云流量的认证



logout

logout

void logout

(TUIRoomDefine.ActionCallback callback)

退出登录接口，会有主动离开房间操作、销毁资源

参数	描述
callback	调用接口的回调，用于通知接口调用的成功或者失败

setSelfInfo

setSelfInfo

void setSelfInfo	(String userName
	String avatarURL
	TUIRoomDefine.ActionCallback callback)

设置本地用户名称和头像

参数	描述
avatarURL	用户头像URL地址
callback	调用接口的回调，用于通知接口调用的成功或者失败
userName	用户名称

getSelfInfo

getSelfInfo

获取本地用户登录的基本信息

返回值说明：

LoginUserInfo 用户登录信息

setSelfInfo

setSelfInfo

void setSelfInfo	(TUIRoomDefine.LoginUserInfo userInfo
	TUIRoomDefine.ActionCallback callback)

设置本地用户信息

参数	描述
callback	调用接口的回调，用于通知接口调用的成功或者失败
userInfo	本地用户信息

addObserver

addObserver

void addObserver

(TUIRoomObserver observer)

设置事件回调

您可以通过 TUIRoomObserver 获得各类事件通知（比如：错误码，远端用户进房，音视频状态参数等）

参数	描述
observer	监听的实例

removeObserver

removeObserver

void removeObserver

(TUIRoomObserver observer)

移除事件回调

参数	描述
observer	待移除的监听回调实例

createRoom

createRoom

void createRoom	(TUIRoomDefine.RoomInfo roomInfo
	TUIRoomDefine.ActionCallback callback)

创建房间

参数	描述
callback	调用接口的回调，用于通知接口调用的成功或者失败
roomInfo	房间信息，可以初始化房间的一些设置

destroyRoom

destroyRoom

void destroyRoom

(TUIRoomDefine.ActionCallback callback)

解散房间

参数	描述
callback	调用接口的回调，用于通知接口调用的成功或者失败

enterRoom

enterRoom

void enterRoom	(String roomId
	TUIRoomDefine.GetRoomInfoCallback callback)

进入房间

参数	描述
callback	调用接口的回调，用于通知接口调用的成功或者失败
roomId	房间ID

exitRoom

exitRoom

void exitRoom	(boolean syncWaiting
	TUIRoomDefine.ActionCallback callback)

离开房间

参数	描述
callback	调用接口的回调，用于通知接口调用的成功或者失败
syncWaiting	是否同步等待接口返回

connectOtherRoom

connectOtherRoom

Request connectOtherRoom	(String roomId
	String userId
	int timeout
	TUIRoomDefine.RequestCallback callback)

连接其他房间

参数	描述
callback	调用接口的回调，用于通知接口调用的成功或者失败
roomId	房间ID
timeout	超时时间，单位秒，如果设置为 0，SDK 不会做超时检测，也不会触发超时回调
userId	用户ID

注意用于直播场景下的申请跨房连麦

返回值说明：

TUIRequest 请求体

disconnectOtherRoom

disconnectOtherRoom

void disconnectOtherRoom

(TUIRoomDefine.ActionCallback callback)

断开与其他房间的连接

参数	描述
callback	调用接口的回调，用于通知接口调用的成功或者失败

注意用于直播场景下的断开跨房连麦

fetchRoomInfo

fetchRoomInfo

void fetchRoomInfo

(TUIRoomDefine.GetRoomInfoCallback callback)

获取房间信息

参数	描述
callback	调用接口的回调，用于通知接口调用的成功或者失败

updateRoomNameByAdmin

updateRoomNameByAdmin

void updateRoomNameByAdmin	(String roomName
	TUIRoomDefine.ActionCallback callback)

更新房间名称（只有管理员或房主能够调用）

参数	描述
callback	调用接口的回调，用于通知接口调用的成功或者失败
roomName	房间名称

updateRoomSpeechModeByAdmin

updateRoomSpeechModeByAdmin

void updateRoomSpeechModeByAdmin	(TUIRoomDefine.SpeechMode mode
	TUIRoomDefine.ActionCallback callback)

设置房间麦控模式（只有管理员或房主能够调用）

参数	描述
callback	调用接口的回调，用于通知接口调用的成功或者失败
mode	FREE_TO_SPEAK: 自由发言模式, 用户可以自由开启麦克风和扬声器;APPLY_TO_SPEAK: 申请发言模式，用户requestOpenLocalMicrophone 或 requestOpenLocalCamera 向房主或管理员申请后，方可打开麦克风和摄像头开始发言SPEAK_AFTER_TAKING_SEAT: 上麦发言模式，KConference房间内，所有人在发言前，必须takeSeat，才能进行麦克风和摄像头操作。

setLocalVideoView

setLocalVideoView

void setLocalVideoView	(TUIRoomDefine.VideoStreamType streamType
	TUIVideoView view)

设置本地用户视频渲染的视图控件

参数	描述
streamType	视频流的类型，定义可参考 VideoStreamType 的定义
view	视频渲染视图

openLocalCamera

openLocalCamera

void openLocalCamera	(boolean isFront
	TUIRoomDefine.VideoQuality quality
	TUIRoomDefine.ActionCallback callback)

打开本地摄像头

参数	描述
callback	调用接口的回调，用于通知接口调用的成功或者失败
isFront	true: 前置 false: 后置。 该参数只在移动端生效

closeLocalCamera

closeLocalCamera

关闭本地摄像头

startPushLocalVideo

startPushLocalVideo

开始推送本地视频。默认开启

stopPushLocalVideo

stopPushLocalVideo

停止推送本地视频

updateVideoQuality

updateVideoQuality

void updateVideoQuality

(TUIRoomDefine.VideoQuality quality)

更新本地视频编码质量设置

updateVideoQualityEx

updateVideoQualityEx

void updateVideoQualityEx	(TUIRoomDefine.VideoStreamType streamType
	TUIRoomDefine.VideoEncoderParams params)

设置视频编码器的编码参数

参数	描述
params	视频编码器的编码参数，定义可参考 VideoEncoderParams 的定义
streamType	视频流的类型，定义可参考 VideoStreamType 的定义

setVideoResolutionMode

setVideoResolutionMode

void setVideoResolutionMode	(TUIRoomDefine.VideoStreamType streamType
	TUIRoomDefine.ResolutionMode resolutionMode)

设置视频编码器分辨率模式（横屏分辨率 or 竖屏分辨率）

参数	描述
resolutionMode	分辨率模式，定义可参考 ResolutionMode 的定义
streamType	视频流的类型，定义可参考 VideoStreamType 的定义

enableGravitySensor

enableGravitySensor

void enableGravitySensor

(boolean enable)

开启重力感应模式

参数	描述
enable	true: 开启 false: 关闭

注意开启该模式后，当前用户发布出去的视频画面会跟随设备的重力感应方向进行相应的调整，同时本地预览画面保持方向不变

startScreenSharing

startScreenSharing

开始屏幕分享（该接口仅支持移动端）

stopScreenSharing

stopScreenSharing

结束屏幕分享

openLocalMicrophone

openLocalMicrophone

void openLocalMicrophone	(TUIRoomDefine.AudioQuality quality
	TUIRoomDefine.ActionCallback callback)

打开本地麦克风

参数	描述
callback	调用接口的回调，用于通知接口调用的成功或者失败

closeLocalMicrophone

closeLocalMicrophone

关闭本地麦克风

muteLocalAudio

muteLocalAudio

暂停发布本地的音频流

unmuteLocalAudio

unmuteLocalAudio

void unmuteLocalAudio

(TUIRoomDefine.ActionCallback callback)

恢复发布本地的音频流

参数	描述
callback	调用接口的回调，用于通知接口调用的成功或者失败



setRemoteVideoView

setRemoteVideoView

void setRemoteVideoView	(String userId
	TUIRoomDefine.VideoStreamType streamType
	TUIVideoView view)

设置远端用户视频渲染的视图控件

参数	描述
streamType	视频流的类型，定义可参考 VideoStreamType 的定义
userId	远端用户ID
view	视频渲染视图

startPlayRemoteVideo

startPlayRemoteVideo

void startPlayRemoteVideo	(String userId
	TUIRoomDefine.VideoStreamType streamType
	TUIRoomDefine.PlayCallback callback)

开始播放远端用户视频

参数	描述
callback	调用接口的回调，用于通知播放时的状态回调
streamType	视频流的类型 详细定义可以参考 VideoStreamType 的定义
userId	用户ID

stopPlayRemoteVideo

stopPlayRemoteVideo

void stopPlayRemoteVideo	(String userId
	TUIRoomDefine.VideoStreamType streamType)

停止播放远端用户视频

参数	描述
streamType	视频流的类型 详细定义可以参考 VideoStreamType 的定义
userId	用户ID

muteRemoteAudioStream

muteRemoteAudioStream

void muteRemoteAudioStream	(String userId
	boolean isMute)

将远端用户禁音

参数	描述
isMute	是否禁音
userId	用户ID

getUserList

getUserList

void getUserList	(long nextSequence
	TUIRoomDefine.GetUserListCallback callback)

获取房间内的成员列表

参数	描述
callback	调用接口的回调，用于通知接口调用的成功或者失败。成功回调中包含 UserInfo list
nextSequence	分页拉取标志，第一次拉取填0，回调成功 如果callback返回的数据中 nextSequence 不为零，需要分页，传入再次拉取，直至为0

getUserInfo

getUserInfo

void getUserInfo	(String userId
	TUIRoomDefine.GetUserInfoCallback callback)

获取成员信息

参数	描述
callback	调用接口的回调，用于通知接口调用的成功或者失败
userId	用户ID

changeUserRole

changeUserRole

void changeUserRole	(String userId
	TUIRoomDefine.Role role
	TUIRoomDefine.ActionCallback callback)

修改用户角色（只有管理员或房主能够调用）

参数	描述
callback	调用接口的回调，用于通知接口调用的成功或者失败
role	用户角色 详细定义可以参考 Role 的定义
userId	用户ID

kickRemoteUserOutOfRoom

kickRemoteUserOutOfRoom

void kickRemoteUserOutOfRoom	(String userId
	TUIRoomDefine.ActionCallback callback)

将远端用户踢出房间（只有管理员或房主能够调用）

参数	描述
callback	调用接口的回调，用于通知接口调用的成功或者失败
userId	用户ID

addCategoryTagForUsers

addCategoryTagForUsers

void addCategoryTagForUsers	(int tag
	List userList
	TUIRoomDefine.ActionCallback callback)

为用户增加标记（只有房主能够调用）

参数	描述
callback	调用接口的回调，用于通知接口调用的成功或者失败
tag	标记类型。数字类型，大于等于 1000，您可以自定义。
userList	用户列表

removeCategoryTagForUsers

removeCategoryTagForUsers

void removeCategoryTagForUsers	(int tag
	List userList
	TUIRoomDefine.ActionCallback callback)

为用户移除标记（只有房主能够调用）

参数	描述
callback	调用接口的回调，用于通知接口调用的成功或者失败
tag	标记类型。数字类型，大于等于 1000，您可以自定义。
userList	用户列表

getUserListByTag

getUserListByTag

void getUserListByTag	(int tag
	long nextSequence
	TUIRoomDefine.GetUserListCallback callback)

根据标记获取房间内用户信息

参数	描述
callback	调用接口的回调，用于通知接口调用的成功或者失败
nextSequence	分页拉取标志，第一次拉取填0，回调成功 如果callback返回的数据中 nextSequence 不为零，需要分页，传入再次拉取，直至为0
tag	标记类型。数字类型，大于等于 1000，您可以自定义。

disableDeviceForAllUserByAdmin

disableDeviceForAllUserByAdmin

void disableDeviceForAllUserByAdmin	(TUIRoomDefine.MediaDevice device
	boolean isDisable
	TUIRoomDefine.ActionCallback callback)

全体用户媒体设备管理

参数	描述
callback	操作回调
device	设备。 详细定义参考:MediaDevice
isDisable	否禁用

openRemoteDeviceByAdmin

openRemoteDeviceByAdmin

Request openRemoteDeviceByAdmin	(String userId
	TUIRoomDefine.MediaDevice device
	int timeout
	TUIRoomDefine.RequestCallback callback)

请求远端用户打开媒体设备（只有管理员或房主能够调用）

参数	描述
callback	调用接口的回调，用于通知请求状态的回调，详细定义参考: RequestCallback
device	媒体设备。详细定义参考:MediaDevice
timeout	超时时间，单位秒，如果设置为 0，SDK 不会做超时检测，也不会触发超时回调
userId	用户ID

返回值说明：

TUIRequest 请求体

closeRemoteDeviceByAdmin

closeRemoteDeviceByAdmin

void closeRemoteDeviceByAdmin	(String userId
	TUIRoomDefine.MediaDevice device
	TUIRoomDefine.ActionCallback callback)

关闭远端用户媒体设备（只有管理员或房主能够调用）

参数	描述
callback	调用接口的回调，用于通知接口调用的成功或者失败
device	媒体设备。详细定义参考:MediaDevice
userId	用户ID

applyToAdminToOpenLocalDevice

applyToAdminToOpenLocalDevice

Request applyToAdminToOpenLocalDevice	(TUIRoomDefine.MediaDevice device
	int timeout
	TUIRoomDefine.RequestCallback callback)

请求打开本地媒体设备（普通用户可用）

参数	描述
callback	调用接口的回调，用于通知请求的回调状态，详细定义参考: RequestCallback
device	用户ID device 媒体设备。详细定义参考:MediaDevice
timeout	超时时间，单位秒，如果设置为 0，SDK 不会做超时检测，也不会触发超时回调

返回值说明：

TUIRequest 请求体

setMaxSeatCount

setMaxSeatCount

void setMaxSeatCount	(int maxSeatCount
	TUIRoomDefine.ActionCallback callback)

设置最大麦位数（仅支持进房前和创建房间时设置）

参数	描述
callback	调用接口的回调，用于通知接口调用的成功或者失败
maxSeatCount	最大麦位数

getSeatList

getSeatList

void getSeatList

(TUIRoomDefine.GetSeatListCallback callback)

获取麦位列表

参数	描述
callback	调用接口的回调，用于通知接口调用的成功或者失败，成功回调中会包含 SeatInfo list信息

lockSeatByAdmin

lockSeatByAdmin

void lockSeatByAdmin	(int seatIndex
	TUIRoomDefine.SeatLockParams lockParams
	TUIRoomDefine.ActionCallback callback)

锁定麦位（只有管理员或群主能够调用，包括位置锁定、音频状态锁定和视频状态锁定）

参数	描述
callback	调用接口的回调，用于通知接口调用的成功或者失败
lockParams	锁麦参数。详情参考:TUIRoomDefine.SeatLockParams
seatIndex	麦位编号

takeSeat

takeSeat

Request takeSeat	(int seatIndex
	int timeout
	TUIRoomDefine.RequestCallback callback)

上麦（上麦发言模式下，需要申请）

参数	描述
callback	调用接口的回调，用于通知请求的回调状态，详细定义参考: RequestCallback
seatIndex	麦位编号
timeout	超时时间，单位秒，如果设置为 0，SDK 不会做超时检测，也不会触发超时回调

注意开启上麦发言模式时，需要向主持人或管理员发起申请才允许上麦。开启自由发言模式，直播场景可以自由上麦，上麦后开麦发言，会议场景无需调用该接口，即可开麦发言。

返回值说明：

TUIRequest 请求体

leaveSeat

leaveSeat

void leaveSeat

(TUIRoomDefine.ActionCallback callback)

下麦

参数	描述
callback	调用接口的回调，用于通知接口调用的成功或者失败

takeUserOnSeatByAdmin

takeUserOnSeatByAdmin

Request takeUserOnSeatByAdmin	(int seatIndex
	String userId
	int timeout
	TUIRoomDefine.RequestCallback callback)

主持人/管理员 邀请用户上麦

参数	描述
callback	调用接口的回调，用于通知请求的回调状态，详细定义参考: RequestCallback
seatIndex	麦位编号。会议场景无需关心，填0即可。
timeout	超时时间，单位秒，如果设置为 0，SDK 不会做超时检测，也不会触发超时回调
userId	用户ID

返回值说明：

TUIRequest 请求体

kickUserOffSeatByAdmin

kickUserOffSeatByAdmin

void kickUserOffSeatByAdmin	(int seatIndex
	String userId
	TUIRoomDefine.ActionCallback callback)

主持人/管理员 将用户下麦

参数	描述
callback	调用接口的回调，用于通知接口调用的成功或者失败
seatIndex	麦位编号
userId	用户ID

sendTextMessage

sendTextMessage

void sendTextMessage	(String message
	TUIRoomDefine.ActionCallback callback)

发送本文消息

参数	描述
callback	调用接口的回调，用于通知接口调用的成功或者失败
message	消息内容

sendCustomMessage

sendCustomMessage

void sendCustomMessage	(String message
	TUIRoomDefine.ActionCallback callback)

发送自定义消息

参数	描述
callback	调用接口的回调，用于通知接口调用的成功或者失败
message	消息内容

disableSendingMessageByAdmin

disableSendingMessageByAdmin

void disableSendingMessageByAdmin	(String userId
	boolean isDisable
	TUIRoomDefine.ActionCallback callback)

禁用远端用户的发送文本消息能力（只有管理员或房主能够调用）

参数	描述
callback	调用接口的回调，用于通知接口调用的成功或者失败
isDisable	是否禁用
userId	用户ID

disableSendingMessageForAllUser

disableSendingMessageForAllUser

void disableSendingMessageForAllUser	(boolean isDisable
	TUIRoomDefine.ActionCallback callback)

禁用所有用户的发送文本消息能力（只有管理员或房主能够调用）

参数	描述
callback	调用接口的回调，用于通知接口调用的成功或者失败
isDisable	是否禁用

cancelRequest

cancelRequest

void cancelRequest	(String requestId
	TUIRoomDefine.ActionCallback callback)

取消请求

参数	描述
callback	调用接口的回调，用于通知接口调用的成功或者失败
requestId	请求ID(发送请求的接口返回或者OnRequestReceived事件通知)

注意可以使用此接口来取消已发出的请求

responseRemoteRequest

responseRemoteRequest

void responseRemoteRequest	(String requestId
	boolean agree
	TUIRoomDefine.ActionCallback callback)

回复请求

参数	描述
agree	是否同意 true: 同意请求, false: 拒绝请求
callback	调用接口的回调，用于通知接口调用的成功或者失败
requestId	请求ID(发送请求的接口返回或者OnRequestReceived事件通知)

注意在收到信令请求时，可以使用此接口来回复接收到的请求

switchCamera

switchCamera

int switchCamera

(boolean frontCamera)

切换前置或后置摄像头（仅适用于移动端）

返回值说明：

0：操作成功；负数：操作失败

setBeautyLevel

setBeautyLevel

void setBeautyLevel	(int beautyStyle
	float beautyLevel)

设置美颜级别

参数	描述
beautyLevel	美颜级别，取值范围 0 – 9； 0 表示关闭，9 表示效果最明显。
beautyStyle	美颜风格，TXBeautyStyleSmooth：光滑；TXBeautyStyleNature：自然；TXBeautyStylePitu：优图。

setWhitenessLevel

setWhitenessLevel

void setWhitenessLevel

(float whitenessLevel)

设置美白级别

参数	描述
whitenessLevel	美白级别，取值范围 0 – 9；0 表示关闭，9 表示效果最明显。

callExperimentalAPI

callExperimentalAPI

void callExperimentalAPI

(String jsonStr)

调用实验性接口

参数	描述
jsonStr	接口信息

对音视频的解决方案有疑惑？想了解解决方案收费？ 联系解决方案专家

腾讯云限时活动1折起，即将结束： 马上收藏

同尘科技为腾讯云授权服务中心，购买腾讯云享受折上折，更有现金返利:同意关联，立享优惠

阿里云解决方案也看看？： 点击对比阿里云的解决方案