API Overview

TUIRoomEngine (No UI interface)
TUIRoomEngine Static method
API
Description
﻿once﻿
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﻿
Login to TUIRoomEngine
﻿setSelfInfo﻿
Set the current user's basic information (username, user avatar)
﻿getSelfInfo﻿
Get the current user's basic information (username, user avatar)
﻿logout﻿
Logout from TUIRoomEngine
RoomEngine Room Management API
API
Description
﻿createRoom﻿
Create room
﻿enterRoom﻿
Entered room
﻿destroyRoom﻿
Close the room
﻿exitRoom﻿
Leave room
﻿fetchRoomInfo﻿
Get room data
﻿updateRoomNameByAdmin﻿
Update the room's name (Only group owner or administrator can call)
﻿updateRoomSpeechModeByAdmin﻿
Update the room's speech mode (Only group owner or administrator can call)
﻿getUserList﻿
Get the current room user list
﻿getUserInfo﻿
Get user Learn more
roomEngine Audio Video API
API
Description
﻿setLocalVideoView﻿
Set the view control for local user video rendering
﻿openLocalCamera﻿
Open local camera
﻿closeLocalCamera﻿
Close local camera
﻿openLocalMicrophone﻿
Open local microphone
﻿closeLocalMicrophone﻿
Close local microphone
﻿updateVideoQuality﻿
Update local video codec quality settings
﻿updateAudioQuality﻿
Update local audio codec quality settings
﻿startPushLocalVideo﻿
Start pushing local video
﻿stopPushLocalVideo﻿
Stop pushing local video
﻿startPushLocalAudio﻿
Start pushing local audio
﻿stopPushLocalAudio﻿
Stop pushing local audio
﻿setRemoteVideoView﻿
Set the view control for remote user video rendering
﻿startPlayRemoteVideo﻿
Start playing remote user video
﻿stopPlayRemoteVideo﻿
Stop playing remote user video
﻿muteRemoteAudioStream﻿
Mute remote user
roomEngine Member Management API
API
Description
﻿openRemoteDeviceByAdmin﻿
Request remote user to open media device
﻿applyToAdminToOpenLocalDevice﻿
Participant applies to the host to open the device
﻿closeRemoteDeviceByAdmin﻿
Close remote user's media device
﻿cancelRequest﻿
Cancel the sent request
﻿responseRemoteRequest﻿
Reply to remote user's request
﻿changeUserRole﻿
Change user's role
﻿kickRemoteUserOutOfRoom﻿
Kick user out of the room
﻿disableDeviceForAllUserByAdmin﻿
Disable/Enable all users' media devices
﻿disableSendingMessageForAllUser﻿
Disable/Enable all users to send messages
﻿disableSendingMessageByAdmin﻿
Disable/Enable a user to send messages
roomEngine Screen Sharing API
API
Description
﻿startScreenSharingElectron﻿
Start screen sharing
﻿stopScreenSharingElectron﻿
End screen sharing
﻿getScreenSharingTarget﻿
Get Screen Sharing List
﻿selectScreenSharingTarget﻿
Switch Screen Sharing Window
roomEngine Microphone Management API
API
Description
﻿setMaxSeatCount﻿
Set Room Microphone Maximum
﻿getSeatList﻿
Get Microphone Information
﻿takeSeat﻿
Get Microphone
﻿leaveSeat﻿
Release Microphone
﻿takeUserOnSeatByAdmin﻿
Invite Others to Go Live (Only the Host and Administrator can call this method)
﻿kickUserOffSeatByAdmin﻿
Kick Off Microphone (Only the Host and Administrator can call this method)
﻿lockSeatByAdmin﻿
Lock a Microphone Status (Only the Host and Administrator can call this method)
roomEngine Message Sending API
API
Description
﻿sendTextMessage﻿
Send text message
﻿sendCustomMessage﻿
Send custom message
roomEngine Device Management API
API
Description
﻿getCameraDevicesList﻿
Get camera device list
﻿getMicDevicesList﻿
Get mic device list
﻿getSpeakerDevicesList﻿
Get speaker device list
﻿setCurrentCameraDevice﻿
Set the camera device to use
﻿setCurrentMicDevice﻿
Set the mic device to use
﻿setCurrentSpeakerDevice﻿
Set the speaker device to use
﻿getCurrentCameraDevice﻿
Get the currently used camera device
﻿getCurrentMicDevice﻿
Get the currently used mic device
﻿getCurrentSpeakerDevice﻿
Get the currently used speaker device
﻿startCameraDeviceTest﻿
Start camera device test
﻿stopCameraDeviceTest﻿
Stop camera device test
roomEngine Event Listening API
API
Description
﻿on﻿
Listen to TUIRoomEvents event
﻿off﻿
Cancel listening to TUIRoomEvents event
roomEngine Other API
API
Description
﻿getTRTCCloud﻿
Get trtcCloud instance
﻿getTIM﻿
Get tim instance
Event Type Definition
TUIRoomEvent is the Callback Event class corresponding to TUIRoomEngine. You can listen to Callback Events of interest through this callback.
EVENT
Description
﻿TUIRoomEvents.onError﻿
Error Event
﻿TUIRoomEvents.onKickedOutOfRoom﻿
Kick out of room event
﻿TUIRoomEvents.onKickedOffLine﻿
User Kicked Offline Event
﻿TUIRoomEvents.onUserSigExpired﻿
User Credential Timeout Event
﻿TUIRoomEvents.onRoomDismissed﻿
Room Dismissed Event
﻿TUIRoomEvents.onRoomNameChanged﻿
Room Name Change Event
﻿TUIRoomEvents.onRoomSpeechModeChanged﻿
Room Microphone Control Mode Change
﻿TUIRoomEvents.onAllUserCameraDisableChanged﻿
All Users' Cameras Disabled in Room Event
﻿TUIRoomEvents.onAllUserMicrophoneDisableChanged﻿
All Users' Microphones Disabled in Room Event
﻿TUIRoomEvents.onSendMessageForAllUserDisableChanged﻿
All Users' Text Message Sending Disabled in Room Event
﻿TUIRoomEvents.onRoomMaxSeatCountChanged﻿
Maximum number of microphone slots in the room modification event
﻿TUIRoomEvents.onRemoteUserEnterRoom﻿
Remote user Entered room event
﻿TUIRoomEvents.onRemoteUserLeaveRoom﻿
Remote user leaving room event
﻿TUIRoomEvents.onUserRoleChanged﻿
Role change event
﻿TUIRoomEvents.onUserVideoStateChanged﻿
Video Status change event
﻿TUIRoomEvents.onUserAudioStateChanged﻿
Audio Status change event
﻿TUIRoomEvents.onSendMessageForUserDisableChanged﻿
Send message status event
﻿TUIRoomEvents.onUserVoiceVolumeChanged﻿
Volume change event
﻿TUIRoomEvents.onUserNetworkQualityChanged﻿
Network quality change event
﻿TUIRoomEvents.onSeatListChanged﻿
Mic position list change event
﻿TUIRoomEvents.onKickedOffSeat﻿
Kicked off the mic event
﻿TUIRoomEvents.onRequestReceived﻿
Request received event
﻿TUIRoomEvents.onRequestCancelled﻿
Request cancelled event
﻿TUIRoomEvents.onReceiveTextMessage﻿
Receive text message event
﻿TUIRoomEvents.onReceiveCustomMessage﻿
Receive custom message event
﻿TUIRoomEvents.onDeviceChange﻿
Device change event
﻿TUIRoomEvents.onUserScreenCaptureStopped﻿
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.
﻿

