实时音视频 API 概览-客户端 API-文档中心-腾讯云

API OVERVIEW
创建实例和事件回调
函数列表
描述
sharedInstance
创建 TUIRoomEngine 实例（单例模式）
destroySharedInstance
销毁 TUIRoomEngine 实例（单例模式）
login
登录接口，您需要先初始化用户信息后才能进入房间，并进行一系列的操作
logout
退出登录接口，会有主动离开房间操作、销毁资源
setSelfInfo
设置本地用户名称和头像
getSelfInfo
获取本地用户登录的基本信息
addObserver
设置事件回调
removeObserver
移除事件回调
房间相关主动接口
函数列表
描述
createRoom
创建房间
destroyRoom
解散房间
enterRoom
进入房间
exitRoom
离开房间
fetchRoomInfo
获取当前进入的房间信息
updateRoomNameByAdmin
更新房间名称（只有管理员或房主能够调用）
updateRoomSeatModeByAdmin
更新房间麦位模式（只有管理员或房主能够调用）
updateRoomPasswordByAdmin
更新房间密码
getRoomMetadata
获取房间自定义信息
setRoomMetadataByAdmin
设置房间自定义信息，已有该属性则更新其 value 值，没有则添加该属性
本地用户视图渲染、视频管理
函数列表
描述
setLocalVideoView
设置本地用户视频渲染的视图控件
openLocalCamera
打开本地摄像头
closeLocalCamera
关闭本地摄像头
startPushLocalVideo
开始推送本地视频。默认开启
stopPushLocalVideo
停止推送本地视频
updateVideoQuality
更新本地视频编码质量设置
updateVideoQualityEx
设置视频编码器的编码参数
setVideoResolutionMode
设置视频编码器分辨率模式（横屏分辨率 or 竖屏分辨率）
enableGravitySensor
开启重力感应模式
startScreenSharing
开始屏幕分享（该接口仅支持移动端）
stopScreenSharing
结束屏幕分享
本地用户音频管理
函数列表
描述
openLocalMicrophone
打开本地麦克风
closeLocalMicrophone
关闭本地麦克风
updateAudioQuality
更新本地音频编码质量设置
muteLocalAudio
暂停发布本地的音频流
unmuteLocalAudio
恢复发布本地的音频流
enableSystemAudioSharing
开启系统声音分享
远端用户视图渲染、视频管理
函数列表
描述
setRemoteVideoView
设置远端用户视频渲染的视图控件
startPlayRemoteVideo
开始播放远端用户视频
stopPlayRemoteVideo
停止播放远端用户视频
muteRemoteAudioStream
将远端用户静音
房间内用户信息
函数列表
描述
getUserList
获取房间内的成员列表
getUserInfo
获取成员信息
房间内用户管理
函数列表
描述
changeUserRole
修改用户角色（只有管理员或房主能够调用）
changeUserNameCard
修改用户房间内昵称
kickRemoteUserOutOfRoom
将远端用户踢出房间（只有管理员或房主能够调用）
addCategoryTagForUsers
为用户增加标记（只有房主能够调用）
removeCategoryTagForUsers
为用户移除标记（只有房主能够调用）
getUserListByTag
根据标记获取房间内用户信息
setCustomInfoForUser
设置房间内成员自定义信息
房间内用户发言管理
函数列表
描述
disableDeviceForAllUserByAdmin
控制当前房间内所有用户是否可打开音频流、视频流采集设备的权限状态，例如：全员禁止打开麦克风、全员禁止打开摄像头（目前仅会议场景下可用，并且只有管理员或房主能够调用）
openRemoteDeviceByAdmin
请求远端用户打开媒体设备（只有管理员或房主能够调用,device类型不支持SCREEN_SHARING）
closeRemoteDeviceByAdmin
关闭远端用户媒体设备（只有管理员或房主能够调用）
applyToAdminToOpenLocalDevice
请求打开本地媒体设备（普通用户可用,device类型不支持SCREEN_SHARING）
房间内麦位管理
函数列表
描述
setMaxSeatCount
设置最大麦位数（仅支持进房前和创建房间时设置）
getSeatList
获取麦位列表
lockSeatByAdmin
锁定麦位（只有管理员或群主能够调用，包括位置锁定、音频状态锁定和视频状态锁定）
takeSeat
上麦（上麦发言模式下，需要申请）
leaveSeat
下麦
moveToSeat
移麦
takeUserOnSeatByAdmin
主持人/管理员 邀请用户上麦
kickUserOffSeatByAdmin
主持人/管理员 将用户下麦
getSeatApplicationList
主持人/管理员 获取房间内申请上麦用户的请求列表
文本消息
函数列表
描述
disableSendingMessageByAdmin
禁用远端用户的发送文本消息能力（只有管理员或房主能够调用）
disableSendingMessageForAllUser
禁用所有用户的发送文本消息能力（只有管理员或房主能够调用）
信令管理
函数列表
描述
cancelRequest
取消请求
responseRemoteRequest
回复请求
高级功能
函数列表
描述
setBeautyLevel
设置美颜级别
setWhitenessLevel
设置美白级别
getExtension
获取插件
getMediaDeviceManager
获取设备管理类
getLiveConnectionManager
获取连线管理类
getLiveBattleManager
获取 Battle 管理类
调试相关
函数列表
描述
callExperimentalAPI
调用实验性接口
错误事件回调
函数列表
描述
onError
错误事件回调
登录状态事件回调
函数列表
描述
onKickedOffLine
用户被踢下线
onUserSigExpired
用户凭证超时事件
房间内事件回调
函数列表
描述
onRoomNameChanged
房间名称更改事件
onAllUserMicrophoneDisableChanged
房间内所有用户麦克风被禁用事件
onAllUserCameraDisableChanged
房间内所有用户摄像头被禁用事件
onScreenShareForAllUserDisableChanged
房间内所有用户屏幕分享被禁用事件
onSendMessageForAllUserDisableChanged
房间内用户发送文本消息被禁用事件
onRoomDismissed
房间被解散事件
onKickedOutOfRoom
被踢出房间事件
onRoomSeatModeChanged
房间上麦模式发生变化
onRoomUserCountChanged
房间内人员数量发生变化
onRoomMetadataChanged
房间内自定义信息发生变化
房间内用户事件回调
函数列表
描述
onRemoteUserEnterRoom
远端用户进房事件
onRemoteUserLeaveRoom
远端用户离开房间事件
onUserInfoChanged
房间内用户信息发生变化事件。
onUserVideoStateChanged
用户视频状态发生变化事件
onUserAudioStateChanged
用户音频状态发生变化事件
onUserVoiceVolumeChanged
用户音量变化事件
onSendMessageForUserDisableChanged
用户文本消息发送能力发生变化事件
onUserNetworkQualityChanged
用户网络状态变化事件
onUserScreenCaptureStopped
屏幕分享结束
房间内麦位事件回调
函数列表
描述
onRoomMaxSeatCountChanged
房间内最大麦位数发生变化事件（仅在会议类型房间生效）
onSeatListChanged
麦位列表发生变化事件
onKickedOffSeat
收到用户被踢下麦事件
请求信令事件回调
函数列表
描述
onRequestReceived
收到请求消息事件
onRequestCancelled
收到请求被取消的事件
onRequestProcessed
收到请求被其他 管理员/房主 处理事件
废弃回调
函数列表
描述
onRoomDismissed
房间被解散事件
onKickedOffSeat
收到用户被踢下麦事件
onRequestCancelled
收到请求被取消的事件
onRequestProcessed
收到请求被其他 管理员/房主 处理事件
onUserRoleChanged
用户角色发生变化事件
设备管理相关接口
函数列表
描述
isFrontCamera
判断当前是否为前置摄像头（仅支持移动端）
switchCamera
切换前置或后置摄像头（仅支持移动端）
isAutoFocusEnabled
查询是否支持自动识别人脸位置（仅支持移动端）
enableCameraAutoFocus
开启自动对焦功能（仅支持移动端）
enableCameraTorch
开启/关闭闪光灯，也就是手电筒模式（仅支持移动端）
setAudioRoute
设置音频路由（仅支持移动端）
废弃接口
函数列表
描述
startPushLocalAudio
开始推送本地音频
stopPushLocalAudio
停止推送本地音频
getTRTCCloud
获得TRTC实例对象
getDeviceManager
获得设备管理对象
getAudioEffectManager
获得音效管理对象
getBeautyManager
获得美颜管理对象
setLocalVideoView
设置本地用户视频渲染的视图控件
switchCamera
切换前置或后置摄像头（仅适用于移动端）

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

函数列表	描述
createRoom	创建房间
destroyRoom	解散房间
enterRoom	进入房间
exitRoom	离开房间
fetchRoomInfo	获取当前进入的房间信息
updateRoomNameByAdmin	更新房间名称（只有管理员或房主能够调用）
updateRoomSeatModeByAdmin	更新房间麦位模式（只有管理员或房主能够调用）
updateRoomPasswordByAdmin	更新房间密码
getRoomMetadata	获取房间自定义信息
setRoomMetadataByAdmin	设置房间自定义信息，已有该属性则更新其 value 值，没有则添加该属性

函数列表	描述
setLocalVideoView	设置本地用户视频渲染的视图控件
openLocalCamera	打开本地摄像头
closeLocalCamera	关闭本地摄像头
startPushLocalVideo	开始推送本地视频。默认开启
stopPushLocalVideo	停止推送本地视频
updateVideoQuality	更新本地视频编码质量设置
updateVideoQualityEx	设置视频编码器的编码参数
setVideoResolutionMode	设置视频编码器分辨率模式（横屏分辨率 or 竖屏分辨率）
enableGravitySensor	开启重力感应模式
startScreenSharing	开始屏幕分享（该接口仅支持移动端）
stopScreenSharing	结束屏幕分享

函数列表	描述
openLocalMicrophone	打开本地麦克风
closeLocalMicrophone	关闭本地麦克风
updateAudioQuality	更新本地音频编码质量设置
muteLocalAudio	暂停发布本地的音频流
unmuteLocalAudio	恢复发布本地的音频流
enableSystemAudioSharing	开启系统声音分享

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

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

