API Overview
TUIRoomEngine (No UI Interface)
TUIRoomEngine API is the Audio/Video call Component's No UI Interface, you can use this set of API to customize packaging according to your business needs.
TUIRoomEngine Core Methods
API | Description |
Create TUIRoomEngine Instance | |
Destroy TUIRoomEngine Instance | |
Login interface, you need to initialize user information before entering the room and perform a series of operations. | |
Logout interface, there will be actively leave room operation, destroy resources | |
Set local user name and avatar | |
Get local user basic information | |
Set event callback | |
Remove event callback |
Room Related Active Interface
API | Description |
Create room | |
Close the room | |
Entered room | |
Leave room | |
Connect to other room | |
Disconnect from other room | |
Get room data | |
Update room name | |
Set room management mode (only administrator or group owner can call) |
Local User View Rendering, Video Management
API | Description |
Set the view control for local user video rendering | |
Open local camera | |
Close local camera | |
Update local video codec quality settings | |
Start screen sharing | |
End screen sharing | |
Start pushing local video | |
Stop pushing local video |
Local User Audio Management
API | Description |
Open local microphone | |
Close local microphone | |
Update local audio codec quality settings | |
Start pushing local audio | |
Stop pushing local audio |
Remote User View Rendering, Video Management
API | Description |
Set the view control for remote user video rendering | |
Start playing remote user video | |
Stop playing remote user video | |
Mute remote user |
Room User Information
API | Description |
Get the member list in the room | |
Get member information |
Room User Management
API | Description |
Modify user role (only administrator or group owner can call) | |
Kick Remote User out of the Room (Only Administrator or Group Owner can call) |
Speech Management in Room
API | Description |
Media Device Management for All Users (Only Administrator or Group Owner can call) | |
Request Remote User to Open Media Device (Only Administrator or Group Owner can call) | |
Close Remote User's Media Device (Only Administrator or Group Owner can call) | |
Request to Open Local Media Device (Available for Ordinary Users) |
Microphone Seat Management in Room
API | Description |
Set Maximum Number of Microphone Seats (Only supported when entering the room and creating the room) | |
Get Microphone Seat List | |
Lock Microphone Seat (Including Position Lock, Audio State Lock, Video State Lock) | |
Go Live Locally Conference Scene: SPEAK_AFTER_TAKING_SEAT mode requires application to the host or administrator to allow going live, other modes do not support going live. Live Broadcast Scene: FREE_TO_SPEAK mode allows free going live, and speak after going live; SPEAK_AFTER_TAKING_SEAT mode requires application to the host or administrator to allow going live; other modes do not support going live. | |
Leave Microphone Seat Locally | |
Host/Administrator invites user to go live | |
Host/Administrator kicks user off the microphone seat |
Signaling Management
API | Description |
Cancel Request | |
Reply to Request |
Send Message
API | Description |
Send Text Message | |
Send Custom Message | |
Disable Remote User's Text Message Sending Ability (Only Administrator or Group Owner can call) | |
Disable All Users' Text Message Sending Ability (Only Administrator or Group Owner can call) Advanced Feature: Get TRTC Instance |
Advanced Feature: Get TRTC Instance
API | Description |
Get TRTC Instance Object | |
Get Device Management Object | |
Get Audio Effect Management Object | |
Get Beauty Management Object |
Event Type Definition
TUIRoomObserver is the Callback Event class corresponding to TUIRoomEngine. You can listen to the callback events you need through this callback.
Error Callback
Event | Description |
Error Callback Event |
Login Status Event Callback
API | Description |
User Kicked Offline Event | |
User Credential Timeout Event |
Room Event Callback
API | Description |
Room Name Change Event | |
All Users' Microphones Disabled in Room Event | |
All Users' Cameras Disabled in Room Event | |
All Users' Text Message Sending Disabled in Room Event | |
Room Dismissed Event | |
Kicked Out of Room Event | |
Room Microphone Control Mode Change |
Room User Event Callback
API | Description |
Remote User Entering Room Event | |
Remote User Leaving Room Event | |
User Role Change Event | |
User Video State Change Event | |
User Audio State Change Event | |
User Volume Change Event | |
User Text Message Sending Ability Change Event | |
User Network Status Change Event | |
Screen Sharing End Event |
Room Microphone Seat Event Callback
API | Description |
Room Maximum Microphone Seat Number Change Event (Only effective in conference type rooms) | |
Microphone Seat List Change Event | |
Received User Kicked Off Microphone Event |
Request Signaling Event Callback
API | Description |
Received Request Message Event | |
Received Request Cancellation Event |
Room Message Event Callback
API | Description |
Received Normal Text Message Event | |
Received Custom Message Event |