API | Description |
Listen to TUIRoomEngine ready event.
Note: All methods except TUIRoomEngine.init must be executed after listening to the TUIRoomEngine ready event and the TUIRoomEngine.init method is executed successfully. | |
Login to TUIRoomEngine | |
Set the current user's basic information (username, user avatar) | |
Get the current user's basic information (username, user avatar) | |
Logout from TUIRoomEngine |
API | Description |
Create room | |
Entered room | |
Close the room | |
Leave room | |
Get room data | |
Update the room's name (Only group owner or administrator can call) | |
Update the room's speech mode (Only group owner or administrator can call) | |
Get the current room user list | |
Get user Learn more |
API | Description |
Set the view control for local user video rendering | |
Open local camera | |
Close local camera | |
Open local microphone | |
Close local microphone | |
Update local video codec quality settings | |
Update local audio codec quality settings | |
Start pushing local video | |
Stop pushing local video | |
Start pushing local audio | |
Stop pushing local audio | |
Set the view control for remote user video rendering | |
Start playing remote user video | |
Stop playing remote user video | |
Mute remote user |
API | Description |
Request remote user to open media device | |
Participant applies to the host to open the device | |
Close remote user's media device | |
Cancel the sent request | |
Reply to remote user's request | |
Change user's role | |
Kick user out of the room | |
Disable/Enable all users' media devices | |
Disable/Enable all users to send messages | |
Disable/Enable a user to send messages |
API | Description |
Start screen sharing | |
End screen sharing | |
Get Screen Sharing List | |
Switch Screen Sharing Window |
API | Description |
Set Room Microphone Maximum | |
Get Microphone Information | |
Get Microphone | |
Release Microphone | |
Invite Others to Go Live (Only the Host and Administrator can call this method) | |
Kick Off Microphone (Only the Host and Administrator can call this method) | |
Lock a Microphone Status (Only the Host and Administrator can call this method) |
API | Description |
Send text message | |
Send custom message |
API | Description |
Get camera device list | |
Get mic device list | |
Get speaker device list | |
Set the camera device to use | |
Set the mic device to use | |
Set the speaker device to use | |
Get the currently used camera device | |
Get the currently used mic device | |
Get the currently used speaker device | |
Start camera device test | |
Stop camera device test |
API | Description |
API | Description |
Get trtcCloud instance | |
Get tim instance |
EVENT | Description |
Error Event | |
Kick out of room event | |
User Kicked Offline Event | |
User Credential Timeout Event | |
Room Dismissed Event | |
Room Name Change Event | |
Room Microphone Control Mode Change | |
All Users' Cameras Disabled in Room Event | |
All Users' Microphones Disabled in Room Event | |
All Users' Text Message Sending Disabled in Room Event | |
Maximum number of microphone slots in the room modification event | |
Remote user Entered room event | |
Remote user leaving room event | |
Role change event | |
Video Status change event | |
Audio Status change event | |
Send message status event | |
Volume change event | |
Network quality change event | |
Mic position list change event | |
Kicked off the mic event | |
Request received event | |
Request cancelled event | |
Receive text message event | |
Receive custom message event | |
Device change event | |
Screen sharing stopped event
When a user uses the built-in browser's stop sharing button to end Screen Sharing, the user will receive the 'onUserScreenCaptureStopped' event to modify the Sharing status. |
Was this page helpful?