函数列表	描述
changeUserRole	修改用户角色（只有管理员或房主能够调用）
changeUserNameCard	修改用户房间内昵称
kickRemoteUserOutOfRoom	将远端用户踢出房间（只有管理员或房主能够调用）
addCategoryTagForUsers	为用户增加标记（只有房主能够调用）
removeCategoryTagForUsers	为用户移除标记（只有房主能够调用）
getUserListByTag	根据标记获取房间内用户信息
setCustomInfoForUser	设置房间内成员自定义信息

函数列表	描述
disableDeviceForAllUserByAdmin	控制当前房间内所有用户是否可打开音频流、视频流采集设备的权限状态，例如：全员禁止打开麦克风、全员禁止打开摄像头（目前仅会议场景下可用，并且只有管理员或房主能够调用）
openRemoteDeviceByAdmin	请求远端用户打开媒体设备（只有管理员或房主能够调用,device类型不支持SCREEN_SHARING）
closeRemoteDeviceByAdmin	关闭远端用户媒体设备（只有管理员或房主能够调用）
applyToAdminToOpenLocalDevice	请求打开本地媒体设备（普通用户可用,device类型不支持SCREEN_SHARING）

函数列表	描述
setMaxSeatCount	设置最大麦位数（仅支持进房前和创建房间时设置）
getSeatList	获取麦位列表
lockSeatByAdmin	锁定麦位（只有管理员或群主能够调用，包括位置锁定、音频状态锁定和视频状态锁定）
takeSeat	上麦（上麦发言模式下，需要申请）
leaveSeat	下麦
moveToSeat	移麦
takeUserOnSeatByAdmin	主持人/管理员邀请用户上麦
kickUserOffSeatByAdmin	主持人/管理员将用户下麦
getSeatApplicationList	主持人/管理员获取房间内申请上麦用户的请求列表

