please select
Conference
  • Overview
  • Web
    • Run Sample Demo
    • Integration
    • UI Customization
    • Conference Control
    • In-Conference Chat
    • On-Cloud Recording
    • AI Noise Suppression
    • Robot Streaming
    • Virtual Background
    • More Features
      • Floating Window
      • Text Watermark
    • API Documentation
      • RoomKit API
      • RoomEngine API
        • API Overview
        • TUIRoomEngine
        • TUIRoomEvents
        • TUIRoomEngine Defines
    • FAQs
  • iOS
    • Run Sample Demo
    • Integration
    • UI Customization
    • Conference Control
    • In-Conference Chat
    • On-Cloud Recording
    • AI Noise Suppression
    • Robot Streaming
    • More Features
      • Floating Window
    • API Documentation
      • RoomKit API
      • RoomEngine API
        • API Overview
        • TUIRoomEngine
        • TUIRoomObserver
        • Type Definition
    • FAQs
  • Android
    • Run Sample Demo
    • Integration
    • UI Customization
    • Conference Control
    • In-Conference Chat
    • On-Cloud Recording
    • AI Noise Suppression
    • Robot Streaming
    • More Features
      • Floating Window
    • API Documentation
      • RoomKit API
      • RoomEngine API
        • API Overview
        • TUIRoomEngine
        • TUIRoomObserver
        • Type Definition
    • FAQs
  • Electron
    • Run Sample Demo
    • Integration
    • UI Customization
    • Conference Control
    • In-Conference Chat
    • On-Cloud Recording
    • AI Noise Suppression
    • Robot Streaming
    • More Features
      • Floating Window
      • Text Watermark
    • API Documentation
      • RoomKit API
      • RoomEngine API
        • API Overview
        • TUIRoomEvent
        • TUIRoomEngine
        • TUIRoomEngine Defines
    • FAQs
  • Flutter
    • Run Sample Demo
    • Integration
    • UI Customization
    • Conference Control
    • In-Conference Chat
    • On-Cloud Recording
    • AI Noise Suppression
    • Robot Streaming
    • More Features
      • Floating Window
    • API Documentation
      • RoomKit API
      • RoomEngine API
        • API Overview
        • TUIRoomEngine
        • TUIRoomObserver
        • Type Definition
    • FAQs
  • Overview
    • Overview
  • Activate the Service
  • Pricing
    • Free Minutes
    • Conference Monthly Packages
    • Billing Explanation for Subscription Package Duration
    • Pay-as-you-go
      • Billing of Audio and Video Duration
      • Billing of On-Cloud Recording and Recording Delivery
      • Billing of MixTranscoding and Relay to CDN
  • Server APIs
    • REST API
      • RESTful API Overview
      • RESTful API List
      • Room Management
        • Create a Room
        • Destroy a Room
        • Update the Room Information
        • Get the Room Information
      • User Management
        • Get the Room Member List
        • Update the Room Member Information
        • Change the Room Ownership
        • Mark Room Members
        • Ban Room Members
        • Unban Room Members
        • Get the Banned Room Member List
        • Remove Room Member
      • Seat Management
        • Get the Seat List
        • Pick User on the Seat
        • Kick User off the Seat
        • Lock the Seat
    • Third-Party Callback
      • Callback Overview
      • Callback Command List
      • Callback Configuration
        • Query Callback Configuration
        • Create Callback Configuration
        • Update Callback Configuration
        • Delete Callback Configuration
      • Room Related
        • After a Room Is Created
        • After a Room Is Destroyed
        • After the Room Information Is Updated
      • User Related
        • After a Room Is Entered
        • After a Room Is Left
      • Seat Connection Related
        • After the Seat List Is Changed
  • Error Code
Conference
Docs Overview/
Conference/
iOS/
API Documentation/
RoomEngine API/
TUIRoomObserver/

TUIRoomObserver

