API List

TUIRoomEngine (non-UI API)
TUIRoomEngine Static Methods
API
Description
﻿once﻿
Listen for the TUIRoomEngine ready event.
Note: All methods other than TUIRoomEngine.init must be executed after the TUIRoomEngine ready event is received and the TUIRoomEngine.init method is successfully executed.
﻿login﻿
Log in to TUIRoomEngine
﻿logout﻿
Log out of TUIRoomEngine
﻿setSelfInfo﻿
Set basic information of the current user (user name, user avatar)
﻿getSelfInfo﻿
Get basic information of the current user (user name, user avatar)
﻿getDeviceManager﻿
Get device manager
﻿getAudioEffectManager﻿
Get audio effect manager
﻿getMediaMixingManager﻿
Get media source mixing manager
﻿getVideoEffectPluginManager﻿
Get video effect plugin manager
roomEngine Room Management API
API
Description
﻿createRoom﻿
Create a room
﻿enterRoom﻿
Enter a room
﻿destroyRoom﻿
Destroy a room
﻿exitRoom﻿
Exit a room
﻿fetchRoomInfo﻿
Fetch room information
﻿updateRoomNameByAdmin﻿
Update room name (Only available to room owners or administrators)
﻿updateRoomSeatModeByAdmin﻿
Update room seat mode (Only available to room owners or administrators)
roomEngine Audio and Video API
API
Description
﻿setLocalVideoView﻿
Set the HTML element where to play local camera video stream
﻿openLocalCamera﻿
Open local camera
﻿closeLocalCamera﻿
Close local camera
﻿startPushLocalVideo﻿
Start pushing the local video stream to the remote end
﻿stopPushLocalVideo﻿
Stop pushing the local video stream to the remote end
﻿updateVideoQuality﻿
Set local video parameters
﻿updateVideoQualityEx﻿
Set local video encoding parameters
﻿setVideoResolutionMode﻿
Set the resolution mode of the local video stream
﻿openLocalMicrophone﻿
Open local microphone
﻿closeLocalMicrophone﻿
Close local microphone
﻿updateAudioQuality﻿
Set local audio parameters
﻿muteLocalAudio﻿
Stop pushing the local audio stream to the remote end
﻿unmuteLocalAudio﻿
Start pushing the local audio stream to the remote end
﻿setRemoteVideoView﻿
Set the HTML element where to play the remote video stream
﻿startPlayRemoteVideo﻿
Start playing the remote user's video stream
﻿stopPlayRemoteVideo﻿
Stop playing the remote user's video stream
﻿muteRemoteAudioStream﻿
Stop the remote user's audio stream
roomEngine Screen/Window Sharing API
API
Description
﻿startScreenSharingElectron﻿
Start screen or window sharing
﻿stopScreenSharingElectron﻿
Stop screen or window sharing
﻿getScreenSharingTarget﻿
Get the screens and windows to be shared
﻿selectScreenSharingTarget﻿
Select the screen or window to share
roomEngine Member Management API
API
Description
﻿getUserList﻿
Get users list
﻿getUserInfo﻿
Get user detail information
﻿changeUserRole﻿
Change user role
﻿kickRemoteUserOutOfRoom﻿
Kick user out of current room
﻿cancelRequest﻿
Cancel a request already sent
﻿responseRemoteRequest﻿
Response to remote use request
﻿disableSendingMessageByAdmin﻿
Disable/Enable instant message chat
roomEngine Seat Management API
API
Description
﻿getSeatList﻿
Get seats information
﻿lockSeatByAdmin﻿
Lock a seat (only available to room owner and administrators)
﻿takeSeat﻿
Take a seat
﻿leaveSeat﻿
Release a seat
﻿takeUserOnSeatByAdmin﻿
Invite someone else to speak (only available to room owner and administrators)
﻿kickUserOffSeatByAdmin﻿
Kick someone off the seat (only available to room owner and administrators)
﻿getSeatApplicationList﻿
Get the list of speaking requests
roomEngine Event Listening API
API
Description
﻿on﻿
Add TUIRoomEvents event listener
﻿off﻿
Remove TUIRoomEvents evnet listener
roomEngine Malicious API
API
Description
﻿getTRTCCloud﻿
Get TRTCCloud instance
﻿getTIM﻿
Get TIM/Chat instance
Event Name Definition
TUIRoomEvent is an enum type of all the events supported by TUIRoomEngine.
EVENT
Description
﻿TUIRoomEvents.onError﻿
Error event
﻿TUIRoomEvents.onKickedOutOfRoom﻿
Kick out of room event
﻿TUIRoomEvents.onKickedOffSeat﻿
Kick off seat event
﻿TUIRoomEvents.onKickedOffLine﻿
Kick off line event
﻿TUIRoomEvents.onUserSigExpired﻿
userSig expired
﻿TUIRoomEvents.onRoomDismissed﻿
Room owner destroying room event
﻿TUIRoomEvents.onRoomNameChanged﻿
Room name changed event
﻿TUIRoomEvents.onRoomInfoChanged﻿
Room information changed event
﻿TUIRoomEvents.onRoomSeatModeChanged﻿
Seat mode change event
﻿TUIRoomEvents.onAllUserMicrophoneDisableChanged﻿
Disable/Enable all user microphone event
﻿TUIRoomEvents.onSendMessageForAllUserDisableChanged﻿
Disable/Enable all user instant message sending event
﻿TUIRoomEvents.onRoomMaxSeatCountChanged﻿
The maximize seats number change event
﻿TUIRoomEvents.onRemoteUserEnterRoom﻿
Remote user enter room event
﻿TUIRoomEvents.onRemoteUserLeaveRoom﻿
Remote user leave room event
﻿TUIRoomEvents.onUserRoleChanged﻿
User role changed event
﻿TUIRoomEvents.onUserVideoStateChanged﻿
User video stream changed event
﻿TUIRoomEvents.onUserAudioStateChanged﻿
User audio stream changed event
﻿TUIRoomEvents.onSendMessageForUserDisableChanged﻿
Disable/Enable a user instant message sending event
﻿TUIRoomEvents.onUserVoiceVolumeChanged﻿
User voice volume changed event
﻿TUIRoomEvents.onUserNetworkQualityChanged﻿
User network quality changed event
﻿TUIRoomEvents.onSeatControlEnabled﻿
Seat control enabled/disabled event
﻿TUIRoomEvents.onSeatListChanged﻿
Seats information changed event
﻿TUIRoomEvents.onRequestReceived﻿
Request received event
﻿TUIRoomEvents.onRequestProcessed﻿
Request processed event
﻿TUIRoomEvents.onRequestCancelled﻿
Request cancelled event
﻿TUIRoomEvents.onDeviceChange﻿
Device changed event
﻿TUIRoomEvents.onUserScreenCaptureStopped﻿
Screen sharing stopped event.