函数列表	描述
disableSendingMessageByAdmin	禁用远端用户的发送文本消息能力（只有管理员或房主能够调用）
disableSendingMessageForAllUser	禁用所有用户的发送文本消息能力（只有管理员或房主能够调用）

函数列表	描述
cancelRequest	取消请求
responseRemoteRequest	回复请求

函数列表	描述
setBeautyLevel	设置美颜级别
setWhitenessLevel	设置美白级别
getExtension	获取插件
getMediaDeviceManager	获取设备管理类
getLiveConnectionManager	获取连线管理类
getLiveBattleManager	获取 Battle 管理类

函数列表	描述
onKickedOffLine	用户被踢下线
onUserSigExpired	用户凭证超时事件

函数列表	描述
onRoomNameChanged	房间名称更改事件
onAllUserMicrophoneDisableChanged	房间内所有用户麦克风被禁用事件
onAllUserCameraDisableChanged	房间内所有用户摄像头被禁用事件
onScreenShareForAllUserDisableChanged	房间内所有用户屏幕分享被禁用事件
onSendMessageForAllUserDisableChanged	房间内用户发送文本消息被禁用事件
onRoomDismissed	房间被解散事件
onKickedOutOfRoom	被踢出房间事件
onRoomSeatModeChanged	房间上麦模式发生变化
onRoomUserCountChanged	房间内人员数量发生变化
onRoomMetadataChanged	房间内自定义信息发生变化

函数列表	描述
onRemoteUserEnterRoom	远端用户进房事件
onRemoteUserLeaveRoom	远端用户离开房间事件
onUserInfoChanged	房间内用户信息发生变化事件。
onUserVideoStateChanged	用户视频状态发生变化事件
onUserAudioStateChanged	用户音频状态发生变化事件
onUserVoiceVolumeChanged	用户音量变化事件
onSendMessageForUserDisableChanged	用户文本消息发送能力发生变化事件
onUserNetworkQualityChanged	用户网络状态变化事件
onUserScreenCaptureStopped	屏幕分享结束

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

函数列表	描述
onRequestReceived	收到请求消息事件
onRequestCancelled	收到请求被取消的事件
onRequestProcessed	收到请求被其他管理员/房主处理事件

函数列表	描述
isFrontCamera	判断当前是否为前置摄像头（仅支持移动端）
switchCamera	切换前置或后置摄像头（仅支持移动端）
isAutoFocusEnabled	查询是否支持自动识别人脸位置（仅支持移动端）
enableCameraAutoFocus	开启自动对焦功能（仅支持移动端）
enableCameraTorch	开启/关闭闪光灯，也就是手电筒模式（仅支持移动端）
setAudioRoute	设置音频路由（仅支持移动端）

函数列表	描述
startPushLocalAudio	开始推送本地音频
stopPushLocalAudio	停止推送本地音频
getTRTCCloud	获得TRTC实例对象
getDeviceManager	获得设备管理对象
getAudioEffectManager	获得音效管理对象
getBeautyManager	获得美颜管理对象
setLocalVideoView	设置本地用户视频渲染的视图控件
switchCamera	切换前置或后置摄像头（仅适用于移动端）

API 概览

本页目录：

创建实例和事件回调

房间相关主动接口

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

本地用户音频管理

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

房间内用户信息

房间内用户管理

房间内用户发言管理

房间内麦位管理

文本消息

信令管理

高级功能

调试相关

错误事件回调

登录状态事件回调

房间内事件回调

房间内用户事件回调

房间内麦位事件回调

请求信令事件回调

废弃回调

设备管理相关接口

废弃接口