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

UI Customization

This article will detail how to customize the TUIRoomkit user interface. TUIRoomkit offers two customization methods: one is through the simple use of Custom UI API, and the other is by replacing existing UI components. We will introduce these methods in detail below.
Scheme 1: Interface Fine-tuning
TUIRoomkit provides a series of API, allowing for easy customization of the UI. The table below lists some of the main APIs and their functions:
API
Description
﻿setLanguage﻿
Set the interface language.
﻿setTheme﻿
Set the interface topic.
﻿enableWatermark﻿
Enable the text messaging feature in the application. For details, see: Text Watermark.
﻿disableTextMessaging﻿
Disable the text messaging feature in the application. After invoking this function, users will not be able to send or receive text messages.
﻿disableScreenSharing﻿
Disable the screen sharing feature in the application. After invoking this function, users will not be able to share their screen with others.
﻿hideFeatureButton﻿
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.
Scheme 2: UIKit Source Code Export and Modification
You can directly modify the UI source code we provide to adjust the TUIRoomKit user interface according to your needs. Execute the following node script to automatically copy the TUIRoomKit interface source code into your project (default path ./src/components/TUIRoom).
Note:
After exporting the source code, you need to manually change the reference of the TUIRoom component from the npm package address to the relative path address of the TUIRoom source code.
Vue3
Vue2
node ./node_modules/@tencentcloud/roomkit-electron-vue3/scripts/eject.js
node ./node_modules/@tencentcloud/roomkit-electron-vue2.7/scripts/eject.js
1. Replace Icons
You can directly modify the icon components in the /TUIRoom/assets/icons/svg  folder, to ensure the icon color and style are consistent throughout the app. Please keep the icon file names unchanged while replacing them.
﻿
﻿
﻿
2. Adjust UI Layout
You can adjust the UI layout of the multi-person video conference interface by modifying different components in the /TUIRoom/components/ folder
- components/    
    - Chat                Chat
    - common              Public Icon Components
    - ManageMember        Member Management
    - RoomContent         Room Video
    - RoomFooter          Room Page Footer
    - RoomHeader          Room Page Header
    - RoomHome            Home Page
    - RoomInvite          Invite Members
    - RoomLogin           Login Page
    - RoomMore            More
    - RoomSetting         Settings
    - RoomSidebar        Drawer Components
Solution 3: Implement Your Own UI
The overall feature of TUIRoomKit is based on the TUIRoomEngine, a UI-less SDK. You can fully implement your own UI interface based on TUIRoomEngine. For more details, see:
﻿TUIRoomEngine Integration Guide﻿
﻿TUIRoomEngine API Address﻿

Scheme 1: Interface Fine-tuning
Scheme 2: UIKit Source Code Export and Modification
- 1. Replace Icons
- 2. Adjust UI Layout
Solution 3: Implement Your Own UI

API	Description
setLanguage	Set the interface language.
setTheme	Set the interface topic.
enableWatermark	Enable the text messaging feature in the application. For details, see: Text Watermark.
disableTextMessaging	Disable the text messaging feature in the application. After invoking this function, users will not be able to send or receive text messages.
disableScreenSharing	Disable the screen sharing feature in the application. After invoking this function, users will not be able to share their screen with others.
hideFeatureButton	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.