TUIRoomEngine (non-UI API)
Event Name Definition

API	Description
once	Listen for the TUIRoomEngine ready event. Note: All methods other than TUIRoomEngine.init must be executed after the TUIRoomEngine ready event is received and the TUIRoomEngine.init method is successfully executed.
login	Log in to TUIRoomEngine
logout	Log out of TUIRoomEngine
setSelfInfo	Set basic information of the current user (user name, user avatar)
getSelfInfo	Get basic information of the current user (user name, user avatar)
getDeviceManager	Get device manager
getAudioEffectManager	Get audio effect manager
getMediaMixingManager	Get media source mixing manager
getVideoEffectPluginManager	Get video effect plugin manager

API	Description
createRoom	Create a room
enterRoom	Enter a room
destroyRoom	Destroy a room
exitRoom	Exit a room
fetchRoomInfo	Fetch room information
updateRoomNameByAdmin	Update room name (Only available to room owners or administrators)
updateRoomSeatModeByAdmin	Update room seat mode (Only available to room owners or administrators)

API	Description
setLocalVideoView	Set the HTML element where to play local camera video stream
openLocalCamera	Open local camera
closeLocalCamera	Close local camera
startPushLocalVideo	Start pushing the local video stream to the remote end
stopPushLocalVideo	Stop pushing the local video stream to the remote end
updateVideoQuality	Set local video parameters
updateVideoQualityEx	Set local video encoding parameters
setVideoResolutionMode	Set the resolution mode of the local video stream
openLocalMicrophone	Open local microphone
closeLocalMicrophone	Close local microphone
updateAudioQuality	Set local audio parameters
muteLocalAudio	Stop pushing the local audio stream to the remote end
unmuteLocalAudio	Start pushing the local audio stream to the remote end
setRemoteVideoView	Set the HTML element where to play the remote video stream
startPlayRemoteVideo	Start playing the remote user's video stream
stopPlayRemoteVideo	Stop playing the remote user's video stream
muteRemoteAudioStream	Stop the remote user's audio stream

