TUIRoomObserver

最近更新时间:2023-10-19 18:23:45

我的收藏
Copyright (c) 2021 Tencent. All rights reserved.
Module: TUIRoomObserver @ TUIKitEngine
Function: TUIRoomEngine的事件回调接口

TUIRoomObserver

TUIRoomObserver

函数列表
描述
错误事件回调
用户被踢下线
用户凭证超时事件
房间名称更改事件
房间内所有用户麦克风被禁用事件
房间内所有用户摄像头被禁用事件
房间内用户发送文本消息被禁用事件
房间被解散事件
被踢出房间事件
房间麦控模式发生变化
远端用户进房事件
远端用户离开房间事件
用户角色发生变化事件
用户视频状态发生变化事件
用户音频状态发生变化事件
用户音量变化事件
用户文本消息发送能力发生变化事件
用户网络状态变化事件
屏幕分享结束
房间内最大麦位数发生变化事件(仅在会议类型房间生效)
麦位列表发生变化事件
收到用户被踢下麦事件
收到请求消息事件
收到请求被取消的事件
收到普通文本消息事件
收到自定义消息事件


onError

onError
void onError
(TUICommonDefine.Error errorCode

String message)

错误事件回调

错误事件,表示 SDK 抛出的不可恢复的错误,比如进入房间失败或设备开启失败等。
参数
描述
errorCode
错误码,请参见:Error
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


onSendMessageForAllUserDisableChanged

onSendMessageForAllUserDisableChanged
void onSendMessageForAllUserDisableChanged
(String roomId

boolean isDisable)

房间内用户发送文本消息被禁用事件

参数
描述
isDisable
是否被禁用
roomId
房间 ID


onRoomDismissed

onRoomDismissed
void onRoomDismissed
(String roomId)

房间被解散事件

参数
描述
roomId
房间 ID


onKickedOutOfRoom

onKickedOutOfRoom
void onKickedOutOfRoom
(String roomId

TUIRoomDefine.KickedOutOfRoomReason reason

String message)

被踢出房间事件

参数
描述
message
被踢出的描述
reason
被踢出原因
roomId
房间 ID


onRoomSpeechModeChanged

onRoomSpeechModeChanged
void onRoomSpeechModeChanged
(String roomId

TUIRoomDefine.SpeechMode speechMode)

房间麦控模式发生变化

参数
描述
mode
房间模式
roomId
房间 ID


onRemoteUserEnterRoom

onRemoteUserEnterRoom
void onRemoteUserEnterRoom
(String roomId

TUIRoomDefine.UserInfo userInfo)

远端用户进房事件

参数
描述
roomId
房间 ID
userInfo
用户信息


onRemoteUserLeaveRoom

onRemoteUserLeaveRoom
void onRemoteUserLeaveRoom
(String roomId

TUIRoomDefine.UserInfo userInfo)

远端用户离开房间事件

参数
描述
roomId
房间 ID
userInfo
用户信息


onUserRoleChanged

onUserRoleChanged
void onUserRoleChanged
(String userId

TUIRoomDefine.Role user)

用户角色发生变化事件

参数
描述
userId
用户 ID
userRole
用户角色 可参考 Role 枚举定义


onUserVideoStateChanged

onUserVideoStateChanged
void onUserVideoStateChanged
(String userId

TUIRoomDefine.VideoStreamType streamType

boolean hasVideo

TUIRoomDefine.ChangeReason reason)

用户视频状态发生变化事件

参数
描述
hasVideo
是否有视频流
reason
视频流发生变化原因 BY_SELF: 自己切换 BY_ADMIN: 被管理员切换
streamType
视频流类型
userId
用户 ID


onUserAudioStateChanged

onUserAudioStateChanged
void onUserAudioStateChanged
(String userId

boolean hasAudio

TUIRoomDefine.ChangeReason reason)

用户音频状态发生变化事件

参数
描述
hasAudio
是否有音频流
reason
视频流发生变化原因 BY_SELF: 自己切换 BY_ADMIN: 被管理员切换
userId
用户 ID


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
(Map<String, TUICommonDefine.NetworkInfo> networkMap)

用户网络状态变化事件

参数
描述
networkMap
用户网络状态 Map,可参见 NetworkInfo 对象


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
(List<TUIRoomDefine.SeatInfo> seatList

List<TUIRoomDefine.SeatInfo> seatedList

List<TUIRoomDefine.SeatInfo> leftList)

麦位列表发生变化事件

参数
描述
leftList
新下麦的用户列表
seatList
目前麦上最新的用户列表,包含新上麦的用户
seatedList
新上麦的用户列表


onKickedOffSeat

onKickedOffSeat
void onKickedOffSeat
(String userId)

收到用户被踢下麦事件

参数
描述
userId
操作踢人的(主持人/管理员)用户 ID


onRequestReceived

onRequestReceived
void onRequestReceived
(TUIRoomDefine.Request request)

收到请求消息事件

参数
描述
request
请求内容,可参见 Request 对象


onRequestCancelled

onRequestCancelled
void onRequestCancelled
(String requestId

String userId)

收到请求被取消的事件

参数
描述
requestId
请求 ID
userId
取消信令的用户 ID


onReceiveTextMessage

onReceiveTextMessage
void onReceiveTextMessage
(String roomId

TUICommonDefine.Message message)

收到普通文本消息事件

参数
描述
message
消息内容, 请参见: Message 定义
roomId
房间 ID


onReceiveCustomMessage

onReceiveCustomMessage
void onReceiveCustomMessage
(String roomId

TUICommonDefine.Message message)

收到自定义消息事件

参数
描述
message
消息内容, 请参见: Message 定义
roomId
房间 ID