tencent cloud

实时音视频

动态与公告
产品动态
产品近期公告
关于 TRTC Live 正式上线的公告
关于TRTC Conference 正式版上线的公告
Conference 商业化版本即将推出
关于多人音视频 Conference 开启内测公告
关于音视频通话 Call 正式版上线的公告
关于腾讯云音视频终端 SDK 播放升级及新增授权校验的公告
关于 TRTC 应用订阅套餐服务上线的相关说明
产品简介
产品概述
基本概念
产品功能
产品优势
应用场景
性能数据
购买指南
计费概述
免费时长说明
月订阅
现收现付
TRTC 逾期与暂停政策
常见问题解答
退款说明
新手指引
Demo 体验
视频通话 SDK
组件介绍
开通服务
跑通 Demo
快速接入
离线唤醒
会话聊天
云端录制
AI 降噪
界面定制
Chat 集成通话能力
更多特性
无 UI 集成
服务端 API
客户端 API
解决方案
错误码表
发布日志
常见问题
视频会议 SDK
组件介绍(TUIRoomKit)
开通服务(TUIRoomKit)
跑通 Demo(TUIRoomKit)
快速接入(TUIRoomKit)
屏幕共享(TUIRoomKit)
预定会议(TUIRoomKit)
会中呼叫(TUIRoomKit)
界面定制(TUIRoomKit)
虚拟背景(TUIRoomKit)
会议控制(TUIRoomKit)
云端录制(TUIRoomKit)
AI 降噪(TUIRoomKit)
会中聊天(TUIRoomKit)
机器人推流(TUIRoomKit)
更多特性(TUIRoomKit)
客户端 API(TUIRoomKit)
服务端 API(TUIRoomKit)
常见问题(TUIRoomKit)
错误码 (TUIRoomKit)
SDK更新日志(TUIRoomKit)
直播与语聊 SDK
Live 视频直播计费说明
组件介绍
开通服务(TUILiveKit)
跑通 Demo
无 UI 集成
UI 自定义
直播监播
视频直播
语聊房
高级功能
客户端 API
服务端 API
错误码
发布日志
常见问题
RTC Engine
开通服务
SDK 下载
API-Example
接入指引
API-参考手册
高级功能
AI 集成
概述
MCP 配置
Skills 配置
集成指南
常见问题
RTC RESTFUL API
History
Introduction
API Category
Room Management APIs
Stream mixing and relay APIs
On-cloud recording APIs
Data Monitoring APIs
Pull stream Relay Related interface
Web Record APIs
AI Service APIs
Cloud Slicing APIs
Cloud Moderation APIs
Making API Requests
Call Quality Monitoring APIs
Usage Statistics APIs
Data Types
Appendix
Error Codes
控制台指南
应用管理
套餐包管理
用量统计
监控仪表盘
开发辅助
解决方案
实时合唱
常见问题
迁移指南
计费相关
功能相关
UserSig 相关
应对防火墙限制相关
缩减安装包体积相关
Andriod 与 iOS 相关
Web 端相关
Flutter 相关
Electron 相关
TRTCCalling Web 相关
音视频质量相关
其他问题
旧版文档
RTC RoomEngine SDK(旧)
集成 TUIRoom (Web)
集成 TUIRoom (Android)
集成 TUIRoom (iOS)
集成 TUIRoom (Flutter)
集成 TUIRoom (Electron)
TUIRoom API 查询
实现云端录制与回放(旧)
监控仪表盘计费(旧)
协议与策略
安全合规认证
安全白皮书
信息安全说明
服务等级协议
苹果隐私策略:PrivacyInfo.xcprivacy
TRTC 政策
隐私协议
数据处理和安全协议
词汇表

TUIRoomEvent

PDF
聚焦模式
字号
最后更新时间: 2023-11-22 11:26:26

TUIRoomEvent API 简介

TUIRoomEvent API 是多人组件的事件接口

事件列表

