Conference

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

FAQs

Environment-related Issues
What platforms does TUIRoomKit Web support?
Please refer to TRTC Web SDK's browser support for TUIRoomEngine Web supported platforms.
For environments not listed above, you can open the TRTC Capability Test in your current browser to test if it fully supports WebRTC features.
Why can TUIRoomKit be used normally in local development testing, but not when deployed online?
Considering user safety and privacy issues, browsers restrict web pages to only capture mic and Camera in secure environments (such as https, localhost, file:// protocols). HTTP protocol is insecure, and browsers will prohibit media device capturing under HTTP protocol.
If everything works fine in your local development testing, but you cannot capture Camera and mic after deploying the page, please check if your web page is deployed on HTTP protocol. If so, please use HTTPS to deploy your web page and ensure a qualified HTTPS security certificate.
For more details, please refer to the URL domain and protocol restrictions description.
TDoes TUIRoomKit Web support integration with iframe?
Yes, it does. To integrate TUIRoom Web in an iframe, you need to add attributes to the iframe tag to enable related permissions, as shown below.
// Enable mic, Camera, Screen Sharing, and full-screen permissions
<iframe allow="microphone; camera; display-capture; display; fullscreen;">
Compilation-related Issues
Webpack 5 importing TUIRoomEngine SDK error: webpack < 5 used to include polyfills for node.js core modules by default. This is no longer the case. Verify if you need this module and configure a polyfill for it.
The error is caused by the removal of the automatic inclusion of nodejs core module polyfills in webpack5. You can add configureWebpack configuration in vue.config.js to solve this problem.
module.exports = defineConfig({
  // ...
  configureWebpack: (config) => {
    config.resolve.fallback = {
      ...config.resolve.fallback,
      url: false,
      path: false,
      fs: false,
      crypto: false,
    };
  }
});
Function-related Issues
Can tim-js-sdk and @tencentcloud/tuiroom-engine-js be introduced in the project at the same time?
Yes, they can. You can create a tim instance object through TIM in tim-js-sdk and pass it to the init interface when initializing TUIRoomEngine.
await TUIRoomEngine.init({
 sdkAppId: 0,   // Fill in your applied sdkAppId
 userId: '',    // Fill in your business-related userId
 userSig: '',   // Fill in the userSig calculated by the server or locally
 tim,    // Pass in the tim instance
});
Also, you can get the tim instance used internally by TUIRoomEngine through the roomEngine.getTIM method.

Environment-related Issues
Compilation-related Issues
- Webpack 5 importing TUIRoomEngine SDK error: webpack < 5 used to include polyfills for node.js core modules by default. This is no longer the case. Verify if you need this module and configure a polyfill for it.
Function-related Issues