このページは現在英語版のみで提供されており、日本語版も近日中に提供される予定です。ご利用いただきありがとうございます。

API Overview

Overview
TUIRoomEngine (rtc_room_engine) is a component designed for scenarios involving corporate meetings, webinars, online education, etc., supporting multi-person audio and video conversations. It offers room management, multi-person TRTC interactions, member management, screen sharing, and other meeting control features, and supports various video qualities including standard definition, high definition, and ultra-high definition. By integrating this component, you can add multi-person audio and video conversation features to your application.
Integration method:
In your project's pubspec.yaml, add the following code to integrate TUIRoomEngine:
dependencies:   
    rtc_room_engine: latest version
Run the following command to install the component:
flutter pub get
TUIRoomEngine API List
TUIRoomEngine API is a no UI interface for multi-person audio and video rooms, you can use these APIs to perform custom encapsulation based on your business needs.
TUIRoomEngine
TUIRoomEngine Core Methods
API
Description
﻿sharedInstance﻿
Create TUIRoomEngine Instance.
﻿destroyISharedinstance﻿
Destroy TUIRoomEngine Instance.
﻿login﻿
Login Interface, you need to initialize user information first to enter the room and perform a series of operations.
﻿logout﻿
Logout Interface, which includes proactively leaving the room and destroying resources.
﻿setSelfInfo﻿
Set Local Username and Avatar.
﻿setLoginUserInfo﻿
Set Login User Information.
﻿getSelfInfo﻿
Obtain Basic Information of Local User Login.
﻿addObserver﻿
Set event callbacks.
﻿removeObserver﻿
Remove event callbacks.
Room-related proactive interface
API
Description
﻿createRoom﻿
Create Room.
﻿destroyRoom﻿
Dissolve Room.
﻿enterRoom﻿
Enter the room.
﻿exitRoom﻿
Leave the room.
﻿connectOtherRoom﻿
Connect to Other Rooms.
﻿disconnectOtherRoom﻿
Disconnect from Other Rooms.
﻿fetchRoomInfo﻿
Obtain room information.
﻿updateRoomNameByAdmin﻿
Update Room Name (only administrators or group owners can invoke).
﻿updateRoomSeatModeByAdmin﻿
Set Room Management Mode (only administrators or group owners can invoke).
Local User View Rendering, Video Management
API
Description
﻿setLocalVideoView﻿
Set control for local user video rendering.
﻿openLocalCamera﻿
Turns the local camera on.
﻿closeLocalCamera﻿
Turns the local camera off.
﻿updateVideoQuality﻿
Update local video encoding quality settings.
﻿updateVideoQualityEx﻿
Set encoding parameters for the video encoder
﻿setVideoResolutionMode﻿
Set the resolution mode for the video encoder
﻿enableGravitySensor﻿
Enable gravity sensing mode
﻿startPushLocalVideo﻿
Start pushing local video.
﻿stopPushLocalVideo﻿
Stop pushing local video.
﻿startScreenSharing﻿
Starting Screen Sharing
﻿stopScreenSharing﻿
End Screen Sharing
Local User Audio Management
API
Description
﻿openLocalMicrophone﻿
Enable the local mic.
﻿closeLocalMicrophone﻿
Disable the local mic.
﻿updateAudioQuality﻿
Update local audio encoding quality settings.
﻿muteLocalAudio﻿
Stop pushing local audio.
﻿unMuteLocalAudio﻿
Start pushing local audio.
Remote user view rendering, Video Management
API
Description
﻿setRemoteVideoView﻿
Set control for remote user video rendering.
﻿startPlayRemoteVideo﻿
Start playing remote user video.
﻿stopPlayRemoteVideo﻿
Stop playing remote user video.
﻿muteRemoteAudioStream﻿
Mute remote user.
Inside the Room User Information
API
Description
﻿getUserList﻿
Obtain the member list inside the room.
﻿getUserInfo﻿
Obtain member information.
In-room User Management
API
Description
﻿changeUserRole﻿
Modify User Role (only administrators or group owners can invoke).
﻿changeUserNameCard﻿
Modify User Nickname.
﻿kickRemoteUserOutOfRoom﻿
Remove Remote User from Room (only administrators or group owners can invoke).
﻿addCategoryTagForUsers﻿
Add a label to a user (only homeowners can call)
﻿removeCategoryTagForUsers﻿
Remove a label from a user (only homeowners can call)
﻿getUserListByTag﻿
Get user information in the room based on labels
﻿setCustomInfoForUser﻿
Set customized information for members in the room
User speaking management in the room
API
Description
﻿disableDeviceForAllUserByAdmin﻿
Control whether all users in the current room can enable audio stream, video stream capture devices. For example: prohibit everyone from turning on the microphone, camera, or screen sharing (currently available only in meeting scenarios, and only administrators or group owners can invoke).
﻿openRemoteDeviceByAdmin﻿
Request Remote User to Enable Media Devices (only administrators or group owners can invoke).
﻿closeRemoteDeviceByAdmin﻿
Turn Off Remote User Media Devices (only administrators or group owners can invoke).
﻿applyToAdminToOpenLocalDevice﻿
Request to Enable Local Media Devices (available for regular users).
Microphone Position Management within the Rooms
API
Description
﻿setMaxSeatCount﻿
Set Maximum Number of Microphones (can only be set before entering or creating a room).
﻿getSeatList﻿
Get the microphone position list.
﻿getSeatApplicationList﻿
Host/Administrator gets the request list of users applying for the microphone in the room.
﻿lockSeatByAdmin﻿
Lock Microphone Position (only administrators or group owners can invoke, including position lock, audio status lock, and video status lock).
﻿takeSeat﻿
Apply to join the microphone (no need to apply in free speaking mode).
﻿leaveSeat﻿
Apply to leave the microphone (no need to apply in free speaking mode).
﻿moveToSeat﻿
Disconnect Mic
﻿takeUserOnSeatByAdmin﻿
Host/Administrator invites users to go on stage.
﻿kickUserOffSeatByAdmin﻿
Host/Administrator removes users from the microphone.
Signaling Management
API
Description
﻿cancelRequest﻿
Cancel Request.
﻿responseRemoteRequest﻿
Reply Request.
Sending Message
API
Description
﻿disableSendingMessageByAdmin﻿
Disable the remote user's ability to send text messages (only administrators or group owners can call this).
﻿disableSendingMessageForAllUser﻿
Disable all users' ability to send text messages (only administrators or group owners can call this).
Advanced Features
API
Description
﻿setBeautyLevel﻿
Set beauty filter effect level
﻿setWhitenessLevel﻿
Set brightening filter effect level
﻿getExtension﻿
Get plugins
﻿getMediaDeviceManager﻿
Get device management class
Debugging related
API
Description
﻿callExperimentalAPI﻿
Calls an experimental API.
TUIRoomObserver Callback Event
TUIRoomObserver is the callback event class corresponding to TUIRoomEngine. You can use this callback to listen to the events you need.
TUIRoomObserver
TUIRoomObserver
Error Callback
API
Description
﻿onError﻿
Error event callback
Callback for login status event
API
Description
﻿onKickedOffLine﻿
Kicked offline by another client during terminal login.
﻿onUserSigExpired﻿
User credentials timeout event.
Room Event Callback
API
Description
﻿onRoomNameChanged﻿
Room name change event.
﻿onAllUserMicrophoneDisableChanged﻿
All users' microphones in the room have been disabled event.
﻿onAllUserCameraDisableChanged﻿
All users' cameras in the room have been disabled event.
﻿onScreenShareForAllUserDisableChanged﻿
All users' screen sharing in the room has been disabled event.
﻿onSendMessageForAllUserDisableChanged﻿
All users' ability to send text messages in the room has been disabled event.
﻿onKickedOutOfRoom﻿
Removed from the room event.
﻿onRoomDismissed﻿
Room dissolved event.
﻿onRoomSeatModeChanged﻿
Room Microphone Mode Change
﻿onRoomUserCountChanged﻿
Room population changed
User Event Callback Inside the Room
API
Description
﻿onRemoteUserEnterRoom﻿
Remote user entered room event.
﻿onRemoteUserLeaveRoom﻿
Remote user left room event.
﻿onUserRoleChanged﻿
User role changed event.
﻿onUserVideoStateChanged﻿
User video status changed event.
﻿onUserAudioStateChanged﻿
Event of User Audio Status Changed
﻿onUserVoiceVolumeChanged﻿
User volume changed event.
﻿onSendMessageForUserDisableChanged﻿
User text message sending capability changed event.
﻿onUserNetworkQualityChanged﻿
User network status changed event.
﻿onUserScreenCaptureStopped﻿
Screen sharing ended.
Room microphone position event callback
API
Description
﻿onRoomMaxSeatCountChanged﻿
Maximum number of microphones in room changed event (only in meeting type rooms).
﻿onSeatListChanged﻿
Microphone position list changed event.
﻿onKickedOffSeat﻿
User removed from microphone event received.
Request signaling event callback
API
Description
﻿onRequestReceived﻿
Request message event received.
﻿onRequestCancelled﻿
Request cancellation event received.
﻿onRequestProcessed﻿
Received request handled by another administrator/homeowner event

