TUIRoomObserver
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. | |
The status of disabling to open microphone has changed for all users. | |
The status of disabling to open camera has changed for all users. | |
The status of disabling to open screen sharing has changed for all users. | |
The status of disabling to send message has changed for all users. | |
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. | |
The key-value of room metadata 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 paused. | |
Screen sharing resumed. | |
Screen sharing stopped. | |
The User video size changed. | |
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. | |
Text message received | |
Custom message received | |
Local device added. |
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.
Called when a user is kicked offline.
Param | DESC |
message | Description of being kicked off. |
onUserSigExpired
onUserSigExpired
The current user signature is expired.
Called when a user's signature expires.
onRoomNameChanged:roomName:
onRoomNameChanged:roomName:
- (void)onRoomNameChanged: | (NSString *)roomId |
roomName: | (NSString *)roomName |
The name of the room has changed.
Called when the room name changes.
Param | DESC |
roomId | Room ID. |
roomName | Room name. |
onAllUserMicrophoneDisableChanged:isDisable:
onAllUserMicrophoneDisableChanged:isDisable:
- (void)onAllUserMicrophoneDisableChanged: | (NSString *)roomId |
isDisable: | (BOOL)isDisable |
The status of disabling to open microphone has changed for all users.
Param | DESC |
isDisable | true: disable user to open microphone false: enable user to open microphone. |
roomId | Room ID. |
Note
Called when the microphone disable status changes for all users.
onAllUserCameraDisableChanged:isDisable:
onAllUserCameraDisableChanged:isDisable:
- (void)onAllUserCameraDisableChanged: | (NSString *)roomId |
isDisable: | (BOOL)isDisable |
The status of disabling to open camera has changed for all users.
Param | DESC |
isDisable | true: disable user to open camera false: enable user to open camera. |
roomId | Room ID. |
Note
Called when the camera disable status changes for all users.
onScreenShareForAllUserDisableChanged:isDisable:
onScreenShareForAllUserDisableChanged:isDisable:
- (void)onScreenShareForAllUserDisableChanged: | (NSString *)roomId |
isDisable: | (BOOL)isDisable |
The status of disabling to open screen sharing has changed for all users.
Param | DESC |
isDisable | true: disable user to open screen sharing false: enable user to open screen sharing. |
roomId | Room ID. |
Note
Called when the screen sharing permissions change for all users.
onSendMessageForAllUserDisableChanged:isDisable:
onSendMessageForAllUserDisableChanged:isDisable:
- (void)onSendMessageForAllUserDisableChanged: | (NSString *)roomId |
isDisable: | (BOOL)isDisable |
The status of disabling to send message has changed for all users.
Param | DESC |
isDisable | true: disable user to send message false: enable user to send message. |
roomId | Room ID. |
Note
Called when the message sending permissions change for all users.
onRoomDismissed:reason:
onRoomDismissed:reason:
- (void)onRoomDismissed: | (NSString *)roomId |
reason: |
Room was dismissed.
Param | DESC |
reason | |
roomId | Room ID. |
Note
Called when the room is dismissed.
onKickedOutOfRoom:reason:message:
onKickedOutOfRoom:reason:message:
- (void)onKickedOutOfRoom: | (NSString *)roomId |
reason: | |
message: | (NSString *)message |
The current user has been kicked off from the room.
Called when a user is kicked out of 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 | #### [REMARK] Called when the seat mode of the room changes. |
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. #### [REMARK] Called when the user count of the room changes. |
onRoomMetadataChanged:value:
onRoomMetadataChanged:value:
- (void)onRoomMetadataChanged: | (NSString *)key |
value: | (NSString *)value |
The key-value of room metadata has changed.
Param | DESC |
key | The key of room metadata. |
value | The value of room metadata. #### [REMARK] Called when the custom information of the room changes. |
onRemoteUserEnterRoom:userInfo:
onRemoteUserEnterRoom:userInfo:
- (void)onRemoteUserEnterRoom: | (NSString *)roomId |
userInfo: |
Remote user entered room.
Called when a remote user enters the room.
Param | DESC |
roomId | Room ID. |
userInfo |
onRemoteUserLeaveRoom:userInfo:
onRemoteUserLeaveRoom:userInfo:
- (void)onRemoteUserLeaveRoom: | (NSString *)roomId |
userInfo: |
Remote user left room.
Called when a remote user leaves the room.
Param | DESC |
roomId | Room ID. |
userInfo |
onUserInfoChanged:modifyFlag:
onUserInfoChanged:modifyFlag:
- (void)onUserInfoChanged: | |
modifyFlag: | (TUIUserInfoModifyFlag)modifyFlag |
User information has changed in the room.
Called when a user's information changes.
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.
Called when a user's video state changes.
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.
Called when a user's audio state changes.
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.
Called when a user's voice volume changes.
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.
Called when a user's message sending permissions change.
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.
Called when a user's network quality changes.
Param | DESC |
networkList |
onUserScreenCapturePaused:
onUserScreenCapturePaused:
- (void)onUserScreenCapturePaused: | (NSInteger)reason |
Screen sharing paused.
Called when a user's screen capture pauses.
Param | DESC |
reason | pause reason, 0: User manually paused; 1: The screen sharing window became invisible (Mac) or due to screen sharing parameter settings (Windows). 2: The screen sharing window was minimized (Windows only). 3: The screen sharing window was hidden (Windows only). 4: The system stopped screen recording (iOS only). |
onUserScreenCaptureResumed:
onUserScreenCaptureResumed:
- (void)onUserScreenCaptureResumed: | (NSInteger)reason |
Screen sharing resumed.
Called when a user's screen capture resumes.
Param | DESC |
reason | resume reason,0: User manually resumed. 1: The screen sharing window became visible again (Mac) or screen sharing parameters were set (Windows). 2: The screen sharing window was restored from minimization (Windows only). 3: The screen sharing window was restored from being hidden (Windows only). 4: The system resumed screen recording (iOS only). |
onUserScreenCaptureStopped:
onUserScreenCaptureStopped:
- (void)onUserScreenCaptureStopped: | (NSInteger)reason |
Screen sharing stopped.
Called when a user's screen capture stops.
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). |
onUserVideoSizeChanged:userId:streamType:width:height:
onUserVideoSizeChanged:userId:streamType:width:height:
- (void)onUserVideoSizeChanged: | (NSString *)roomId |
userId: | (NSString *)userId |
streamType: | |
width: | (int)width |
height: | (int)height |
The User video size changed.
Called when a user's video size changes.
Param | DESC |
height | Video height. |
roomId | Room ID. |
streamType | |
userId | User ID or mixed stream ID. When the local user is an audience and successfully connected to the host, this parameter represents the host's user ID; otherwise, it represents the mixed stream ID. |
width | Video width. |
onSeatListChanged:seated:left:
onSeatListChanged:seated:left:
- (void)onSeatListChanged: | |
seated: | |
left: |
Seat list changed.
Called when the seat list changes.
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.
Called when a user is kicked off a 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.
Called when a request is received.
Param | DESC |
request |
onRequestCancelled:operateUser:
onRequestCancelled:operateUser:
- (void)onRequestCancelled: | |
operateUser: |
Received a cancelled request.
Called when a request is cancelled.
Param | DESC |
operateUser | Operator information. |
request |
onRequestProcessed:operateUser:
onRequestProcessed:operateUser:
- (void)onRequestProcessed: | |
operateUser: |
Receive a request to be processed by other administrator/owner.
Called when a request is processed.
Param | DESC |
operateUser | Operator information. |
request |
onReceiveTextMessage:
onReceiveTextMessage:
- (void)onReceiveTextMessage: |
Text message received
Param | DESC |
textMessage | The message object, see the $TUIRoomTextMessage$ object for details. |
onReceiveCustomMessage:
onReceiveCustomMessage:
- (void)onReceiveCustomMessage: |
Custom message received
Param | DESC |
customMessage | The message object, see the $TUIRoomCustomMessage$ object for details. |
onDeviceChanged:type:state:
onDeviceChanged:type:state:
- (void)onDeviceChanged: | (NSString *)deviceId |
type: | (TUIMediaDeviceType)type |
state: | (TUIMediaDeviceState)state |
Local device added.
Called when a device changes.
@deprecated It is not recommended to use it since version v2.0. It is recommended to use onDeviceChanged in {$TUIRoomDeviceManager$} instead.
Param | DESC |
deviceId | Device ID. |
state | 0: the device has been added; 1: the device has been removed; 2: the device has been enabled. |
type | Device type. More details, see TUIMediaDeviceType. |
Note
When a local device (including camera, microphone, and speaker) is added, the SDK will throw this event callback.