API	Description
startScreenSharingElectron	Start screen or window sharing
stopScreenSharingElectron	Stop screen or window sharing
getScreenSharingTarget	Get the screens and windows to be shared
selectScreenSharingTarget	Select the screen or window to share

API	Description
getUserList	Get users list
getUserInfo	Get user detail information
changeUserRole	Change user role
kickRemoteUserOutOfRoom	Kick user out of current room
cancelRequest	Cancel a request already sent
responseRemoteRequest	Response to remote use request
disableSendingMessageByAdmin	Disable/Enable instant message chat

API	Description
getSeatList	Get seats information
lockSeatByAdmin	Lock a seat (only available to room owner and administrators)
takeSeat	Take a seat
leaveSeat	Release a seat
takeUserOnSeatByAdmin	Invite someone else to speak (only available to room owner and administrators)
kickUserOffSeatByAdmin	Kick someone off the seat (only available to room owner and administrators)
getSeatApplicationList	Get the list of speaking requests

API	Description
on	Add TUIRoomEvents event listener
off	Remove TUIRoomEvents evnet listener

API	Description
getTRTCCloud	Get TRTCCloud instance
getTIM	Get TIM/Chat instance

EVENT	Description
TUIRoomEvents.onError	Error event
TUIRoomEvents.onKickedOutOfRoom	Kick out of room event
TUIRoomEvents.onKickedOffSeat	Kick off seat event
TUIRoomEvents.onKickedOffLine	Kick off line event
TUIRoomEvents.onUserSigExpired	userSig expired
TUIRoomEvents.onRoomDismissed	Room owner destroying room event
TUIRoomEvents.onRoomNameChanged	Room name changed event
TUIRoomEvents.onRoomInfoChanged	Room information changed event
TUIRoomEvents.onRoomSeatModeChanged	Seat mode change event
TUIRoomEvents.onAllUserMicrophoneDisableChanged	Disable/Enable all user microphone event
TUIRoomEvents.onSendMessageForAllUserDisableChanged	Disable/Enable all user instant message sending event
TUIRoomEvents.onRoomMaxSeatCountChanged	The maximize seats number change event
TUIRoomEvents.onRemoteUserEnterRoom	Remote user enter room event
TUIRoomEvents.onRemoteUserLeaveRoom	Remote user leave room event
TUIRoomEvents.onUserRoleChanged	User role changed event
TUIRoomEvents.onUserVideoStateChanged	User video stream changed event
TUIRoomEvents.onUserAudioStateChanged	User audio stream changed event
TUIRoomEvents.onSendMessageForUserDisableChanged	Disable/Enable a user instant message sending event
TUIRoomEvents.onUserVoiceVolumeChanged	User voice volume changed event
TUIRoomEvents.onUserNetworkQualityChanged	User network quality changed event
TUIRoomEvents.onSeatControlEnabled	Seat control enabled/disabled event
TUIRoomEvents.onSeatListChanged	Seats information changed event
TUIRoomEvents.onRequestReceived	Request received event
TUIRoomEvents.onRequestProcessed	Request processed event
TUIRoomEvents.onRequestCancelled	Request cancelled event
TUIRoomEvents.onDeviceChange	Device changed event
TUIRoomEvents.onUserScreenCaptureStopped	Screen sharing stopped event.