The TUIRoomObserver class is the Callback Event class corresponding to the TUIRoomEngine. You can listen to the Callback Events you are interested in through this interface.

onError

Error Event Callback.
- (void)onError:(TUIError)error message:(NSString *)message;
The parameters are as follows:
Parameter
Type
Meaning
error
TUIError
Error Code
message
NSString *
Error Message

onKickedOffLine

Other terminals login and get kicked off event.
- (void)onKickedOffLine:(NSString *)message;
The parameters are as follows:
Parameter
Type
Meaning
message
NSString *
Kicked out description

onUserSigExpired

User credential timeout event.
- (void)onUserSigExpired;

onRoomNameChanged

Room name change event.
- (void)onRoomNameChanged:(NSString *)roomId roomName:(NSString *)roomName;
Parameter
Type
Meaning
roomId
NSString *
Room ID
roomName
NSString *
Room Name

onAllUserMicrophoneDisableChanged

Inside the room, all users' mic is disabled event.
- (void)onAllUserMicrophoneDisableChanged:(NSString *)roomId isDisable:(BOOL)isDisable;
Parameter
Type
Meaning
roomId
NSString *
Room ID
isDisable
BOOL
Whether it is disabled

onAllUserCameraDisableChanged

All users' Camera in the Room are disabled event.
- (void)onAllUserCameraDisableChanged:(NSString *)roomId isDisable:(BOOL)isDisable;
Parameter
Type
Meaning
roomId
NSString *
Room ID
isDisable
BOOL
Whether it is disabled

onSendMessageForAllUserDisableChanged

Inside the room, all users' text message sending is disabled event.
- (void)onSendMessageForAllUserDisableChanged:(NSString *)roomId isDisable:(BOOL)isDisable;


onKickedOutOfRoom

Kicked out of the room event.
- (void)onKickedOutOfRoom:(NSString *)roomId message:(NSString *)message;
The parameters are as follows:
Parameter
Type
Meaning
roomId
NSString *
Room ID
message
NSString *
Description of being kicked out

onRoomDismissed

Room dissolution event.
- (void)onRoomDismissed:(NSString *)roomId;
The parameters are as follows:
Parameter
Type
Meaning
roomId
NSString *
Room ID

onRoomSpeechModeChanged

Mic control mode changes in the room.
- (void)onRoomSpeechModeChanged:(NSString *)roomId speechMode:(TUISpeechMode)mode;
Parameter
Type
Meaning
roomId
NSString *
Room ID
mode
Mic control mode

onRemoteUserEnterRoom

Remote user enters the room event.
- (void)onRemoteUserEnterRoom:(NSString *)roomId userInfo:(TUIUserInfo *)userInfo;
The parameters are as follows:
Parameter
Type
Meaning
roomId
NSString *
Room ID
userInfo
User information

onRemoteUserLeaveRoom

Remote user leaves the room event.
- (void)onRemoteUserLeaveRoom:(NSString *)roomId userInfo:(TUIUserInfo *)userInfo;
The parameters are as follows:
Parameter
Type
Meaning
roomId
NSString *
Room ID
userInfo
User information

onUserRoleChanged

User role changes event.
- (void)onUserRoleChanged:(NSString *)userId userRole:(TUIRole)userRole;
The parameters are as follows:
Parameter
Type
Meaning
userId
NSString *
User ID
userRole
TUIRole
User Role

onUserVideoStateChanged

User Video status changes event.
- (void)onUserVideoStateChanged:(NSString *)userId
                     streamType:(TUIVideoStreamType)streamType
                       hasVideo:(BOOL)hasVideo
                         reason:(TUIChangeReason)reason;
The parameters are as follows:
Parameter
Type
Meaning
userId
NSString *
User ID
streamType
Streams type
hasVideo
BOOL
Whether there are streams
reason
Reason for streams change

onUserAudioStateChanged