EVENT
描述
错误事件
踢出房间事件
当前用户被踢下线
userSig 过期事件
主持人销毁房间事件
房间名称修改事件
房间发言模式修改事件
所有成员摄像头使用权限改变事件
所有成员麦克风使用权限改变事件
所有成员发送消息状态改变事件
房间最大麦位数修改事件
远端用户进入房间事件
远端用户离开房间事件
用户角色改变事件
用户视频状态改变事件
用户音频状态改变事件
用户发送消息状态事件
用户音量改变事件
用户网络质量改变事件
麦位列表改变事件
用户被踢下麦事件
请求接收事件
请求取消事件
接收文本消息事件
接收自定义消息事件
设备变更事件
屏幕分享停止事件,当用户使用浏览器自带的【停止分享】按钮结束屏幕共享时,该用户会收到 'onUserScreenCaptureStopped' 事件用来修改屏幕共享状态。

onError

错误事件
const roomEngine = new TUIRoomEngine();
roomEngine.on(TUIRoomEvents.onError, (error) => {
console.log('TUIRoomError error', error);
})
参数如下表所示:
参数
类型
含义
code
number
错误代码
message
string
错误信息

onKickedOutOfRoom

踢出房间事件
const roomEngine = new TUIRoomEngine();
roomEngine.on(TUIRoomEvents.onKickedOutOfRoom, ({ roomId, message }) => {
console.log('roomEngine.onKickedOutOfRoom', roomId, message);
});
参数如下表所示:
参数
类型
含义
roomId
string
房间号
message
string
踢出房间信息

onKickedOffLine

当前用户被踢下线
const roomEngine = new TUIRoomEngine();
roomEngine.on(TUIRoomEvents.onKickedOffLine, ({ message }) => {
console.log('roomEngine.onKickedOffLine', message);
});
参数如下表所示:
参数
类型
含义
roomId
string
房间号
message
string
用户在其他端登录信息

onUserSigExpired

userSig 过期事件
const roomEngine = new TUIRoomEngine();
roomEngine.on(TUIRoomEvents.onUserSigExpired, () => {
console.log('roomEngine.onUserSigExpired');
});

onRoomDismissed

主持人销毁房间事件
const roomEngine = new TUIRoomEngine();
roomEngine.on(TUIRoomEvents.onRoomDismissed, ({ roomId }) => {
console.log('roomEngine.onRoomDismissed', roomId);
});
参数如下表所示:
参数
类型
含义
roomId
string
房间号

onRoomNameChanged

房间信息修改事件
const roomEngine = new TUIRoomEngine();
roomEngine.on(TUIRoomEvents.onRoomNameChanged, ({ roomId, roomName }) => {
console.log('roomEngine.onRoomNameChanged', roomId, roomName);
});
参数如下表所示:
参数
类型
含义
roomId
string
房间号
roomName
string
房间名称

onRoomSpeechModeChanged

房间名称修改事件
const roomEngine = new TUIRoomEngine();
roomEngine.on(TUIRoomEvents.onRoomSpeechModeChanged, ({ roomId, speechMode }) => {
console.log('roomEngine.onRoomSpeechModeChanged', roomId, speechMode);
});
参数如下表所示:
参数
类型
含义
roomId
string
房间号
speechMode
发言模式

onAllUserCameraDisableChanged

所有成员摄像头使用权限改变事件
const roomEngine = new TUIRoomEngine();
roomEngine.on(TUIRoomEvents.onAllUserCameraDisableChanged, ({ isDisable }) => {
console.log('roomEngine.onAllUserCameraDisableChanged', isDisable);
});
参数如下表所示:
参数
类型
含义
isDisable
boolean
是否允许使用摄像头

onAllUserMicrophoneDisableChanged

所有成员麦克风使用权限改变事件
const roomEngine = new TUIRoomEngine();
roomEngine.on(TUIRoomEvents.onAllUserMicrophoneDisableChanged, ({ isDisable }) => {
console.log('roomEngine.onAllUserMicrophoneDisableChanged', isDisable);
});
参数如下表所示:
参数
类型
含义
isDisable
boolean
是否允许使用麦克风

