Conference

Overview

Web
- Integration
- UI Customization
- In-Conference Chat
- Cloud Recording
- API Documentation
  - API Overview
  - TUIRoomKit
  - TUIRoomEngine
  - TUIRoomEvents
  - TUIRoomEngine Defines
- FAQs
iOS
- Integration
- UI Customization
- Conference Control
- In-Conference Chat
- Cloud Recording
- API Documentation
  - API Overview
  - TUIRoomKit
  - TUIRoomEngine
  - TUIRoomObserver
  - Type Definition
- FAQs
Android
- Integration
- UI Customization
- Conference Control
- In-Conference Chat
- Cloud Recording
- API Documentation
  - API Overview
  - TUIRoomKit
  - TUIRoomEngine
  - TUIRoomObserver
  - Type Definition
- FAQs
Electron
- Integration
- UI Customization
- In-Conference Chat
- Cloud Recording
- API Documentation
  - API Overview
  - TUIRoomKit
  - TUIRoomEngine
  - TUIRoomEvent
  - TUIRoomEngine Defines
- FAQs
Windows
- Integration
- UI Customization
- Cloud Recording
- API Documentation
  - API Overview
  - TUIRoomEngine
  - TUIRoomObserver
  - Type Definition
Flutter
- Integration
- UI Customization
- Conference Control
- Cloud Recording
- API Documentation
  - API Overview
  - TUIRoomEngine
  - TUIRoomObserver
  - Type Definition
- FAQs
Overview
- Overview

Conference

API Overview

