Tencent Cloud

API 概览

最后更新时间：2024-07-05 19:48:27

TUIRoomEngine (无 UI 接口) 
TUIRoomEngine API 是音视频通话组件的无 UI 接口,您可以使用这套 API 根据您的业务需求自定义封装。  
TUIRoomEngine
TUIRoomEngine 核心方法
API
描述
﻿createInstance﻿
创建 TUIRoomEngine 实例
﻿destroyInstance﻿
销毁 TUIRoomEngine 实例
﻿login﻿
登录接口，您需要先初始化用户信息后才能进入房间，并进行一系列的操作。
﻿logout﻿
退出登录接口，会有主动离开房间操作、销毁资源
﻿setSelfInfo﻿
设置本地用户名称和头像
﻿getSelfInfo﻿
获取本地用户基本信息
﻿addObserver﻿
设置事件回调
﻿removeObserver﻿
移除事件回调
房间相关主动接口
API
描述
﻿createRoom﻿
创建房间
﻿destroyRoom﻿
解散房间
﻿enterRoom﻿
进入房间
﻿exitRoom﻿
离开房间
﻿connectOtherRoom﻿
连接其他房间
﻿disconnectOtherRoom﻿
断开与其他房间的连接
﻿fetchRoomInfo﻿
获取房间信息
﻿updateRoomNameByAdmin﻿
更新房间名称
﻿updateRoomSpeechModeByAdmin﻿
设置房间管理模式（只有管理员或群主能够调用）
本地用户视图渲染、视频管理
API
描述
﻿setLocalVideoView﻿
设置本地用户视频渲染的视图控件
﻿openLocalCamera﻿
打开本地摄像头
﻿closeLocalCamera﻿
关闭本地摄像头
﻿updateVideoQuality﻿
更新本地视频编码质量设置
﻿startScreenSharing﻿
开始屏幕分享
﻿stopScreenSharing﻿
结束屏幕分享
﻿startPushLocalVideo﻿
开始推送本地视频
﻿stopPushLocalVideo﻿
停止推送本地视频
本地用户音频管理
API
描述
﻿openLocalMicrophone﻿
打开本地麦克风
﻿closeLocalMicrophone﻿
关闭本地麦克风
﻿updateAudioQuality﻿
更新本地音频编码质量设置
﻿startPushLocalAudio﻿
开始推送本地音频
﻿stopPushLocalAudio﻿
停止推送本地音频
远端用户视图渲染、视频管理
API
描述
﻿setRemoteVideoView﻿
设置远端用户视频渲染的视图控件
﻿startPlayRemoteVideo﻿
开始播放远端用户视频
﻿stopPlayRemoteVideo﻿
停止播放远端用户视频
﻿muteRemoteAudioStream﻿
将远端用户禁音
房间内用户信息
API
描述
﻿getUserList﻿
获取房间内的成员列表
﻿getUserInfo﻿
获取成员信息
房间内用户管理
API
描述
﻿changeUserRole﻿
修改用户角色（只有管理员或群主能够调用）
﻿kickRemoteUserOutOfRoom﻿
将远端用户踢出房间（只有管理员或群主能够调用）
房间内用户发言管理
API
描述
﻿disableDeviceForAllUserByAdmin﻿
全体用户媒体设备管理（只有管理员或群主能够调用）
﻿openRemoteDeviceByAdmin﻿
请求远端用户打开媒体设备（只有管理员或群主能够调用）
﻿closeRemoteDeviceByAdmin﻿
关闭远端用户媒体设备（只有管理员或群主能够调用）
﻿applyToAdminToOpenLocalDevice﻿
请求打开本地媒体设备（普通用户可用）
房间内麦位管理
API
描述
﻿setMaxSeatCount﻿
设置最大麦位数（仅支持进房前和创建房间时设置）
﻿getSeatList﻿
获取麦位列表
﻿lockSeatByAdmin﻿
锁定麦位（包括位置锁定，音频状态锁定，视频状态锁定）
﻿takeSeat﻿
本地上麦
会议场景：SPEAK_AFTER_TAKING_SEAT 模式需要向主持人或管理员发起申请才允许上麦，其他模式不支持上麦。
直播场景：FREE_TO_SPEAK 模式可以自由上麦，上麦后开麦发言；SPEAK_AFTER_TAKING_SEAT 模式需要向主持人或管理员发起申请才允许上麦；其他模式不支持上麦
﻿leaveSeat﻿
本地下麦
﻿takeUserOnSeatByAdmin﻿
主持人/管理员 邀请用户上麦
﻿kickUserOffSeatByAdmin﻿
主持人/管理员 将用户下麦
信令管理
API
描述
﻿cancelRequest﻿
取消请求
﻿responseRemoteRequest﻿
回复请求
发送消息
API
描述
﻿sendTextMessage﻿
发送本文消息
﻿sendCustomMessage﻿
发送自定义消息
﻿disableSendingMessageByAdmin﻿
禁用远端用户的发送文本消息能力（只有管理员或群主能够调用）
﻿disableSendingMessageForAllUser﻿
禁用所有用户的发送文本消息能力（只有管理员或群主能够调用）
高级功能：获取 TRTC 实例
API
描述
﻿getTRTCCloud﻿
获得 TRTC 实例对象
﻿getDeviceManager﻿
获得设备管理对象
﻿getAudioEffectManager﻿
获得音效管理对象
﻿getBeautyManager﻿
获得美颜管理对象
﻿
事件类型定义
TUIRoomObserver 是 TUIRoomEngine 对应的回调事件类，您可以通过此回调，来监听自己需要的回调事件。
TUIRoomObserver
错误回调
事件
描述
﻿onError﻿
错误回调事件
登录状态事件回调
API
描述
﻿onKickedOffLine﻿
用户被踢下线事件
﻿onUserSigExpired﻿
用户凭证超时事件
房间内事件回调
API
描述
﻿onRoomNameChanged﻿
房间名称更改事件
﻿onAllUserMicrophoneDisableChanged﻿
房间内所有用户麦克风被禁用事件
﻿onAllUserCameraDisableChanged﻿
房间内所有用户摄像头被禁用事件
﻿onSendMessageForAllUserDisableChanged﻿
房间内所有用户发送文本消息被禁用事件
﻿onRoomDismissed﻿
房间被解散事件
﻿onKickedOutOfRoom﻿
被踢出房间事件
﻿onRoomSpeechModeChanged﻿
房间麦控模式发生变化
房间内用户事件回调
API
描述
﻿onRemoteUserEnterRoom﻿
远端用户进房事件
﻿onRemoteUserLeaveRoom﻿
远端用户离开房间事件
﻿onUserRoleChanged﻿
用户角色发生变化事件
﻿onUserVideoStateChanged﻿
用户视频状态发生变化事件
﻿onUserAudioStateChanged﻿
用户音频状态发生变化事件
﻿onUserVoiceVolumeChanged﻿
用户音量变化事件
﻿onSendMessageForUserDisableChanged﻿
用户文本消息发送能力发生变化事件
﻿onUserNetworkQualityChanged﻿
用户网络状态变化事件
﻿onUserScreenCaptureStopped﻿
屏幕分享结束事件
房间内麦位事件回调
API
描述
﻿onRoomMaxSeatCountChanged﻿
房间内最大麦位数发生变化事件（仅在会议类型房间生效）
﻿onSeatListChanged﻿
麦位列表发生变化事件
﻿onKickedOffSeat﻿
收到用户被踢下麦事件
请求信令事件回调
API
描述
﻿onRequestReceived﻿
收到请求消息事件
﻿onRequestCancelled﻿
收到请求被取消的事件
房间内消息事件回调
API
描述
﻿onReceiveTextMessage﻿
收到普通文本消息事件
﻿onReceiveCustomMessage﻿
收到自定义消息事件
﻿
﻿