onSendMessageForAllUserDisableChanged

所有成员发送消息权限改变事件
const roomEngine = new TUIRoomEngine();
roomEngine.on(TUIRoomEvents.onSendMessageForAllUserDisableChanged, ({ isDisable }) => {
console.log('roomEngine.onSendMessageForAllUserDisableChanged', isDisable);
});
参数如下表所示:
参数
类型
含义
isDisable
boolean
是否允许发送文字消息

onRoomMaxSeatCountChanged

房间最大麦位数修改事件
const roomEngine = new TUIRoomEngine();
roomEngine.on(TUIRoomEvents.onRoomMaxSeatCountChanged, ({ maxSeatNumber }) => {
console.log('roomEngine.onRoomMaxSeatCountChanged', maxSeatNumber);
});
参数如下表所示:
参数
类型
含义
maxSeatNumber
number
最大麦位数量

onRemoteUserEnterRoom

远端用户进入房间事件
const roomEngine = new TUIRoomEngine();
roomEngine.on(TUIRoomEvents.onRemoteUserEnterRoom, ({ roomId, userInfo }) => {
console.log('roomEngine.onRemoteUserEnterRoom', roomId, userInfo);
});
参数如下表所示:
参数
类型
含义
roomId
string
房间号
userInfo
用户信息

onRemoteUserLeaveRoom

远端用户离开房间事件
const roomEngine = new TUIRoomEngine();
roomEngine.on(TUIRoomEvents.onRemoteUserLeaveRoom, ({ roomId, userInfo }) => {
console.log('roomEngine.onRemoteUserLeaveRoom', roomId, userInfo);
});
参数如下表所示:
参数
类型
含义
roomId
string
房间号
userInfo
用户信息

onUserRoleChanged

用户角色改变事件
const roomEngine = new TUIRoomEngine();
roomEngine.on(TUIRoomEvents.onUserRoleChanged, ({ userId, userRole }) => {
console.log('roomEngine.onUserRoleChanged', userId, userRole);
});
参数如下表所示:
参数
类型
含义
userId
string
用户 ID
userRole
TUIRole
用户变更后的角色

onUserVideoStateChanged

用户视频状态改变事件
const roomEngine = new TUIRoomEngine();
roomEngine.on(TUIRoomEvents.onUserVideoStateChanged, ({ userId, streamType, hasVideo, reason }) => {
console.log('roomEngine.onUserVideoStateChanged', userId, streamType, hasVideo, reason);
});
参数如下表所示:
参数
类型
含义
userId
string
用户 ID
streamType
用户流类型
hasVideo
boolean
是否有视频流
reason
变更原因, 自己操作/主持人操作

onUserAudioStateChanged

用户音频状态改变事件
const roomEngine = new TUIRoomEngine();
roomEngine.on(TUIRoomEvents.onUserAudioStateChanged, ({ userId, hasAudio, reason }) => {
console.log('roomEngine.onUserAudioStateChanged', userId, hasAudio, reason);
});
参数如下表所示:
参数
类型
含义
userId
string
用户 ID
hasVideo
boolean
是否有音频流
reason
变更原因,自己操作/主持人操作

onSendMessageForUserDisableChanged

有成员摄像头使用权限修改事件
const roomEngine = new TUIRoomEngine();
roomEngine.on(TUIRoomEvents.onSendMessageForAllUserDisableChanged, ({ isDisable }) => {
console.log('roomEngine.onSendMessageForAllUserDisableChanged', isDisable);
});
参数如下表所示:
参数
类型
含义
isDisable
boolean
是否允许发送文字消息

onUserVoiceVolumeChanged

用户音量改变事件
const roomEngine = new TUIRoomEngine();
roomEngine.on(TUIRoomEvents.onUserVoiceVolumeChanged, ({ userVolumeList }) => {
userVolumeList.forEach(userVolume => {
console.log('roomEngine.onUserVoiceVolumeChanged', userVolume.userId, userVolume.volume);
})
});
参数如下表所示:
参数
类型
含义
userVolumes
房间内所有用户的音量, 包含 userId 及 volume 信息,volume 区间为 1~100;

