- Release Notes and Announcements
- Release Notes
- TRTC Live (TUILiveKit) Product Launch Announcement
- TRTC Conference Official Editions Launched
- The commercial version of Conference is coming soon
- Terms and Conditions Applicable to $9.9 Starter Package
- Rules for the "First Subscription $100 Discount" Promotion
- Announcement on the Start of Beta Testing for Multi-person Audio and Video Conference
- TRTC Call Official Editions Launched
- License Required for Video Playback in New Version of LiteAV SDK
- TRTC to Offer Monthly Packages
- Product Introduction
- Purchase Guide
- Billing Overview
- RTC-Engine Packages
- TRTC Call Monthly Packages
- TRTC Conference Monthly Packages
- TRTC Live Monthly Packages
- Pay-As-You-Go
- Billing Explanation for Subscription Package Duration
- Billing of On-Cloud Recording
- Billing of MixTranscoding and Relay to CDN
- Free Minutes
- FAQs
- Billing of Monitoring Dashboard
- Billing of Recording Delivery
- Overdue and Suspension Policy
- Refund Policies
- User Tutorial
- Free Demo
- Video Calling (Including UI)
- Overview (TUICallKit)
- Activate the Service（TUICallKit）
- Integration (TUICallKit)
- UI Customization (TUICallKit)
- Offline Call Push (TUICallKit)
- On-Cloud Recording (TUICallKit)
- Additional Features（TUICallKit）
- Server APIs (TUICallKit)
- Client APIs (TUICallKit)
- ErrorCode
- Release Notes (TUICallKit)
- FAQs(TUICallKit)
- Multi-Participant Conference (with UI)
- Overview (TUIRoomKit)
- Activate the Service (TUIRoomKit)
- Integration (TUIRoomKit)
- UI Customization (TUIRoomKit)
- Conference Control (TUIRoomKit)
- Cloud Recording (TUIRoomKit)
- API Documentation(TUIRoomKit)
- In-Conference Chat (TUIRoomKit)
- FAQs (TUIRoomKit)
- Error Code (TUIRoomKit)
- Live Streaming (Including UI)
- Voice Chat Room (with UI)
- Integration (No UI)
- SDK Download
- API Examples
- Integration Guide
- Client APIs
- Advanced Features
- Relay to CDN
- Enabling Advanced Permission Control
- RTMP Streaming with TRTC
- Utilizing Beautification Effects
- Testing Hardware Devices
- Testing Network Quality
- On-Cloud Recording
- Custom Capturing and Rendering
- Custom Audio Capturing and Playback
- Sending and Receiving Messages
- Event Callbacks
- Access Management
- How to push stream to TRTC room with OBS WHIP
- Server APIs
- Console Guide
- Solution
- FAQs
- Legacy Documentation
- Protocols and Policies
- TRTC Policy
- Glossary
- Release Notes and Announcements
- Release Notes
- TRTC Live (TUILiveKit) Product Launch Announcement
- TRTC Conference Official Editions Launched
- The commercial version of Conference is coming soon
- Terms and Conditions Applicable to $9.9 Starter Package
- Rules for the "First Subscription $100 Discount" Promotion
- Announcement on the Start of Beta Testing for Multi-person Audio and Video Conference
- TRTC Call Official Editions Launched
- License Required for Video Playback in New Version of LiteAV SDK
- TRTC to Offer Monthly Packages
- Product Introduction
- Purchase Guide
- Billing Overview
- RTC-Engine Packages
- TRTC Call Monthly Packages
- TRTC Conference Monthly Packages
- TRTC Live Monthly Packages
- Pay-As-You-Go
- Billing Explanation for Subscription Package Duration
- Billing of On-Cloud Recording
- Billing of MixTranscoding and Relay to CDN
- Free Minutes
- FAQs
- Billing of Monitoring Dashboard
- Billing of Recording Delivery
- Overdue and Suspension Policy
- Refund Policies
- User Tutorial
- Free Demo
- Video Calling (Including UI)
- Overview (TUICallKit)
- Activate the Service（TUICallKit）
- Integration (TUICallKit)
- UI Customization (TUICallKit)
- Offline Call Push (TUICallKit)
- On-Cloud Recording (TUICallKit)
- Additional Features（TUICallKit）
- Server APIs (TUICallKit)
- Client APIs (TUICallKit)
- ErrorCode
- Release Notes (TUICallKit)
- FAQs(TUICallKit)
- Multi-Participant Conference (with UI)
- Overview (TUIRoomKit)
- Activate the Service (TUIRoomKit)
- Integration (TUIRoomKit)
- UI Customization (TUIRoomKit)
- Conference Control (TUIRoomKit)
- Cloud Recording (TUIRoomKit)
- API Documentation(TUIRoomKit)
- In-Conference Chat (TUIRoomKit)
- FAQs (TUIRoomKit)
- Error Code (TUIRoomKit)
- Live Streaming (Including UI)
- Voice Chat Room (with UI)
- Integration (No UI)
- SDK Download
- API Examples
- Integration Guide
- Client APIs
- Advanced Features
- Relay to CDN
- Enabling Advanced Permission Control
- RTMP Streaming with TRTC
- Utilizing Beautification Effects
- Testing Hardware Devices
- Testing Network Quality
- On-Cloud Recording
- Custom Capturing and Rendering
- Custom Audio Capturing and Playback
- Sending and Receiving Messages
- Event Callbacks
- Access Management
- How to push stream to TRTC room with OBS WHIP
- Server APIs
- Console Guide
- Solution
- FAQs
- Legacy Documentation
- Protocols and Policies
- TRTC Policy
- Glossary
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 | 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 | User Role |
onUserVideoStateChanged
User Video status changes event.
- (void)onUserVideoStateChanged:(NSString *)userIdstreamType:(TUIVideoStreamType)streamTypehasVideo:(BOOL)hasVideoreason:(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 *)userIdhasAudio:(BOOL)hasAudioreason:(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 *)roomIduserId:(NSString *)userIdisDisable:(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 | Network status array, you can refer to TUINetworkInfo object |
onSeatListChanged
Mic slot list changes event.
- (void)onSeatListChanged:(NSArray<TUISeatInfo *> *)seatListseated:(NSArray<TUISeatInfo *> *)seatedListleft:(NSArray<TUISeatInfo *> *)leftList;
The parameters are as follows:
Parameter | Type | Meaning |
seatList | The latest user list on the mic, including newly on mic users | |
seatedList | Newly on mic user list | |
leftList | 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 *)roomIdmessage:(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 *)roomIdmessage:(TUIMessage *)message;
The parameters are as follows:
Parameter | Type | Meaning |
roomId | NSString * | Room ID |
message | Message content |
Yes
No
Was this page helpful?