Last updated: 2023-10-20 10:14:03Download PDF
TUIRoomEngine API List
TUIRoomEngine API is the UI-free interface of the Conference Component, which allows you to customize the encapsulation according to your business needs.
TUIRoomEngine Core Methods
Create Instance of TUIRoomEngine.
Login Interface, you need to initialize user information before entering the room and perform a series of operations.
Logout Interface, there will be active room leaving operation and resources destruction.
Set local user name and avatar.
Get the basic information of the local user login.
Set Event Callback.
Remove Event Callback.
Active Interface related to the room
Create a room.
Close the room.
Leave the room.
Connect to another room.
Disconnect from another room.
Get Room data.
Update Room ID (only administrator or group owner can call).
Set Mic Control Mode for the room (only administrator or group owner can call).
Local user view rendering and video management
Set the View Control for local user video rendering.
Open local Camera.
Close local Camera.
Update Encoding Quality settings for local video.
Start pushing local video.
Stop pushing local video.
Start Screen Sharing (this interface is only supported on mobile devices).
Start Screen Sharing (this interface is only supported on Mac OS desktop systems).
End Screen Sharing.
Enumerate shareable screens and windows (this interface is only supported on Mac OS systems).
Select the screen or window to share (this interface is only supported on Mac OS systems).
Local user audio management
Remote user view rendering and video management
Room user information
Room user management
Room user speech management
Control the permission status of all users in the current room to open audio streams, video streams, and capture devices, such as: all users are prohibited from opening mics, all users are prohibited from opening cameras, all users are prohibited from opening screen sharing (currently only available in conference scenarios, and only administrators or group owners can call).
Request remote user to open media device (only administrator or group owner can call).
Close remote user media device (only administrator or group owner can call).
Request to open local media device (available for ordinary users).
Room mic seat management
Set the maximum number of mic seats (only supported when entering the room and creating the room).
Get the list of mic seats.
Lock the mic seat (only administrator or group owner can call, including position lock, audio status lock, and video status lock).
Apply to Go Live (no need to apply in free speech mode).
Apply to leave the mic (no need to apply in free speech mode).
Host/Administrator invites user to Go Live.
Host/Administrator kicks user off the mic.
Send Text Message.
Send Custom Message.
Disable remote user's ability to send text messages (only administrator or group owner can call).
Disable all users' ability to send text messages (only administrator or group owner can call).
Advanced features: Get TRTC instance
TUIRoomObserver Callback Events
TUIRoomObserver is the callback event class corresponding to TUIRoomEngine. You can listen to the callback events you need through this callback.
Error Event Callback.
Login status event callback
Room event callback
Room ID change event.
All users in the room have their mics disabled event.
All users in the room have their cameras disabled event.
All users in the room have their text message sending disabled event.
Kicked out of the room event.
Room closed event.
Room Mic Control Mode changed.
Room user event callback
Remote user entered room event.
Remote user left the room event.
User role changed event.
User video status changed event.
User audio status changed event.
User screen capture stopped event.
User volume change event.
User text message sending ability changed event.
User network status change event.
Room mic seat event callback
Request signaling event callback
Room message event callback