tencent cloud

Recent Pages

API 概览

TUIRoomEngine (无 UI 接口)

TUIRoomEngine 核心方法

房间相关主动接口

本地用户视图渲染、视频管理

本地用户音频管理

远端用户视图渲染、视频管理

房间内用户信息

房间内用户管理

房间内用户发言管理

房间内麦位管理

信令管理

发送消息

高级功能：获取 TRTC 实例

事件类型定义

错误回调

登录状态事件回调

房间内事件回调

房间内用户事件回调

房间内麦位事件回调

请求信令事件回调

房间内消息事件回调

本页内容是否解决了您的问题？

本页内容是否解决了您的问题？

API	描述
createInstance	创建 TUIRoomEngine 实例
destroyInstance	销毁 TUIRoomEngine 实例
login	登录接口，您需要先初始化用户信息后才能进入房间，并进行一系列的操作。
logout	退出登录接口，会有主动离开房间操作、销毁资源
setSelfInfo	设置本地用户名称和头像
getSelfInfo	获取本地用户基本信息
addObserver	设置事件回调
removeObserver	移除事件回调

API	描述
createRoom	创建房间
destroyRoom	解散房间
enterRoom	进入房间
exitRoom	离开房间
connectOtherRoom	连接其他房间
disconnectOtherRoom	断开与其他房间的连接
fetchRoomInfo	获取房间信息
updateRoomNameByAdmin	更新房间名称
updateRoomSpeechModeByAdmin	设置房间管理模式（只有管理员或群主能够调用）

API	描述
setLocalVideoView	设置本地用户视频渲染的视图控件
openLocalCamera	打开本地摄像头
closeLocalCamera	关闭本地摄像头
updateVideoQuality	更新本地视频编码质量设置
startScreenSharing	开始屏幕分享
stopScreenSharing	结束屏幕分享
startPushLocalVideo	开始推送本地视频
stopPushLocalVideo	停止推送本地视频

