TUIRoomObserver

Copyright (c) 2024 Tencent. All rights reserved.
Module: TUIRoomObserver @ TUIKitEngine.
Function: TUIRoomEngine event callback APIs.

TUIRoomObserver

TUIRoomObserver

FuncList
DESC
Error event callback.
The current user was kicked offline.
The current user signature is expired.
The name of the room has changed.
Room was dismissed.
The current user has been kicked off from the room.
The room seat mode has changed.
The count of user in the room has changed.
Remote user entered room.
Remote user left room.
User information has changed in the room.
The status of the user has video stream changed.
The status of the user has audio stream changed.
User volume changed.
The status of disabling to send message has changed for user.
The User network status changed.
Screen sharing stopped.
The maximum count of seats in the room changed (only available in conference rooms)
Seat list changed.
The user was kicked off the seat.
Receive a request message.
Received a cancelled request.
Receive a request to be processed by other administrator/owner.

onError

onError
void onError
(TUICommonDefine.Error errorCode

String message)

Error event callback.

Callback error events when entering a room or opening a device.
Param
DESC
errorCode
Error code. More details, see: Error.
message
Error message.

onKickedOffLine

onKickedOffLine
void onKickedOffLine
(String message)

The current user was kicked offline.

Param
DESC
message
Description of being kicked off.

onUserSigExpired

onUserSigExpired

The current user signature is expired.

onRoomNameChanged

onRoomNameChanged
void onRoomNameChanged
(String roomId

String roomName)

The name of the room has changed.

Param
DESC
roomId
Room ID.
roomName
Room name.

onRoomDismissed

onRoomDismissed
void onRoomDismissed
(String roomId

TUIRoomDefine.RoomDismissedReason reason)

Room was dismissed.

Param
DESC
reason
The reason why the room was dismissed. More details, see: RoomDismissedReason.
roomId
Room ID.

onKickedOutOfRoom

onKickedOutOfRoom
void onKickedOutOfRoom
(String roomId

TUIRoomDefine.KickedOutOfRoomReason reason

String message)

The current user has been kicked off from the room.

Param
DESC
message
Description of being kicked off.
reason
Reason for being kicked off.
roomId
Room ID.

onRoomSeatModeChanged

onRoomSeatModeChanged
void onRoomSeatModeChanged
(String roomId

TUIRoomDefine.SeatMode seatMode)

The room seat mode has changed.

Param
DESC
roomId
: Room ID.
seatMode
: Seat mode. More details, see TUISeatMode.

onRoomUserCountChanged

onRoomUserCountChanged
void onRoomUserCountChanged
(String roomId

int userCount)

The count of user in the room has changed.

Param
DESC
roomId
Room ID.
userCount
Count of user.

onRemoteUserEnterRoom

onRemoteUserEnterRoom
void onRemoteUserEnterRoom
(String roomId

TUIRoomDefine.UserInfo userInfo)

Remote user entered room.

Param
DESC
roomId
Room ID.
userInfo
User information. More details, see TUIUserInfo.

onRemoteUserLeaveRoom

onRemoteUserLeaveRoom
void onRemoteUserLeaveRoom
(String roomId

TUIRoomDefine.UserInfo userInfo)

Remote user left room.

Param
DESC
roomId
Room ID.
userInfo
User information. More details, see TUIUserInfo.

onUserInfoChanged

onUserInfoChanged
void onUserInfoChanged
(TUIRoomDefine.UserInfo userInfo

List<TUIRoomDefine.UserInfoModifyFlag> modifyFlag)

User information has changed in the room.

Param
DESC
modifyFlag
Modifiable parameter. More details, see UserInfoModifyFlag.
userInfo
User information. More details, see TUIUserInfo.

onUserVideoStateChanged

onUserVideoStateChanged
void onUserVideoStateChanged
(String userId

TUIRoomDefine.VideoStreamType streamType

boolean hasVideo

TUIRoomDefine.ChangeReason reason)

The status of the user has video stream changed.

Param
DESC
hasVideo
The current user whether has video stream.
reason
The reason why the video stream changed: BY_SELF: Changed by self BY_ADMIN: Changed by administrator.
streamType
Video stream type. More details, see TUIVideoStreamType.
userId
User ID.

onUserAudioStateChanged

onUserAudioStateChanged
void onUserAudioStateChanged
(String userId

boolean hasAudio

TUIRoomDefine.ChangeReason reason)

The status of the user has audio stream changed.

Param
DESC
hasAudio
The current user whether has audio stream.
reason
The reason why the video stream changed: BY_SELF: Changed by self BY_ADMIN: Changed by administrator.
userId
User ID.

onUserVoiceVolumeChanged

onUserVoiceVolumeChanged
void onUserVoiceVolumeChanged
(Map<String, Integer> volumeMap)

User volume changed.

Param
DESC
volumeMap
: User volume dictionary key: userId, value: the volume of all speaking users, with a value range of 0 - 100.

onSendMessageForUserDisableChanged

onSendMessageForUserDisableChanged
void onSendMessageForUserDisableChanged
(String roomId

String userId

boolean isDisable)

The status of disabling to send message has changed for user.

Param
DESC
isDisable
true: disable user to send message false: enable user to send message.
userId
User ID.

onUserNetworkQualityChanged

onUserNetworkQualityChanged
void onUserNetworkQualityChanged
(Map<String, TUICommonDefine.NetworkInfo> networkMap)

The User network status changed.

Param
DESC
networkMap
User network status Map. More details, see NetworkInfo.

onUserScreenCaptureStopped

onUserScreenCaptureStopped
void onUserScreenCaptureStopped
(int reason)

Screen sharing stopped.

Param
DESC
reason
Stop reason, 0: user actively stops; 1: the screen or the window is closed ; 2: the status of the screen or the window has changed (such as device disconnect).

onRoomMaxSeatCountChanged

onRoomMaxSeatCountChanged
void onRoomMaxSeatCountChanged
(String roomId

int maxSeatCount)

The maximum count of seats in the room changed (only available in conference rooms)

Param
DESC
maxSeatCount
The maximum count of seat in the room.
roomId
Room ID.

onSeatListChanged

onSeatListChanged
void onSeatListChanged
(List<TUIRoomDefine.SeatInfo> seatList

List<TUIRoomDefine.SeatInfo> seatedList

List<TUIRoomDefine.SeatInfo> leftList)

Seat list changed.

Param
DESC
leftList
List of newly leave-seat users.
seatList
The latest user list on seat, including new users.
seatedList
List of newly take-seat users.

onKickedOffSeat

onKickedOffSeat
void onKickedOffSeat
(int seatIndex

TUIRoomDefine.UserInfo operateUser)

The user was kicked off the seat.

Param
DESC
operateUser
User information of the owner/administrator who kicked the user.
seatIndex
Seat index.

onRequestReceived

onRequestReceived
void onRequestReceived
(TUIRoomDefine.Request request)

Receive a request message.

Param
DESC
request
Request content. More details, see Request.

onRequestCancelled

onRequestCancelled
void onRequestCancelled
(TUIRoomDefine.Request request

TUIRoomDefine.UserInfo operateUser)

Received a cancelled request.

Param
DESC
operateUser
Operator information.
request
Request content. More details, see Request.

onRequestProcessed

onRequestProcessed
void onRequestProcessed
(TUIRoomDefine.Request request

TUIRoomDefine.UserInfo operateUser)

Receive a request to be processed by other administrator/owner.

Param
DESC
operateUser
Operator information.
request
Request content. More details, see Request.