TUIRoomEngine (No UI interface)
Event Type Definition

API	Description
once	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	Login to TUIRoomEngine
setSelfInfo	Set the current user's basic information (username, user avatar)
getSelfInfo	Get the current user's basic information (username, user avatar)
logout	Logout from TUIRoomEngine

API	Description
createRoom	Create room
enterRoom	Entered room
destroyRoom	Close the room
exitRoom	Leave room
fetchRoomInfo	Get room data
updateRoomNameByAdmin	Update the room's name (Only group owner or administrator can call)
updateRoomSpeechModeByAdmin	Update the room's speech mode (Only group owner or administrator can call)
getUserList	Get the current room user list
getUserInfo	Get user Learn more

API	Description
setLocalVideoView	Set the view control for local user video rendering
openLocalCamera	Open local camera
closeLocalCamera	Close local camera
openLocalMicrophone	Open local microphone
closeLocalMicrophone	Close local microphone
updateVideoQuality	Update local video codec quality settings
updateAudioQuality	Update local audio codec quality settings
startPushLocalVideo	Start pushing local video
stopPushLocalVideo	Stop pushing local video
startPushLocalAudio	Start pushing local audio
stopPushLocalAudio	Stop pushing local audio
setRemoteVideoView	Set the view control for remote user video rendering
startPlayRemoteVideo	Start playing remote user video
stopPlayRemoteVideo	Stop playing remote user video
muteRemoteAudioStream	Mute remote user