Overview
- Integration method:
TUIRoomEngine API List
TUIRoomObserver Callback Event

API	Description
sharedInstance	Create TUIRoomEngine Instance.
destroyISharedinstance	Destroy TUIRoomEngine Instance.
login	Login Interface, you need to initialize user information first to enter the room and perform a series of operations.
logout	Logout Interface, which includes proactively leaving the room and destroying resources.
setSelfInfo	Set Local Username and Avatar.
setLoginUserInfo	Set Login User Information.
getSelfInfo	Obtain Basic Information of Local User Login.
addObserver	Set event callbacks.
removeObserver	Remove event callbacks.

API	Description
createRoom	Create Room.
destroyRoom	Dissolve Room.
enterRoom	Enter the room.
exitRoom	Leave the room.
connectOtherRoom	Connect to Other Rooms.
disconnectOtherRoom	Disconnect from Other Rooms.
fetchRoomInfo	Obtain room information.
updateRoomNameByAdmin	Update Room Name (only administrators or group owners can invoke).
updateRoomSeatModeByAdmin	Set Room Management Mode (only administrators or group owners can invoke).

API	Description
setLocalVideoView	Set control for local user video rendering.
openLocalCamera	Turns the local camera on.
closeLocalCamera	Turns the local camera off.
updateVideoQuality	Update local video encoding quality settings.
updateVideoQualityEx	Set encoding parameters for the video encoder
setVideoResolutionMode	Set the resolution mode for the video encoder
enableGravitySensor	Enable gravity sensing mode
startPushLocalVideo	Start pushing local video.
stopPushLocalVideo	Stop pushing local video.
startScreenSharing	Starting Screen Sharing
stopScreenSharing	End Screen Sharing