User Audio status changes event.
- (void)onUserAudioStateChanged:(NSString *)userId
                       hasAudio:(BOOL)hasAudio
                         reason:(TUIChangeReason)reason;
The parameters are as follows:
Parameter
Type
Meaning
userId
NSString *
User ID
hasAudio
BOOL
Whether there are Audio streams
reason
Reason for Audio streams change

onUserScreenCaptureStopped

Screen Sharing stopped Callback event.
- (void)onUserScreenCaptureStopped:(NSInteger)reason;
The parameters are as follows:
Parameter
Type
Meaning
reason
NSInteger
Stop reason:
0: User actively stops
1: Screen window closing causes the stop
2: Screen Sharing display screen status change (such as interface being unplugged, Projection mode change, etc.)

onRoomMaxSeatCountChanged

Maximum number of mic slots changes event in the room (only effective in meeting type rooms).
- (void)onRoomMaxSeatCountChanged:(NSString *)roomId maxSeatNumber:(NSInteger)maxSeatNumber;
Parameter
Type
Meaning
roomId
NSString *
Room ID
maxSeatNumber
NSInteger
Maximum number of mic slots in the room

onUserVoiceVolumeChanged

User volume change event.
- (void)onUserVoiceVolumeChanged:(NSDictionary<NSString *, NSNumber *> *)volumeMap;
The parameters are as follows:
Parameter
Type
Meaning
volumeMap
NSDictionary<NSString *, NSNumber *> *
Volume map

onSendMessageForUserDisableChanged

User text message sending ability changes event.
- (void)onSendMessageForUserDisableChanged:(NSString *)roomId 
                                    userId:(NSString *)userId 
                                 isDisable:(BOOL)muted;
Parameter
Type
Meaning
roomId
NSString *
Room ID
userId
NSString *
User ID
muted
BOOL
Whether it is prohibited to send text messages.

onUserNetworkQualityChanged

User network status change event.
- (void)onUserNetworkQualityChanged:(NSArray<TUINetworkInfo *> *)networkList;
The parameters are as follows:
Parameter
Type
Meaning
networkList
NSArray<TUINetworkInfo>*
Network status array, you can refer to TUINetworkInfo object

onSeatListChanged

Mic slot list changes event.
- (void)onSeatListChanged:(NSArray<TUISeatInfo *> *)seatList
                   seated:(NSArray<TUISeatInfo *> *)seatedList
                     left:(NSArray<TUISeatInfo *> *)leftList;
The parameters are as follows:
Parameter
Type
Meaning
seatList
NSArray<TUISeatInfo *> *
The latest user list on the mic, including newly on mic users
seatedList
NSArray<TUISeatInfo *> *
Newly on mic user list
leftList
NSArray<TUISeatInfo *> *
Newly off mic user list

onKickedOffSeat

Received the event of user being kicked off mic.
- (void)onKickedOffSeat:(NSString *)userId;
Parameter
Type
Meaning
userId
NSString *
User ID

onRequestReceived

Received request message event.
- (void)onRequestReceived:(TUIRequest *)request;
The parameters are as follows:
Parameter
Type
Meaning
request
Request content

onRequestCancelled

Received request cancellation event.
- (void)onRequestCancelled:(NSString *)requestId;
The parameters are as follows:
Parameter
Type
Meaning
requestId
NSString *
Request ID

onReceiveTextMessage

Received ordinary text message event.
- (void)onReceiveTextMessage:(NSString *)roomId
                     message:(TUIMessage *)message;
The parameters are as follows:
Parameter
Type
Meaning
roomId
NSString *
Room ID
message
Message content, detailed definition can refer to TUIRoomDefine.h file in TUIMessage definition

onReceiveCustomMessage

Received custom message event.
- (void)onReceiveCustomMessage:(NSString *)roomId
                       message:(TUIMessage *)message;
The parameters are as follows:
Parameter
Type
Meaning
roomId
NSString *
Room ID
message
Message content