onUserNetworkQualityChanged

用户网络质量改变事件
const roomEngine = new TUIRoomEngine();
roomEngine.on(TUIRoomEvents.onUserNetworkQualityChanged, ({ userNetworkList }) => {
userNetworkList.forEach(userNetwork => {
console.log('roomEngine.onUserNetworkQualityChanged', userNetwork.userId, userNetwork.volume);
})
});
参数如下表所示:
参数
类型
含义
networkMap
遍历网络质量等级

onSeatListChanged

麦位列表改变事件
const roomEngine = new TUIRoomEngine();
roomEngine.on(TUIRoomEvents.onSeatListChanged, ({ seatList, seatedList, leftList }) => {
console.log('roomEngine.onSeatListChanged',seatList, seatedList, leftList);
});
参数如下表所示:
参数
类型
含义
seatList
Array.<TUISeatInfo>
麦位列表
seatedList
Array.<TUISeatInfo>
新增麦位信息
leftList
Array.<TUISeatInfo>
离开的麦位信息

onKickedOffSeat

麦位列表改变事件
const roomEngine = new TUIRoomEngine();
roomEngine.on(TUIRoomEvents.onKickedOffSeat, ({ userId }) => {
console.log('roomEngine.onKickedOffSeat', userId);
});
参数如下表所示:
参数
类型
含义
userId
String
被踢下麦的用户 ID

onRequestReceived

错误事件
const roomEngine = new TUIRoomEngine();
roomEngine.on(TUIRoomEvents.onRequestReceived, ({ request }) => {
console.log('roomEngine.onRequestReceived', request);
});
参数如下表所示:
参数
类型
含义
request
请求接收

onRequestCancelled

请求取消事件
const roomEngine = new TUIRoomEngine();
roomEngine.on(TUIRoomEvents.onRequestCancelled, ({ requestId, userId }) => {
console.log('roomEngine.onRequestCancelled', requestId, userId);
});
参数如下表所示:
参数
类型
含义
requestId
string
请求 ID
userId
string
取消请求的用户 ID

onReceiveTextMessage

接收文本消息事件
const roomEngine = new TUIRoomEngine();
roomEngine.on(TUIRoomEvents.onReceiveTextMessage, ({ roomId, message }) => {
console.log('roomEngine.onReceiveTextMessage', roomId, message);
});
参数如下表所示:
参数
类型
含义
roomId
string
房间 ID
message
接收文本消息

onReceiveCustomMessage

接收自定义消息事件
const roomEngine = new TUIRoomEngine();
roomEngine.on(TUIRoomEvents.onReceiveCustomMessage, ({ roomId, message }) => {
console.log('roomEngine.onReceiveCustomMessage', roomId, message);
});
参数如下表所示:
参数
类型
含义
roomId
string
房间 ID
message
接收文本消息

onDeviceChange

设备变更事件
const roomEngine = new TUIRoomEngine();
roomEngine.on(TUIRoomEvents.onDeviceChange, ({ deviceId, type, state }) => {
console.log('roomEngine.onReceiveCustomMessage', deviceId, type, state);
});
参数如下表所示:
参数
类型
含义
deviceId
string
设备 ID
type
设备类型
state
设备变更状态

onUserScreenCaptureStopped

屏幕分享停止事件,当用户使用浏览器自带的 停止分享 按钮结束屏幕共享时,该用户会收到 onUserScreenCaptureStopped事件用来修改屏幕共享状态。
const roomEngine = new TUIRoomEngine();
roomEngine.on(TUIRoomEvents.onUserScreenCaptureStopped, () => {
console.log('roomEngine.onReceiveCustomMessage', deviceId, type, state);
});


帮助和支持

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

填写满意度调查问卷,共创更好文档体验。

文档反馈