API	Description
openRemoteDeviceByAdmin	Request remote user to open media device
applyToAdminToOpenLocalDevice	Participant applies to the host to open the device
closeRemoteDeviceByAdmin	Close remote user's media device
cancelRequest	Cancel the sent request
responseRemoteRequest	Reply to remote user's request
changeUserRole	Change user's role
kickRemoteUserOutOfRoom	Kick user out of the room
disableDeviceForAllUserByAdmin	Disable/Enable all users' media devices
disableSendingMessageForAllUser	Disable/Enable all users to send messages
disableSendingMessageByAdmin	Disable/Enable a user to send messages

API	Description
startScreenSharingElectron	Start screen sharing
stopScreenSharingElectron	End screen sharing
getScreenSharingTarget	Get Screen Sharing List
selectScreenSharingTarget	Switch Screen Sharing Window

API	Description
setMaxSeatCount	Set Room Microphone Maximum
getSeatList	Get Microphone Information
takeSeat	Get Microphone
leaveSeat	Release Microphone
takeUserOnSeatByAdmin	Invite Others to Go Live (Only the Host and Administrator can call this method)
kickUserOffSeatByAdmin	Kick Off Microphone (Only the Host and Administrator can call this method)
lockSeatByAdmin	Lock a Microphone Status (Only the Host and Administrator can call this method)

API	Description
sendTextMessage	Send text message
sendCustomMessage	Send custom message

API	Description
getCameraDevicesList	Get camera device list
getMicDevicesList	Get mic device list
getSpeakerDevicesList	Get speaker device list
setCurrentCameraDevice	Set the camera device to use
setCurrentMicDevice	Set the mic device to use
setCurrentSpeakerDevice	Set the speaker device to use
getCurrentCameraDevice	Get the currently used camera device
getCurrentMicDevice	Get the currently used mic device
getCurrentSpeakerDevice	Get the currently used speaker device
startCameraDeviceTest	Start camera device test
stopCameraDeviceTest	Stop camera device test

API	Description
on	Listen to TUIRoomEvents event
off	Cancel listening to TUIRoomEvents event

API	Description
getTRTCCloud	Get trtcCloud instance
getTIM	Get tim instance

EVENT	Description
TUIRoomEvents.onError	Error Event
TUIRoomEvents.onKickedOutOfRoom	Kick out of room event
TUIRoomEvents.onKickedOffLine	User Kicked Offline Event
TUIRoomEvents.onUserSigExpired	User Credential Timeout Event
TUIRoomEvents.onRoomDismissed	Room Dismissed Event
TUIRoomEvents.onRoomNameChanged	Room Name Change Event
TUIRoomEvents.onRoomSpeechModeChanged	Room Microphone Control Mode Change
TUIRoomEvents.onAllUserCameraDisableChanged	All Users' Cameras Disabled in Room Event
TUIRoomEvents.onAllUserMicrophoneDisableChanged	All Users' Microphones Disabled in Room Event
TUIRoomEvents.onSendMessageForAllUserDisableChanged	All Users' Text Message Sending Disabled in Room Event
TUIRoomEvents.onRoomMaxSeatCountChanged	Maximum number of microphone slots in the room modification event
TUIRoomEvents.onRemoteUserEnterRoom	Remote user Entered room event
TUIRoomEvents.onRemoteUserLeaveRoom	Remote user leaving room event
TUIRoomEvents.onUserRoleChanged	Role change event
TUIRoomEvents.onUserVideoStateChanged	Video Status change event
TUIRoomEvents.onUserAudioStateChanged	Audio Status change event
TUIRoomEvents.onSendMessageForUserDisableChanged	Send message status event
TUIRoomEvents.onUserVoiceVolumeChanged	Volume change event
TUIRoomEvents.onUserNetworkQualityChanged	Network quality change event
TUIRoomEvents.onSeatListChanged	Mic position list change event
TUIRoomEvents.onKickedOffSeat	Kicked off the mic event
TUIRoomEvents.onRequestReceived	Request received event
TUIRoomEvents.onRequestCancelled	Request cancelled event
TUIRoomEvents.onReceiveTextMessage	Receive text message event
TUIRoomEvents.onReceiveCustomMessage	Receive custom message event
TUIRoomEvents.onDeviceChange	Device change event
TUIRoomEvents.onUserScreenCaptureStopped	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.