Join Tencent RTC at NAB Show 2024 in Las Vegas!
Learn more 
Only  $9.9! Get 50,000 minutes with our Starter Plan, perfect for your MVP project.
Only $9.9! Get 50,000 minutes with our Starter Plan, perfect for your MVP project.
Grab It Now 
Join Tencent RTC at NAB Show 2024 in Las Vegas!
Learn more 
Only  $9.9! Get 50,000 minutes with our Starter Plan, perfect for your MVP project.
Only $9.9! Get 50,000 minutes with our Starter Plan, perfect for your MVP project.
Grab It Now 
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
  • Activate the Service
  • Pricing
    • TRTC Conference Monthly Packages
    • Pay-As-You-Go
    • Free Minutes
  • Error Code
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
Create Instance of TUIRoomEngine
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
Set local user name and avatar
Get local user basic information
Set event callback
Remove event callback

Room Related Active Interface

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

Local User View Rendering, Video Management

API
Description
Set the view control for local user video rendering
Open local camera
Close local camera
Update local video codec quality settings
Start screen sharing
End screen sharing
Enumerate shareable screens and windows
Select the screen or window to share
Start pushing local video
Stop pushing local video

Local User Audio Management

API
Description
Open local microphone
Close local microphone
Update local audio codec quality settings
Start pushing local audio
Stop pushing local audio

Remote User View Rendering, Video Management

API
Description
Set the view control for remote user video rendering
Start playing remote user video
Stop playing remote user video
Mute remote user

Room User Information

API
Description
Get the member list in the room
Get member information

Room User Management

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

Speech Management in Room

API
Description
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).
Request Remote User to Open Media Device (Only Administrator or Group Owner can call)
Close Remote User's Media Device (Only Administrator or Group Owner can call)
Request to Open Local Media Device (Available for Ordinary Users)

Microphone Seat Management in Room

API
Description
Set Maximum Number of Microphone Seats (Only supported when entering the room and creating the room)
Get Microphone Seat List
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)
Host/Administrator invites user to go live
Host/Administrator kicks user off the microphone seat

Send Message

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

Signaling Management

API
Description
Cancel Request
Reply to Request

Advanced Feature: Get TRTC Instance

API
Description
Get TRTC Instance Object
Get Device Management Object
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
User Kicked Offline Event
User Credential Timeout Event

Room Event Callback

API
Description
Room Name Change Event
All Users' Microphones Disabled in Room Event
All Users' Cameras Disabled in Room Event
All Users' Text Message Sending Disabled in Room Event
Kicked Out of Room Event
Room Dismissed Event
Room Microphone Control Mode Change

Room User Event Callback

API
Description
Remote User Entering Room Event
Remote User Leaving Room Event
User Role Change Event
User Video State Change Event
User Audio State Change Event
User Volume Change Event
User Text Message Sending Ability Change Event
User Network Status Change Event
Screen Sharing End Event

Room Microphone Seat Event Callback

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

Request Signaling Event Callback

API
Description
Received Request Message Event
Received Request Cancellation Event

Room Message Event Callback

API
Description
Received Normal Text Message Event
Received Custom Message Event