please select
Conference
  • Overview
  • Web
    • Run Sample Demo
    • Integration
    • UI Customization
    • Conference Control
    • In-Conference Chat
    • On-Cloud Recording
    • AI Noise Suppression
    • Robot Streaming
    • Virtual Background
    • More Features
      • Floating Window
      • Text Watermark
    • API Documentation
      • RoomKit API
      • RoomEngine API
        • API Overview
        • TUIRoomEngine
        • TUIRoomEvents
        • TUIRoomEngine Defines
    • FAQs
  • iOS
    • Run Sample Demo
    • Integration
    • UI Customization
    • Conference Control
    • In-Conference Chat
    • On-Cloud Recording
    • AI Noise Suppression
    • Robot Streaming
    • More Features
      • Floating Window
    • API Documentation
      • RoomKit API
      • RoomEngine API
        • API Overview
        • TUIRoomEngine
        • TUIRoomObserver
        • Type Definition
    • FAQs
  • Android
    • Run Sample Demo
    • Integration
    • UI Customization
    • Conference Control
    • In-Conference Chat
    • On-Cloud Recording
    • AI Noise Suppression
    • Robot Streaming
    • More Features
      • Floating Window
    • API Documentation
      • RoomKit API
      • RoomEngine API
        • API Overview
        • TUIRoomEngine
        • TUIRoomObserver
        • Type Definition
    • FAQs
  • Electron
    • Run Sample Demo
    • Integration
    • UI Customization
    • Conference Control
    • In-Conference Chat
    • On-Cloud Recording
    • AI Noise Suppression
    • Robot Streaming
    • More Features
      • Floating Window
      • Text Watermark
    • API Documentation
      • RoomKit API
      • RoomEngine API
        • API Overview
        • TUIRoomEvent
        • TUIRoomEngine
        • TUIRoomEngine Defines
    • FAQs
  • Flutter
    • Run Sample Demo
    • Integration
    • UI Customization
    • Conference Control
    • In-Conference Chat
    • On-Cloud Recording
    • AI Noise Suppression
    • Robot Streaming
    • More Features
      • Floating Window
    • API Documentation
      • RoomKit API
      • RoomEngine API
        • API Overview
        • TUIRoomEngine
        • TUIRoomObserver
        • Type Definition
    • FAQs
  • Overview
    • Overview
  • Activate the Service
  • Pricing
    • Free Minutes
    • Conference Monthly Packages
    • Billing Explanation for Subscription Package Duration
    • Pay-as-you-go
      • Billing of Audio and Video Duration
      • Billing of On-Cloud Recording and Recording Delivery
      • Billing of MixTranscoding and Relay to CDN
  • Server APIs
    • REST API
      • RESTful API Overview
      • RESTful API List
      • Room Management
        • Create a Room
        • Destroy a Room
        • Update the Room Information
        • Get the Room Information
      • User Management
        • Get the Room Member List
        • Update the Room Member Information
        • Change the Room Ownership
        • Mark Room Members
        • Ban Room Members
        • Unban Room Members
        • Get the Banned Room Member List
        • Remove Room Member
      • Seat Management
        • Get the Seat List
        • Pick User on the Seat
        • Kick User off the Seat
        • Lock the Seat
    • Third-Party Callback
      • Callback Overview
      • Callback Command List
      • Callback Configuration
        • Query Callback Configuration
        • Create Callback Configuration
        • Update Callback Configuration
        • Delete Callback Configuration
      • Room Related
        • After a Room Is Created
        • After a Room Is Destroyed
        • After the Room Information Is Updated
      • User Related
        • After a Room Is Entered
        • After a Room Is Left
      • Seat Connection Related
        • After the Seat List Is Changed
  • Error Code
Conference
Docs Overview/
Conference/
Web/
API Documentation/
RoomEngine API/
API Overview/

API Overview

TUIRoomKit (UI included Component)

TUIRoomKit API List

API
Description
Get the roomEngine instance. If the roomEngine does not exist, return null.
on
Listen for events of a specified type. When the event occurs, the callback function will be called.
off
Stop listening for events of a specified type.
login
Log in to the conference system.
logout
Log out of the meeting system.
start
Start a new meeting.
join
Join an existing meeting.
leave
Leave the current meeting.
dismiss
Dismiss the current meeting.
Set your user information.
Set the interface language.
setTheme
Set the interface topic.
Disable the text messaging feature in the application. After invoking this function, users will not be able to send or receive text messages.
Disable the screen sharing feature in the application. After invoking this function, users will not be able to share their screen with others.
Hide specific feature buttons in the application. By invoking this function and passing in the appropriate FeatureButton enumerated values, the corresponding buttons will be hidden from the user interface.

TUIRoomEngine (No UI interface)

TUIRoomEngine API List

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
Set the current user's basic information (username, user avatar)
Get the current user's basic information (username, user avatar)
logout
Logout from TUIRoomEngine
RoomEngine Room Management API
API
Description
Create room
enterRoom
Entered room
Close the room
exitRoom
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
roomEngine Audio Video API
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 screen sharing
End screen sharing
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
roomEngine Member Management API
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
roomEngine Microphone Management API
API
Description
Set room microphone position maximum value
Get microphone position information
takeSeat
Get microphone position
leaveSeat
Release microphone position
Invite others to go live (only room host and administrator can call this method)
Kick others off the microphone position (only room host and administrator can call this method)
Lock a microphone position status (only room host and administrator can call this method)
roomEngine Message Sending API
API
Description
Send text message
Send custom message
roomEngine Device Management API
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
roomEngine Event Listening API
API
Description
on
Listen to TUIRoomEvents event
off
Cancel listening to TUIRoomEvents event
roomEngine Other API
API
Description
Get trtcCloud instance
getTIM
Get tim instance

TUIRoomEngine Event Type

TUIRoomEvent is the Callback Event class corresponding to TUIRoomEngine. You can listen to the Callback Events you are interested in through this callback.
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.