API Overview
TUIRoomEngine
TUIRoomEngine API List
TUIRoomEngine Static Methods
API | Description |
Listen to the TUIRoomEngine ready event. Note: All methods except TUIRoomEngine.init must be executed after listening to the TUIRoomEngine ready event and successful execution of the TUIRoomEngine.init method. | |
Log in to TUIRoomEngine | |
Set current user basic information (userName, user profile photo) | |
Get current user basic information (userName, user profile photo) | |
Logout TUIRoomEngine | |
Retrieve the TUIRoomEngine singleton |
roomEngine Room Management API
API | Description |
Create Room | |
Enter room | |
Terminate room | |
Exit the room | |
Obtain room information | |
Update room name (only group owner or admin can call the API) | |
Update room speech mode (only group owner or admin can call the API). This API is deprecated since version 2.0.0. | |
Update room microphone mode (only group owner or admin can call the API) | |
Update room password (only group owner or admin can call the API) | |
Retrieve the current room user list. | |
User's detailed information | |
Set room custom information. This API can only be called after the anchor enters the room. | |
Retrieve room custom information |
roomEngine Audio and Video API
API | Description |
Set the rendering position for the local stream | |
Local camera video stream capture | |
Turn off the local camera | |
Open the local microphone | |
Close the local microphone | |
Set local video parameters | |
Set local audio parameters | |
Set the resolution mode of the local video stream | |
Set the encoding parameters of the local video stream | |
Start screen sharing | |
Stop screen sharing | |
Start pushing the local video stream to remote | |
Stop pushing the local video stream to remote | |
Start pushing the local audio stream to remote (this API was deprecated in version 2.9.1) | |
Stop pushing the local audio stream to remote (this API was deprecated in version 2.9.1) | |
Stop pushing the local audio stream to remote | |
Start pushing the local audio stream to remote | |
Set the rendering area for remote streaming | |
Start playing the remote user's video stream | |
Stop playing the remote user's video stream | |
Stop the remote user's audio stream | |
Set the remote audio playback volume |
roomEngine Member Management API
API | Description |
Request remote user to open media device | |
Attendee submits an application to the host to turn on the device | |
Disable remote user's media device | |
Cancel the request | |
Reply to the remote user's request | |
Change user's role | |
Remove user from room | |
Disable/Enable all users' media devices | |
Forbid/Allow all users to send message | |
Forbid/Allow specific user to send message | |
Update user name in the room. Ordinary members can modify their own, while admins can modify both self and ordinary members'. |
roomEngine Seat Management API
API | Description |
Retrieve seat information | |
Retrieve seat information | |
Release microphone position | |
Move a seat | |
Invite others to the stage (only the room host and admin can call this method) | |
Kick off the mic (only the room host and admin can call this method) | |
Lock a certain seat status (only the room host and admin can call this method) | |
Retrieve the Microphone Request List. This API is supported since v2.1.0 (only the room host and admin can call this method). |
roomEngine Message Sending API (This module is deprecated since v2.0.0. For chat module, please use chat instance implementation)
API | Description |
Send message. This API is deprecated since v2.0.0. | |
Send custom messages. This API is deprecated since v2.0.0 |
roomEngine Device Management API
API | Description |
Retrieve the Camera List | |
Retrieve the Microphone List | |
Retrieve the Speaker List | |
Set the camera to be used | |
Switch front and rear cameras. This API is only applicable to mobile browsers. | |
Set the microphone to be used | |
Set the speaker to be used | |
Retrieve the camera in use | |
Retrieve the microphone in use | |
Retrieve the speaker in use | |
Start camera test | |
Stop camera test | |
Start mic test | |
Stop mic test |
roomEngine Event Monitoring API
roomEngine Other APIs
API | Description |
Get a TRTCCloud instance | |
Get a TIM instance | |
Obtain the device management module (supported from version 2.1.0) | |
Get the meeting list management module (supported from version 2.5.0) | |
Get the live list management module (supported from version 3.0.0) | |
Get the live stream layout management module (supported from version 3.0.0) | |
Get the live-connection management module (supported from version 3.2.0) | |
Get the live PK management module (supported from version 3.3.0) | |
Get the in-meeting invitation management module (supported from version 2.6.0) |
TUIRoomEngine Event Type
TUIRoomEvents is the callback event class for TUIRoomEngine. You can listen to callback events of interest through this callback.
EVENT | Description |
Error event | |
Room removal event | |
User Disconnected Event | |
UserSig expired event | |
Host destroy room event | |
Room name change event | |
Room speech mode modification event. This API is deprecated since version 2.0.0. | |
Microphone mode change event | |
Number of users in room change event | |
All members camera usage permission change event | |
All users in room screen sharing disabled event | |
All members microphone usage permission change event | |
All members message sending status change event | |
Maximum microphone slots in room change event | |
Remote user enters room event | |
Remote user leaves room event | |
User info change event in the room | |
User role change event | |
User video status change event | |
User audio status change event | |
User message sending status event | |
User volume change event | |
User network quality change event | |
Microphone position list change event | |
User kicked off seat event | |
Request received event | |
Request processed event | |
Request cancellation event | |
Receive text message event. This API is deprecated since v2.0.0. | |
Receive custom message event. This API is deprecated since v2.0.0 | |
Device change event | |
Screen sharing stop event When a user ends screen sharing using the browser's built-in stop sharing button, that user will receive the onUserScreenCaptureStopped event to modify the screen sharing status. | |
Autoplay failed event | |
Room metadata change event |
