このページは現在英語版のみで提供されており、日本語版も近日中に提供される予定です。ご利用いただきありがとうございます。

TUIRoomObserver

Copyright (c) 2024 Tencent. All rights reserved.
Module:   TUIRoomObserver @ TUIKitEngine.
Function: TUIRoomEngine event callback APIs.
﻿
TUIRoomObserver
TUIRoomObserver
FuncList
DESC
onError:message:
Error event callback.
onKickedOffLine:
The current user was kicked offline.
onUserSigExpired
The current user signature is expired.
onRoomNameChanged:roomName:
The name of the room has changed.
onRoomDismissed:reason:
Room was dismissed.
onKickedOutOfRoom:reason:message:
The current user has been kicked off from the room.
onRoomSeatModeChanged:seatMode:
The room seat mode has changed.
onRoomUserCountChanged:userCount:
The count of user in the room has changed.
onRemoteUserEnterRoom:userInfo:
Remote user entered room.
onRemoteUserLeaveRoom:userInfo:
Remote user left room.
onUserInfoChanged:modifyFlag:
User information has changed in the room.
onUserVideoStateChanged:streamType:hasVideo:reason:
The status of the user has video stream changed.
onUserAudioStateChanged:hasAudio:reason:
The status of the user has audio stream changed.
onUserVoiceVolumeChanged
User volume changed.
onSendMessageForUserDisableChanged:userId:isDisable:
The status of disabling to send message has changed for user.
onUserNetworkQualityChanged:
The user network status changed.
onUserScreenCaptureStopped:
Screen sharing stopped.
onRoomMaxSeatCountChanged:maxSeatNumber:
The maximum count of seats in the room changed (only available in conference rooms)
onSeatListChanged:seated:left:
Seat list changed.
onKickedOffSeat:operateUser:
The user was kicked off the seat.
onRequestReceived:
Receive a request message.
onRequestCancelled:operateUser:
Received a cancelled request.
onRequestProcessed:operateUser:
Receive a request to be processed by other administrator/owner.
onError:message:
onError:message:
- (void)onError:
(﻿TUIError﻿)errorCode
message:
(NSString *)message
Error event callback.Callback error events when entering a room or opening a device.
Param
DESC
errorCode
Error code. More details, see: ﻿TUIError﻿.
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:
(﻿TUIRoomDismissedReason﻿)reason
Room was dismissed.Param
DESC
reason
The reason why the room was dismissed. More details, see: ﻿TUIRoomDismissedReason﻿.
roomId
Room ID.
onKickedOutOfRoom:reason:message:
onKickedOutOfRoom:reason:message:
- (void)onKickedOutOfRoom:
(NSString *)roomId
reason:
(﻿TUIKickedOutOfRoomReason﻿)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:
(﻿TUISeatMode﻿)seatMode
The room seat mode has changed.Param
DESC
roomId
: Room ID.
seatMode
: Seat mode. More details, see ﻿TUISeatMode﻿.
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:
(﻿TUIUserInfo﻿ *)userInfo
Remote user entered room.Param
DESC
roomId
Room ID.
userInfo
User information. More details, see ﻿TUIUserInfo﻿.
onRemoteUserLeaveRoom:userInfo:
onRemoteUserLeaveRoom:userInfo:
- (void)onRemoteUserLeaveRoom:
(NSString *)roomId
userInfo:
(﻿TUIUserInfo﻿ *)userInfo
Remote user left room.Param
DESC
roomId
Room ID.
userInfo
User information. More details, see ﻿TUIUserInfo﻿.
onUserInfoChanged:modifyFlag:
onUserInfoChanged:modifyFlag:
- (void)onUserInfoChanged:
(﻿TUIUserInfo﻿ *)userInfo
modifyFlag:
(TUIUserInfoModifyFlag)modifyFlag
User information has changed in the room.Param
DESC
modifyFlag
Modifiable parameter. More details, see ﻿TUIUserInfoModifyFlag﻿.
userInfo
User information. More details, see ﻿TUIUserInfo﻿.
onUserVideoStateChanged:streamType:hasVideo:reason:
onUserVideoStateChanged:streamType:hasVideo:reason:
- (void)onUserVideoStateChanged:
(NSString *)userId
streamType:
(﻿TUIVideoStreamType﻿)streamType
hasVideo:
(BOOL)hasVideo
reason:
(﻿TUIChangeReason﻿)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
Video stream type. More details, see ﻿TUIVideoStreamType﻿.
userId
User ID.
onUserAudioStateChanged:hasAudio:reason:
onUserAudioStateChanged:hasAudio:reason:
- (void)onUserAudioStateChanged:
(NSString *)userId
hasAudio:
(BOOL)hasAudio
reason:
(﻿TUIChangeReason﻿)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:
(NSArray<﻿TUINetworkInfo﻿ *> *)networkList
The user network status changed.Param
DESC
networkList
User network status list. More details, see ﻿TUINetworkInfo﻿.
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:
(NSArray<﻿TUISeatInfo﻿ *> *)seatList
seated:
(NSArray<﻿TUISeatInfo﻿ *> *)seatedList
left:
(NSArray<﻿TUISeatInfo﻿ *> *)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:operateUser:
onKickedOffSeat:operateUser:
- (void)onKickedOffSeat:
(NSInteger)seatIndex
operateUser:
(﻿TUIUserInfo﻿ *)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:
(﻿TUIRequest﻿ *)request
Receive a request message.Param
DESC
request
Request content. More details, see ﻿TUIRequest﻿.
onRequestCancelled:operateUser:
onRequestCancelled:operateUser:
- (void)onRequestCancelled:
(﻿TUIRequest﻿ *)request
operateUser:
(﻿TUIUserInfo﻿ *)operateUser
Received a cancelled request.Param
DESC
operateUser
Operator information.
request
Request content. More details, see ﻿TUIRequest﻿.
onRequestProcessed:operateUser:
onRequestProcessed:operateUser:
- (void)onRequestProcessed:
(﻿TUIRequest﻿ *)request
operateUser:
(﻿TUIUserInfo﻿ *)operateUser
Receive a request to be processed by other administrator/owner.Param
DESC
operateUser
Operator information.
request
Request content. More details, see ﻿TUIRequest﻿.

