Copyright (c) 2024 Tencent. All rights reserved.
Module: TUIRoomObserver @ TUIKitEngine
Function: TUIRoomEngine的事件回调接口
TUIRoomObserver
TUIRoomObserver
函数列表 | 描述 |
错误事件回调 | |
用户被踢下线 | |
用户凭证超时事件 | |
房间名称更改事件 | |
房间内所有用户麦克风被禁用事件 | |
房间内所有用户摄像头被禁用事件 | |
房间内所有用户屏幕分享被禁用事件 | |
房间内用户发送文本消息被禁用事件 | |
房间被解散事件 | |
被踢出房间事件 | |
房间上麦模式发生变化 | |
房间内人员数量发生变化 | |
远端用户进房事件 | |
远端用户离开房间事件 | |
用户角色发生变化事件 | |
用户视频状态发生变化事件 | |
用户音频状态发生变化事件 | |
用户音量变化事件 | |
用户文本消息发送能力发生变化事件 | |
用户网络状态变化事件 | |
屏幕分享结束 | |
房间内最大麦位数发生变化事件（仅在会议类型房间生效） | |
麦位列表发生变化事件 | |
收到用户被踢下麦事件 | |
收到请求消息事件 | |
收到请求被取消的事件 | |
收到请求被其他 管理员/房主 处理事件 | |
收到普通文本消息事件 | |
收到自定义消息事件 | |
房间被解散事件 | |
房间麦控模式发生变化 | |
用户角色发生变化事件 | |
收到用户被踢下麦事件 | |
收到请求被取消的事件 | |
收到请求被其他 管理员/房主 处理事件 |
onError
onError
void onError | |
| String message) |
onKickedOffLine
onKickedOffLine
void onKickedOffLine | (String message) |
用户被踢下线
参数 | 描述 |
message | 被踢下线的描述。 |
onUserSigExpired
onUserSigExpired
用户凭证超时事件
onRoomNameChanged
onRoomNameChanged
void onRoomNameChanged | (String roomId |
| String roomName) |
房间名称更改事件
参数 | 描述 |
roomId | 房间ID。 |
roomName | 房间名称。 |
onAllUserMicrophoneDisableChanged
onAllUserMicrophoneDisableChanged
void onAllUserMicrophoneDisableChanged | (String roomId |
| boolean isDisable) |
房间内所有用户麦克风被禁用事件
参数 | 描述 |
isDisable | 是否被禁用。 |
roomId | 房间ID。 |
onAllUserCameraDisableChanged
onAllUserCameraDisableChanged
void onAllUserCameraDisableChanged | (String roomId |
| boolean isDisable) |
房间内所有用户摄像头被禁用事件
参数 | 描述 |
isDisable | 是否被禁用。 |
roomId | 房间ID。 |
onScreenShareForAllUserDisableChanged
onScreenShareForAllUserDisableChanged
void onScreenShareForAllUserDisableChanged | (String roomId |
| boolean isDisable) |
房间内所有用户屏幕分享被禁用事件
参数 | 描述 |
isDisable | 是否被禁用。 |
roomId | 房间ID。 |
onSendMessageForAllUserDisableChanged
onSendMessageForAllUserDisableChanged
void onSendMessageForAllUserDisableChanged | (String roomId |
| boolean isDisable) |
房间内用户发送文本消息被禁用事件
参数 | 描述 |
isDisable | 是否被禁用。 |
roomId | 房间ID。 |
onRoomDismissed
onRoomDismissed
void onRoomDismissed | (String roomId |
|
房间被解散事件
参数 | 描述 |
reason | |
roomId | 房间ID。 |
onKickedOutOfRoom
onKickedOutOfRoom
void onKickedOutOfRoom | (String roomId |
| |
| String message) |
被踢出房间事件
参数 | 描述 |
message | 被踢出的描述。 |
reason | 被踢出原因。 |
roomId | 房间ID。 |
onRoomSeatModeChanged
onRoomSeatModeChanged
void onRoomSeatModeChanged | (String roomId |
|
房间上麦模式发生变化
参数 | 描述 |
roomId | 房间ID。 |
seatMode | 上麦模式。 |
onRoomUserCountChanged
onRoomUserCountChanged
void onRoomUserCountChanged | (String roomId |
| int userCount) |
房间内人员数量发生变化
参数 | 描述 |
roomId | 房间ID。 |
userCount | 人员数量。 |
onRemoteUserEnterRoom
onRemoteUserEnterRoom
void onRemoteUserEnterRoom | (String roomId |
|
远端用户进房事件
参数 | 描述 |
roomId | 房间ID。 |
userInfo | 用户信息。 |
onRemoteUserLeaveRoom
onRemoteUserLeaveRoom
void onRemoteUserLeaveRoom | (String roomId |
|
远端用户离开房间事件
参数 | 描述 |
roomId | 房间ID。 |
userInfo | 用户信息。 |
onUserRoleChanged
onUserRoleChanged
void onUserRoleChanged |
用户角色发生变化事件
参数 | 描述 |
userInfo | 用户信息。 |
onUserVideoStateChanged
onUserVideoStateChanged
void onUserVideoStateChanged | (String userId |
| |
| boolean hasVideo |
|
onUserAudioStateChanged
onUserAudioStateChanged
void onUserAudioStateChanged | (String userId |
| boolean hasAudio |
|
onUserVoiceVolumeChanged
onUserVoiceVolumeChanged
void onUserVoiceVolumeChanged | (Map<String, Integer> volumeMap) |
用户音量变化事件
参数 | 描述 |
volumeMap | 用户音量字典 key: userId, value: 用于承载所有正在说话的用户的音量大小，取值范围 0 - 100。 |
onSendMessageForUserDisableChanged
onSendMessageForUserDisableChanged
void onSendMessageForUserDisableChanged | (String roomId |
| String userId |
| boolean isDisable) |
用户文本消息发送能力发生变化事件
参数 | 描述 |
isDisable | 是否被禁止发送文本消息 true: 用户被禁止发送消息 false: 用户被解除禁止，可以发送消息。 |
userId | 用户ID。 |
onUserNetworkQualityChanged
onUserNetworkQualityChanged
void onUserNetworkQualityChanged |
用户网络状态变化事件
参数 | 描述 |
networkMap |
onUserScreenCaptureStopped
onUserScreenCaptureStopped
void onUserScreenCaptureStopped | (int reason) |
屏幕分享结束
参数 | 描述 |
reason | 停止原因，0：用户主动停止；1：屏幕窗口关闭导致停止；2：表示屏幕分享的显示屏状态变更（如接口被拔出、投影模式变更等）。 |
onRoomMaxSeatCountChanged
onRoomMaxSeatCountChanged
void onRoomMaxSeatCountChanged | (String roomId |
| int maxSeatCount) |
房间内最大麦位数发生变化事件（仅在会议类型房间生效）
参数 | 描述 |
maxSeatCount | 房间内最大麦位数量。 |
roomId | 房间ID。 |
onSeatListChanged
onSeatListChanged
void onSeatListChanged | |
| |
|
麦位列表发生变化事件
参数 | 描述 |
leftList | 新下麦的用户列表。 |
seatList | 目前麦上最新的用户列表，包含新上麦的用户。 |
seatedList | 新上麦的用户列表。 |
onKickedOffSeat
onKickedOffSeat
void onKickedOffSeat | (int seatIndex |
|
收到用户被踢下麦事件
参数 | 描述 |
operateUser | 操作踢人的（主持人/管理员）用户信息。 |
seatIndex | 麦位编号。 |
onRequestReceived
onRequestReceived
void onRequestReceived |
收到请求消息事件
参数 | 描述 |
request |
onRequestCancelled
onRequestCancelled
收到请求被取消的事件
参数 | 描述 |
operateUser | 取消信令的用户信息。 |
request |
onRequestProcessed
onRequestProcessed
收到请求被其他 管理员/房主 处理事件
参数 | 描述 |
operateUser | 取消信令的用户信息。 |
request |
onReceiveTextMessage
onReceiveTextMessage
void onReceiveTextMessage | (String roomId |
|
收到普通文本消息事件
参数 | 描述 |
message | |
roomId | 房间ID。 |
onReceiveCustomMessage
onReceiveCustomMessage
void onReceiveCustomMessage | (String roomId |
|
收到自定义消息事件
参数 | 描述 |
message | |
roomId | 房间ID。 |
onRoomDismissed
onRoomDismissed
void onRoomDismissed | (String roomId) |
房间被解散事件
参数 | 描述 |
roomId | 房间ID。 |
注意
此回调将于v2.8.0版本删除，建议您使用新的回调代替。
onRoomSpeechModeChanged
onRoomSpeechModeChanged
void onRoomSpeechModeChanged | (String roomId |
|
房间麦控模式发生变化
@deprecated v2.0 版本开始，该功能已废弃，建议使用isSeatEnabled代替。
参数 | 描述 |
mode | 房间模式。 |
roomId | 房间ID。 |
onUserRoleChanged
onUserRoleChanged
void onUserRoleChanged | (String userId |
|
用户角色发生变化事件
参数 | 描述 |
userId | 用户ID。 |
userRole |
注意
此回调将于v2.8.0版本删除，建议您使用新的回调代替。
onKickedOffSeat
onKickedOffSeat
void onKickedOffSeat | (String userId) |
收到用户被踢下麦事件
参数 | 描述 |
userId | 操作踢人的（主持人/管理员）用户id。 |
注意
此回调将于v2.8.0版本删除，建议您使用新的回调代替。
onRequestCancelled
onRequestCancelled
void onRequestCancelled | (String requestId |
| String userId) |
收到请求被取消的事件
参数 | 描述 |
requestId | 请求ID。 |
userId | 取消信令的用户ID。 |
注意
此回调将于v2.8.0版本删除，建议您使用新的回调代替。
onRequestProcessed
onRequestProcessed
void onRequestProcessed | (String requestId |
| String userId) |
收到请求被其他 管理员/房主 处理事件
参数 | 描述 |
requestId | 请求ID。 |
userId | 管理员/房主 的用户ID。 |
注意
此回调将于v2.8.0版本删除，建议您使用新的回调代替。