API	描述
openLocalMicrophone	打开本地麦克风
closeLocalMicrophone	关闭本地麦克风
updateAudioQuality	更新本地音频编码质量设置
startPushLocalAudio	开始推送本地音频
stopPushLocalAudio	停止推送本地音频

API	描述
setRemoteVideoView	设置远端用户视频渲染的视图控件
startPlayRemoteVideo	开始播放远端用户视频
stopPlayRemoteVideo	停止播放远端用户视频
muteRemoteAudioStream	将远端用户禁音

API	描述
getUserList	获取房间内的成员列表
getUserInfo	获取成员信息

API	描述
changeUserRole	修改用户角色（只有管理员或群主能够调用）
kickRemoteUserOutOfRoom	将远端用户踢出房间（只有管理员或群主能够调用）

API	描述
disableDeviceForAllUserByAdmin	全体用户媒体设备管理（只有管理员或群主能够调用）
openRemoteDeviceByAdmin	请求远端用户打开媒体设备（只有管理员或群主能够调用）
closeRemoteDeviceByAdmin	关闭远端用户媒体设备（只有管理员或群主能够调用）
applyToAdminToOpenLocalDevice	请求打开本地媒体设备（普通用户可用）

API	描述
setMaxSeatCount	设置最大麦位数（仅支持进房前和创建房间时设置）
getSeatList	获取麦位列表
lockSeatByAdmin	锁定麦位（包括位置锁定，音频状态锁定，视频状态锁定）
takeSeat	本地上麦会议场景：SPEAK_AFTER_TAKING_SEAT 模式需要向主持人或管理员发起申请才允许上麦，其他模式不支持上麦。直播场景：FREE_TO_SPEAK 模式可以自由上麦，上麦后开麦发言；SPEAK_AFTER_TAKING_SEAT 模式需要向主持人或管理员发起申请才允许上麦；其他模式不支持上麦
leaveSeat	本地下麦
takeUserOnSeatByAdmin	主持人/管理员邀请用户上麦
kickUserOffSeatByAdmin	主持人/管理员将用户下麦

API	描述
cancelRequest	取消请求
responseRemoteRequest	回复请求

API	描述
sendTextMessage	发送本文消息
sendCustomMessage	发送自定义消息
disableSendingMessageByAdmin	禁用远端用户的发送文本消息能力（只有管理员或群主能够调用）
disableSendingMessageForAllUser	禁用所有用户的发送文本消息能力（只有管理员或群主能够调用）

API	描述
getTRTCCloud	获得 TRTC 实例对象
getDeviceManager	获得设备管理对象
getAudioEffectManager	获得音效管理对象
getBeautyManager	获得美颜管理对象

API	描述
onKickedOffLine	用户被踢下线事件
onUserSigExpired	用户凭证超时事件

API	描述
onRoomNameChanged	房间名称更改事件
onAllUserMicrophoneDisableChanged	房间内所有用户麦克风被禁用事件
onAllUserCameraDisableChanged	房间内所有用户摄像头被禁用事件
onSendMessageForAllUserDisableChanged	房间内所有用户发送文本消息被禁用事件
onRoomDismissed	房间被解散事件
onKickedOutOfRoom	被踢出房间事件
onRoomSpeechModeChanged	房间麦控模式发生变化

API	描述
onRemoteUserEnterRoom	远端用户进房事件
onRemoteUserLeaveRoom	远端用户离开房间事件
onUserRoleChanged	用户角色发生变化事件
onUserVideoStateChanged	用户视频状态发生变化事件
onUserAudioStateChanged	用户音频状态发生变化事件
onUserVoiceVolumeChanged	用户音量变化事件
onSendMessageForUserDisableChanged	用户文本消息发送能力发生变化事件
onUserNetworkQualityChanged	用户网络状态变化事件
onUserScreenCaptureStopped	屏幕分享结束事件

API	描述
onRoomMaxSeatCountChanged	房间内最大麦位数发生变化事件（仅在会议类型房间生效）
onSeatListChanged	麦位列表发生变化事件
onKickedOffSeat	收到用户被踢下麦事件

API	描述
onRequestReceived	收到请求消息事件
onRequestCancelled	收到请求被取消的事件

API	描述
onReceiveTextMessage	收到普通文本消息事件
onReceiveCustomMessage	收到自定义消息事件

tencent cloud

注册

登录

Recent Pages

API 概览

TUIRoomEngine (无 UI 接口)

TUIRoomEngine 核心方法

房间相关主动接口

本地用户视图渲染、视频管理

本地用户音频管理

远端用户视图渲染、视频管理

房间内用户信息

房间内用户管理

房间内用户发言管理

房间内麦位管理

信令管理

发送消息

高级功能：获取 TRTC 实例

事件类型定义

错误回调

登录状态事件回调

房间内事件回调

房间内用户事件回调

房间内麦位事件回调

请求信令事件回调

房间内消息事件回调

本页内容是否解决了您的问题？

本页内容是否解决了您的问题？