API	Description
openLocalMicrophone	Enable the local mic.
closeLocalMicrophone	Disable the local mic.
updateAudioQuality	Update local audio encoding quality settings.
muteLocalAudio	Stop pushing local audio.
unMuteLocalAudio	Start pushing local audio.

API	Description
setRemoteVideoView	Set 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	Obtain the member list inside the room.
getUserInfo	Obtain member information.

API	Description
changeUserRole	Modify User Role (only administrators or group owners can invoke).
changeUserNameCard	Modify User Nickname.
kickRemoteUserOutOfRoom	Remove Remote User from Room (only administrators or group owners can invoke).
addCategoryTagForUsers	Add a label to a user (only homeowners can call)
removeCategoryTagForUsers	Remove a label from a user (only homeowners can call)
getUserListByTag	Get user information in the room based on labels
setCustomInfoForUser	Set customized information for members in the room

API	Description
disableDeviceForAllUserByAdmin	Control whether all users in the current room can enable audio stream, video stream capture devices. For example: prohibit everyone from turning on the microphone, camera, or screen sharing (currently available only in meeting scenarios, and only administrators or group owners can invoke).
openRemoteDeviceByAdmin	Request Remote User to Enable Media Devices (only administrators or group owners can invoke).
closeRemoteDeviceByAdmin	Turn Off Remote User Media Devices (only administrators or group owners can invoke).
applyToAdminToOpenLocalDevice	Request to Enable Local Media Devices (available for regular users).

API	Description
setMaxSeatCount	Set Maximum Number of Microphones (can only be set before entering or creating a room).
getSeatList	Get the microphone position list.
getSeatApplicationList	Host/Administrator gets the request list of users applying for the microphone in the room.
lockSeatByAdmin	Lock Microphone Position (only administrators or group owners can invoke, including position lock, audio status lock, and video status lock).
takeSeat	Apply to join the microphone (no need to apply in free speaking mode).
leaveSeat	Apply to leave the microphone (no need to apply in free speaking mode).
moveToSeat	Disconnect Mic
takeUserOnSeatByAdmin	Host/Administrator invites users to go on stage.
kickUserOffSeatByAdmin	Host/Administrator removes users from the microphone.

API	Description
cancelRequest	Cancel Request.
responseRemoteRequest	Reply Request.

API	Description
disableSendingMessageByAdmin	Disable the remote user's ability to send text messages (only administrators or group owners can call this).
disableSendingMessageForAllUser	Disable all users' ability to send text messages (only administrators or group owners can call this).

API	Description
setBeautyLevel	Set beauty filter effect level
setWhitenessLevel	Set brightening filter effect level
getExtension	Get plugins
getMediaDeviceManager	Get device management class

API	Description
onKickedOffLine	Kicked offline by another client during terminal login.
onUserSigExpired	User credentials timeout event.

API	Description
onRoomNameChanged	Room name change event.
onAllUserMicrophoneDisableChanged	All users' microphones in the room have been disabled event.
onAllUserCameraDisableChanged	All users' cameras in the room have been disabled event.
onScreenShareForAllUserDisableChanged	All users' screen sharing in the room has been disabled event.
onSendMessageForAllUserDisableChanged	All users' ability to send text messages in the room has been disabled event.
onKickedOutOfRoom	Removed from the room event.
onRoomDismissed	Room dissolved event.
onRoomSeatModeChanged	Room Microphone Mode Change
onRoomUserCountChanged	Room population changed

API	Description
onRemoteUserEnterRoom	Remote user entered room event.
onRemoteUserLeaveRoom	Remote user left room event.
onUserRoleChanged	User role changed event.
onUserVideoStateChanged	User video status changed event.
onUserAudioStateChanged	Event of User Audio Status Changed
onUserVoiceVolumeChanged	User volume changed event.
onSendMessageForUserDisableChanged	User text message sending capability changed event.
onUserNetworkQualityChanged	User network status changed event.
onUserScreenCaptureStopped	Screen sharing ended.

API	Description
onRoomMaxSeatCountChanged	Maximum number of microphones in room changed event (only in meeting type rooms).
onSeatListChanged	Microphone position list changed event.
onKickedOffSeat	User removed from microphone event received.

API	Description
onRequestReceived	Request message event received.
onRequestCancelled	Request cancellation event received.
onRequestProcessed	Received request handled by another administrator/homeowner event