TUIRoomEngine API List
TUIRoomEngine API is the UI-free interface of the Conference Component, which allows you to customize the encapsulation according to your business needs.
TUIRoomEngine
TUIRoomEngine Core Methods
API
Description
﻿createTUIRoomEngine﻿
Create Instance of TUIRoomEngine
﻿destroyTUIRoomEngine﻿
Destroy TUIRoomEngine Instance
﻿login﻿
Login interface, you need to initialize user information before entering the room and perform a series of operations.
﻿logout﻿
Logout interface, there will be actively leave room operation, destroy resources
﻿setSelfInfo﻿
Set local user name and avatar
﻿getSelfInfo﻿
Get local user basic information
﻿addObserver﻿
Set event callback
﻿removeObserver﻿
Remove event callback
Room Related Active Interface
API
Description
﻿createRoom﻿
Create room
﻿destroyRoom﻿
Close the room
﻿enterRoom﻿
Entered room
﻿exitRoom﻿
Leave room
﻿connectOtherRoom﻿
Connect to other room
﻿disConnectOtherRoom﻿
Disconnect from other room
﻿fetchRoomInfo﻿
Get room data
﻿updateRoomNameByAdmin﻿
Update room name(only administrator or group owner can call)
﻿updateRoomSpeechModeByAdmin﻿
Set room management mode (only administrator or group owner can call)
Local User View Rendering, Video Management
API
Description
﻿setLocalVideoView﻿
Set the view control for local user video rendering
﻿openLocalCamera﻿
Open local camera
﻿closeLocalCamera﻿
Close local camera
﻿updateVideoQuality﻿
Update local video codec quality settings
﻿startScreenSharing﻿
Start screen sharing
﻿stopScreenSharing﻿
End screen sharing
﻿getScreenSharingTargetList﻿
Enumerate shareable screens and windows
﻿selectScreenSharingTarget﻿
Select the screen or window to share
﻿startPushLocalVideo﻿
Start pushing local video
﻿stopPushLocalVideo﻿
Stop pushing local video
Local User Audio Management
API
Description
﻿openLocalMicrophone﻿
Open local microphone
﻿closeLocalMicrophone﻿
Close local microphone
﻿updateAudioQuality﻿
Update local audio codec quality settings
﻿startPushLocalAudio﻿
Start pushing local audio
﻿stopPushLocalAudio﻿
Stop pushing local audio
Remote User View Rendering, Video Management
API
Description
﻿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
Room User Information
API
Description
﻿getUserList﻿
Get the member list in the room
﻿getUserInfo﻿
Get member information
Room User Management
API
Description
﻿changeUserRole﻿
Modify user role (only administrator or group owner can call)
﻿kickRemoteUserOutOfRoom﻿
Kick Remote User out of the Room (Only Administrator or Group Owner can call)
Speech Management in Room
API
Description
﻿disableDeviceForAllUserByAdmin﻿
Control the permission status of whether all users in the current room can open Audio and Video streams capturing devices, such as: Prohibit All from turning on the mic, Prohibit All from turning on the Camera, Prohibit All from turning on Screen Sharing (currently only available in Meeting Scenario, and only Administrator or Group Owner can invoke).
﻿openRemoteDeviceByAdmin﻿
Request Remote User to Open Media Device (Only Administrator or Group Owner can call)
﻿closeRemoteDeviceByAdmin﻿
Close Remote User's Media Device (Only Administrator or Group Owner can call)
﻿applyToAdminToOpenLocalDevice﻿
Request to Open Local Media Device (Available for Ordinary Users)
Microphone Seat Management in Room
API
Description
﻿setMaxSeatCount﻿
Set Maximum Number of Microphone Seats (Only supported when entering the room and creating the room)
﻿getSeatList﻿
Get Microphone Seat List
﻿lockSeatByAdmin﻿
Lock Microphone Seat (Including Position Lock, Audio State Lock, Video State Lock)
﻿takeSeat﻿
Apply to Go Live (Not Required in Free Speech Mode)
﻿leaveSeat﻿
Apply to leave Live (Not Required in Free Speech Mode)
﻿takeUserOnSeatByAdmin﻿
Host/Administrator invites user to go live
﻿kickUserOffSeatByAdmin﻿
Host/Administrator kicks user off the microphone seat
Send Message
API
Description
﻿sendTextMessage﻿
Send Text Message
﻿sendCustomMessage﻿
Send Custom Message
﻿disableSendingMessageByAdmin﻿
Disable Remote User's Text Message Sending Ability (Only Administrator or Group Owner can call)
﻿disableSendingMessageForAllUser﻿
Disable All Users' Text Message Sending Ability (Only Administrator or Group Owner can call)
Advanced Feature: Get TRTC Instance
Signaling Management
API
Description
﻿cancelRequest﻿
Cancel Request
﻿responseRemoteRequest﻿
Reply to Request
Advanced Feature: Get TRTC Instance
API
Description
﻿getTRTCCloud﻿
Get TRTC Instance Object
﻿getDeviceManager﻿
Get Device Management Object
﻿getAudioEffectManager﻿
Get Audio Effect Management Object
﻿
TTUIRoomObserver Callback Event
TUIRoomObserver is the Callback Event class corresponding to TUIRoomEngine. You can monitor the Callback Events you need through this Callback.
TUIRoomObserver
TUIRoomObserver
Error Callback
API
Description
﻿onError﻿
Error Callback Event
Login Status Event Callback
API
Description
﻿onKickedOffLine﻿
User Kicked Offline Event
﻿onUserSigExpired﻿
User Credential Timeout Event
Room Event Callback
API
Description
﻿onRoomNameChanged﻿
Room Name Change Event
﻿onAllUserMicrophoneDisableChanged﻿
All Users' Microphones Disabled in Room Event
﻿onAllUserCameraDisableChanged﻿
All Users' Cameras Disabled in Room Event
﻿onSendMessageForAllUserDisableChanged﻿
All Users' Text Message Sending Disabled in Room Event
﻿onKickedOutOfRoom﻿
Kicked Out of Room Event
﻿onRoomDismissed﻿
Room Dismissed Event
﻿onRoomSpeechModeChanged﻿
Room Microphone Control Mode Change
Room User Event Callback
API
Description
﻿onRemoteUserEnterRoom﻿
Remote User Entering Room Event
﻿onRemoteUserLeaveRoom﻿
Remote User Leaving Room Event
﻿onUserRoleChanged﻿
User Role Change Event
﻿onUserVideoStateChanged﻿
User Video State Change Event
﻿onUserAudioStateChanged﻿
User Audio State Change Event
﻿onUserVoiceVolumeChanged﻿
User Volume Change Event
﻿onSendMessageForUserDisableChanged﻿
User Text Message Sending Ability Change Event
﻿onUserNetworkQualityChanged﻿
User Network Status Change Event
﻿onUserScreenCaptureStopped﻿
Screen Sharing End Event
Room Microphone Seat Event Callback
API
Description
﻿onRoomMaxSeatCountChanged﻿
Room Maximum Microphone Seat Number Change Event (Only effective in conference type rooms)
﻿onSeatListChanged﻿
Microphone Seat List Change Event
﻿onKickedOffSeat﻿
Received User Kicked Off Microphone Event
Request Signaling Event Callback
API
Description
﻿onRequestReceived﻿
Received Request Message Event
﻿onRequestCancelled﻿
Received Request Cancellation Event
Room Message Event Callback
API
Description
﻿onReceiveTextMessage﻿
Received Normal Text Message Event
﻿onReceiveCustomMessage﻿
Received Custom Message Event
﻿
﻿

API	Description
createTUIRoomEngine	Create Instance of TUIRoomEngine
destroyTUIRoomEngine	Destroy TUIRoomEngine Instance
login	Login interface, you need to initialize user information before entering the room and perform a series of operations.
logout	Logout interface, there will be actively leave room operation, destroy resources
setSelfInfo	Set local user name and avatar
getSelfInfo	Get local user basic information
addObserver	Set event callback
removeObserver	Remove event callback

API	Description
createRoom	Create room
destroyRoom	Close the room
enterRoom	Entered room
exitRoom	Leave room
connectOtherRoom	Connect to other room
disConnectOtherRoom	Disconnect from other room
fetchRoomInfo	Get room data
updateRoomNameByAdmin	Update room name(only administrator or group owner can call)
updateRoomSpeechModeByAdmin	Set room management mode (only administrator or group owner can call)

API	Description
setLocalVideoView	Set the view control for local user video rendering
openLocalCamera	Open local camera
closeLocalCamera	Close local camera
updateVideoQuality	Update local video codec quality settings
startScreenSharing	Start screen sharing
stopScreenSharing	End screen sharing
getScreenSharingTargetList	Enumerate shareable screens and windows
selectScreenSharingTarget	Select the screen or window to share
startPushLocalVideo	Start pushing local video
stopPushLocalVideo	Stop pushing local video

API	Description
openLocalMicrophone	Open local microphone
closeLocalMicrophone	Close local microphone
updateAudioQuality	Update local audio codec quality settings
startPushLocalAudio	Start pushing local audio
stopPushLocalAudio	Stop pushing local audio

API	Description
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
getUserList	Get the member list in the room
getUserInfo	Get member information

API	Description
changeUserRole	Modify user role (only administrator or group owner can call)
kickRemoteUserOutOfRoom	Kick Remote User out of the Room (Only Administrator or Group Owner can call)

API	Description
disableDeviceForAllUserByAdmin	Control the permission status of whether all users in the current room can open Audio and Video streams capturing devices, such as: Prohibit All from turning on the mic, Prohibit All from turning on the Camera, Prohibit All from turning on Screen Sharing (currently only available in Meeting Scenario, and only Administrator or Group Owner can invoke).
openRemoteDeviceByAdmin	Request Remote User to Open Media Device (Only Administrator or Group Owner can call)
closeRemoteDeviceByAdmin	Close Remote User's Media Device (Only Administrator or Group Owner can call)
applyToAdminToOpenLocalDevice	Request to Open Local Media Device (Available for Ordinary Users)

API	Description
setMaxSeatCount	Set Maximum Number of Microphone Seats (Only supported when entering the room and creating the room)
getSeatList	Get Microphone Seat List
lockSeatByAdmin	Lock Microphone Seat (Including Position Lock, Audio State Lock, Video State Lock)
takeSeat	Apply to Go Live (Not Required in Free Speech Mode)
leaveSeat	Apply to leave Live (Not Required in Free Speech Mode)
takeUserOnSeatByAdmin	Host/Administrator invites user to go live
kickUserOffSeatByAdmin	Host/Administrator kicks user off the microphone seat

API	Description
sendTextMessage	Send Text Message
sendCustomMessage	Send Custom Message
disableSendingMessageByAdmin	Disable Remote User's Text Message Sending Ability (Only Administrator or Group Owner can call)
disableSendingMessageForAllUser	Disable All Users' Text Message Sending Ability (Only Administrator or Group Owner can call) Advanced Feature: Get TRTC Instance

API	Description
cancelRequest	Cancel Request
responseRemoteRequest	Reply to Request

API	Description
getTRTCCloud	Get TRTC Instance Object
getDeviceManager	Get Device Management Object
getAudioEffectManager	Get Audio Effect Management Object

API	Description
onKickedOffLine	User Kicked Offline Event
onUserSigExpired	User Credential Timeout Event

API	Description
onRoomNameChanged	Room Name Change Event
onAllUserMicrophoneDisableChanged	All Users' Microphones Disabled in Room Event
onAllUserCameraDisableChanged	All Users' Cameras Disabled in Room Event
onSendMessageForAllUserDisableChanged	All Users' Text Message Sending Disabled in Room Event
onKickedOutOfRoom	Kicked Out of Room Event
onRoomDismissed	Room Dismissed Event
onRoomSpeechModeChanged	Room Microphone Control Mode Change

API	Description
onRemoteUserEnterRoom	Remote User Entering Room Event
onRemoteUserLeaveRoom	Remote User Leaving Room Event
onUserRoleChanged	User Role Change Event
onUserVideoStateChanged	User Video State Change Event
onUserAudioStateChanged	User Audio State Change Event
onUserVoiceVolumeChanged	User Volume Change Event
onSendMessageForUserDisableChanged	User Text Message Sending Ability Change Event
onUserNetworkQualityChanged	User Network Status Change Event
onUserScreenCaptureStopped	Screen Sharing End Event

API	Description
onRoomMaxSeatCountChanged	Room Maximum Microphone Seat Number Change Event (Only effective in conference type rooms)
onSeatListChanged	Microphone Seat List Change Event
onKickedOffSeat	Received User Kicked Off Microphone Event

API	Description
onRequestReceived	Received Request Message Event
onRequestCancelled	Received Request Cancellation Event

API	Description
onReceiveTextMessage	Received Normal Text Message Event
onReceiveCustomMessage	Received Custom Message Event