FuncList	DESC
onError:message:	Error event callback.
onKickedOffLine:	The current user was kicked offline.
onUserSigExpired	The current user signature is expired.
onRoomNameChanged:roomName:	The name of the room has changed.
onRoomDismissed:reason:	Room was dismissed.
onKickedOutOfRoom:reason:message:	The current user has been kicked off from the room.
onRoomSeatModeChanged:seatMode:	The room seat mode has changed.
onRoomUserCountChanged:userCount:	The count of user in the room has changed.
onRemoteUserEnterRoom:userInfo:	Remote user entered room.
onRemoteUserLeaveRoom:userInfo:	Remote user left room.
onUserInfoChanged:modifyFlag:	User information has changed in the room.
onUserVideoStateChanged:streamType:hasVideo:reason:	The status of the user has video stream changed.
onUserAudioStateChanged:hasAudio:reason:	The status of the user has audio stream changed.
onUserVoiceVolumeChanged	User volume changed.
onSendMessageForUserDisableChanged:userId:isDisable:	The status of disabling to send message has changed for user.
onUserNetworkQualityChanged:	The user network status changed.
onUserScreenCaptureStopped:	Screen sharing stopped.
onRoomMaxSeatCountChanged:maxSeatNumber:	The maximum count of seats in the room changed (only available in conference rooms)
onSeatListChanged:seated:left:	Seat list changed.
onKickedOffSeat:operateUser:	The user was kicked off the seat.
onRequestReceived:	Receive a request message.
onRequestCancelled:operateUser:	Received a cancelled request.
onRequestProcessed:operateUser:	Receive a request to be processed by other administrator/owner.

- (void)onError:	(TUIError)errorCode
message:	(NSString *)message

Param	DESC
errorCode	Error code. More details, see: TUIError.
message	Error message.

- (void)onRoomNameChanged:	(NSString *)roomId
roomName:	(NSString *)roomName

- (void)onRoomDismissed:	(NSString *)roomId
reason:	(TUIRoomDismissedReason)reason

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

- (void)onKickedOutOfRoom:	(NSString *)roomId
reason:	(TUIKickedOutOfRoomReason)reason
message:	(NSString *)message

- (void)onRoomSeatModeChanged:	(NSString *)roomId
seatMode:	(TUISeatMode)seatMode

- (void)onRoomUserCountChanged:	(NSString *)roomId
userCount:	(NSInteger)userCount

- (void)onRemoteUserEnterRoom:	(NSString *)roomId
userInfo:	(TUIUserInfo *)userInfo

- (void)onRemoteUserLeaveRoom:	(NSString *)roomId
userInfo:	(TUIUserInfo *)userInfo

- (void)onUserInfoChanged:	(TUIUserInfo *)userInfo
modifyFlag:	(TUIUserInfoModifyFlag)modifyFlag

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

- (void)onUserVideoStateChanged:	(NSString *)userId
streamType:	(TUIVideoStreamType)streamType
hasVideo:	(BOOL)hasVideo
reason:	(TUIChangeReason)reason

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	Video stream type. More details, see TUIVideoStreamType.
userId	User ID.

- (void)onUserAudioStateChanged:	(NSString *)userId
hasAudio:	(BOOL)hasAudio
reason:	(TUIChangeReason)reason

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.

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

- (void)onSendMessageForUserDisableChanged:	(NSString *)roomId
userId:	(NSString *)userId
isDisable:	(BOOL)muted

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

Param	DESC
networkList	User network status list. More details, see TUINetworkInfo.

- (void)onRoomMaxSeatCountChanged:	(NSString *)roomId
maxSeatNumber:	(NSInteger)maxSeatNumber

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

- (void)onSeatListChanged:	(NSArray<TUISeatInfo > )seatList
seated:	(NSArray<TUISeatInfo > )seatedList
left:	(NSArray<TUISeatInfo > )leftList

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.

- (void)onKickedOffSeat:	(NSInteger)seatIndex
operateUser:	(TUIUserInfo *)operateUser

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

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

- (void)onRequestCancelled:	(TUIRequest *)request
operateUser:	(TUIUserInfo *)operateUser

- (void)onRequestProcessed:	(TUIRequest *)request
operateUser:	(TUIUserInfo *)operateUser