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:message:
onError:message:
- (void)onError: | |
message: | (NSString *)message |
Error event callback.
Callback error events when entering a room or opening a device.
Param | DESC |
errorCode | |
message | Error message. |
onKickedOffLine:
onKickedOffLine:
- (void)onKickedOffLine: | (NSString *)message |
The current user was kicked offline.
Param | DESC |
message | Description of being kicked off. |
onUserSigExpired
onUserSigExpired
The current user signature is expired.
onRoomNameChanged:roomName:
onRoomNameChanged:roomName:
- (void)onRoomNameChanged: | (NSString *)roomId |
roomName: | (NSString *)roomName |
The name of the room has changed.
Param | DESC |
roomId | Room ID. |
roomName | Room name. |
onRoomDismissed:reason:
onRoomDismissed:reason:
- (void)onRoomDismissed: | (NSString *)roomId |
reason: |
Room was dismissed.
Param | DESC |
reason | |
roomId | Room ID. |
onKickedOutOfRoom:reason:message:
onKickedOutOfRoom:reason:message:
- (void)onKickedOutOfRoom: | (NSString *)roomId |
reason: | |
message: | (NSString *)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:seatMode:
onRoomSeatModeChanged:seatMode:
- (void)onRoomSeatModeChanged: | (NSString *)roomId |
seatMode: |
The room seat mode has changed.
Param | DESC |
roomId | : Room ID. |
seatMode |
onRoomUserCountChanged:userCount:
onRoomUserCountChanged:userCount:
- (void)onRoomUserCountChanged: | (NSString *)roomId |
userCount: | (NSInteger)userCount |
The count of user in the room has changed.
Param | DESC |
roomId | Room ID. |
userCount | Count of user. |
onRemoteUserEnterRoom:userInfo:
onRemoteUserEnterRoom:userInfo:
- (void)onRemoteUserEnterRoom: | (NSString *)roomId |
userInfo: |
Remote user entered room.
Param | DESC |
roomId | Room ID. |
userInfo |
onRemoteUserLeaveRoom:userInfo:
onRemoteUserLeaveRoom:userInfo:
- (void)onRemoteUserLeaveRoom: | (NSString *)roomId |
userInfo: |
Remote user left room.
Param | DESC |
roomId | Room ID. |
userInfo |
onUserInfoChanged:modifyFlag:
onUserInfoChanged:modifyFlag:
- (void)onUserInfoChanged: | |
modifyFlag: | (TUIUserInfoModifyFlag)modifyFlag |
User information has changed in the room.
Param | DESC |
modifyFlag | Modifiable parameter. More details, see TUIUserInfoModifyFlag. |
userInfo |
onUserVideoStateChanged:streamType:hasVideo:reason:
onUserVideoStateChanged:streamType:hasVideo:reason:
- (void)onUserVideoStateChanged: | (NSString *)userId |
streamType: | |
hasVideo: | (BOOL)hasVideo |
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: TUIChangeReasonBySelf: Changed by self TUIChangeReasonByAdmin: Changed by administrator. |
streamType | |
userId | User ID. |
onUserAudioStateChanged:hasAudio:reason:
onUserAudioStateChanged:hasAudio:reason:
- (void)onUserAudioStateChanged: | (NSString *)userId |
hasAudio: | (BOOL)hasAudio |
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: TUIChangeReasonBySelf: Changed by self TUIChangeReasonByAdmin: Changed by administrator. |
userId | User ID. |
onUserVoiceVolumeChanged
onUserVoiceVolumeChanged
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:userId:isDisable:
onSendMessageForUserDisableChanged:userId:isDisable:
- (void)onSendMessageForUserDisableChanged: | (NSString *)roomId |
userId: | (NSString *)userId |
isDisable: | (BOOL)muted |
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: |
The user network status changed.
Param | DESC |
networkList |
onUserScreenCaptureStopped:
onUserScreenCaptureStopped:
- (void)onUserScreenCaptureStopped: | (NSInteger)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:maxSeatNumber:
onRoomMaxSeatCountChanged:maxSeatNumber:
- (void)onRoomMaxSeatCountChanged: | (NSString *)roomId |
maxSeatNumber: | (NSInteger)maxSeatNumber |
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:seated:left:
onSeatListChanged:seated:left:
- (void)onSeatListChanged: | |
seated: | |
left: |
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:operateUser:
onKickedOffSeat:operateUser:
- (void)onKickedOffSeat: | (NSInteger)seatIndex |
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: |
Receive a request message.
Param | DESC |
request |
onRequestCancelled:operateUser:
onRequestCancelled:operateUser:
- (void)onRequestCancelled: | |
operateUser: |
Received a cancelled request.
Param | DESC |
operateUser | Operator information. |
request |
onRequestProcessed:operateUser:
onRequestProcessed:operateUser:
- (void)onRequestProcessed: | |
operateUser: |
Receive a request to be processed by other administrator/owner.
Param | DESC |
operateUser | Operator information. |
request |
- TUIRoomObserver
- onError:message:
- onKickedOffLine:
- onUserSigExpired
- onRoomNameChanged:roomName:
- onRoomDismissed:reason:
- onKickedOutOfRoom:reason:message:
- onRoomSeatModeChanged:seatMode:
- onRoomUserCountChanged:userCount:
- onRemoteUserEnterRoom:userInfo:
- onRemoteUserLeaveRoom:userInfo:
- onUserInfoChanged:modifyFlag:
- onUserVideoStateChanged:streamType:hasVideo:reason:
- onUserAudioStateChanged:hasAudio:reason:
- onUserVoiceVolumeChanged
- onSendMessageForUserDisableChanged:userId:isDisable:
- onUserNetworkQualityChanged:
- onUserScreenCaptureStopped:
- onRoomMaxSeatCountChanged:maxSeatNumber:
- onSeatListChanged:seated:left:
- onKickedOffSeat:operateUser:
- onRequestReceived:
- onRequestCancelled:operateUser:
- onRequestProcessed:operateUser: