tencent cloud

Log In Sign Up Free

Detect AI Fraud with Tencent eKYC！Intercept 99%+ Deepfake Attacks!

Tencent Real-Time Communication

Release Notes and Announcements

TRTC Live (TUILiveKit) Product Launch Announcement

TRTC Conference Official Editions Launched

The commercial version of Conference is coming soon

Terms and Conditions Applicable to $9.9 Starter Package

Rules for the "First Subscription $100 Discount" Promotion

Announcement on the Start of Beta Testing for Multi-person Audio and Video Conference

TRTC Call Official Editions Launched

License Required for Video Playback in New Version of LiteAV SDK

TRTC to Offer Monthly Packages

Product Introduction

Performance Statistics

Tencent RTC Quickplay: Experience Ultimate Real-Time Audio and Video Interaction!

Purchase Guide

Billing Overview

Monthly subscription

Monthly Packages

Call Monthly Packages

Conference Monthly Packages

Live Monthly Packages

RTC-Engine Monthly Packages

RTC Analytics Monthly Packages

Billing Explanation for Subscription Package Duration

Pay-as-you-go

Billing of Speech-To-Text

Billing of Conversational AI Services

Billing of Audio and Video Duration

Billing of On-Cloud Recording and Recording Delivery

Billing of MixTranscoding and Relay to CDN

Video Screenshot Upload

TRTC Overdue and Suspension Policy

Refund Instructions

TRTC Monthly Package Refund Instructions

Video Calling (Including UI)

Overview (TUICallKit)

Activate the Service（TUICallKit）

Run Demo（TUICallKit）

Integration (TUICallKit)

uniapp（Android&iOS）

Calls integration to Chat (TUICallKit)

UI Customization (TUICallKit)

Offline Call Push (TUICallKit)

iOS

Flutter

VoIP (Optional)

AI Noise Reduction (TUICallKit)

Virtual Background (TUICallKit)

Conversational Chat（TUICallKit）

On-Cloud Recording (TUICallKit)

Additional Features（TUICallKit）

Configuring Nicknames and Avatars (All Platform)

Configure Resolution and Fill Mode (Web)

USB Camera Capture

Volume Increment

Multi-Person Call

Android&iOS&Flutter

uni-app (Anroid&iOS)

Floating Window

Android&iOS&Flutter

uni-app (Anroid&iOS)

Beauty Effects

Custom Ringtone

uni-app (Anroid&iOS)

Monitoring Call Status

Android&iOS&Flutter

uni-app（Android & iOS）

Language Settings

uni-app（Android&iOS）

Solution (TUICallKit)

Server APIs (TUICallKit)

REST API

REST API Introduction

Call Records

Get Records by CallId

Retrieve Records by Conditions

Get Real-Time Call Status

Third-Party Callback

Third-Party Callback Overview

Callback Command List

Callback Configuration

Query Callback Configuration

Setting Callback Configuration

Deleting Callback Configuration

Call Status Callback

Callback after Call Initiation

Callback after Call Ends

Legacy Documentation

Call Status Callback

Call Status Callback

Call Event Callback

Callback Configuration

API List for Callback Configuration

Establishing Callback Configuration

Retrieving Callback Configuration

Update Callback Configuration

Remove Callback Configuration

REST API

Call Records

Introduction to REST API

Retrieve records via callId

Retrieve Records Based on Conditions

Client APIs (TUICallKit)

ErrorCode(TUICallKit)

Release Notes (TUICallKit)

FAQs(TUICallKit)

Multi-Participant Conference (with UI)

Overview（TUIRoomKit）

Activate the Service (TUIRoomKit)

Run Demo（TUIRoomKit）

Web&H5（Vue3/Vue2）

Integration（TUIRoomKit）

Web&H5（Vue2/Vue3）

Screen Sharing (TUIRoomKit)

Android&iOS&Flutter

Schedule a meeting (TUIRoomKit)

Android&iOS&Flutter

In-meeting Call (TUIRoomKit)

UI Customization（TUIRoomKit）

Virtual Background (TUIRoomKit)

Conference Control (TUIRoomKit)

Android&iOS&Flutter

Cloud Recording (TUIRoomKit)

AI Noise Reduction (TUIRoomKit)

In-Conference Chat (TUIRoomKit)

Robot Streaming (TUIRoomKit)

Enhanced Features (TUIRoomKit)

Basic Beauty（Web）

AI Real-Time Subtitles

Room Password (All Platforms)

Bullet Screen Chat (Android & IOS & Flutter)

Offline Wake-Up

Meeting Reminder (Android & iOS)

In-Meeting Call Reminder (Android & iOS)

Floating Window

Text Watermark

Setting Nickname, Avatar (All Platform)

Monitor Conference Status

Client APIs (TUIRoomKit)

iOS&Mac

RoomEngine API

TUIRoomObserver

TUIRoomDeviceManager

TUICommonDefine

TUIConferenceListManager

TUIConferenceInvitationManager

Android

RoomEngine API

TUIRoomObserver

TUIRoomDeviceManager

TUICommonDefine

TUIConferenceListManager

TUIConferenceInvitationManager

Web

RoomEngine API

TUIRoomEngine Defines

Electron

RoomEngine API

TUIRoomEngine Defines

Flutter

RoomEngine API

TUIRoomObserver

Type Definition

Server APIs (TUIRoomKit)

REST API

RESTful API Overview

RESTful API List

Room Management

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

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

FAQs (TUIRoomKit)

Error Code (TUIRoomKit)

SDK Update Log (TUIRoomKit)

Live Streaming (Including UI)

Billing of Video Live Component

Overview (TUILiveKit)

Activating the Service (TUILiveKit)

Run Demo（TUILiveKit）

Integration (TUILiveKit)

Customizable Interface (TUILiveKit)

Start Broadcasting and Watch (TUILiveKit)

Room List (TUILiveKit)

Follow Anchors (TUILiveKit)

Anchor Connection (TUILiveKit)

Host Competition (TUILiveKit)

Mic Connect (TUILiveKit)

Ultimate Image Quality (TUILiveKit)

Interactive Bullet Comments (TUILiveKit)

Interactive Gifts (TUILiveKit)

Gift Effects (TUILiveKit)

Beauty Effects (TUILiveKit)

Floating Window (TUILiveKit)

Client APIs (TUILiveKit)

Android

UIKit API

Engine API

SDK Introduction

SDK Integration

Login and Logout SDK

TUIRoomObserver

TUIRoomDeviceManager

TUILiveListManager

TUILiveConnectionManager

TUILiveBattleManager

TUILiveLayoutManager

TUICommonDefine

iOS

UIKit API

Engine API

SDK Introduction

SDK Integration

Login and Logout SDK

TUIRoomObserver

TUIRoomDeviceManager

TUILiveListManager

TUILiveConnectionManager

TUILiveBattleManager

TUILiveLayoutManager

TUICommonDefine

Web

Electron

Engine API

TUIRoomEngine Defines

TUIDeviceManager

TUIAudioEffectManager

TUIMediaMixingManager

TUIVideoEffectPluginManager

Flutter

Engine API

TUIRoomEngineObserver

TUIRoomDeviceManager

TUILiveListManager

API-Example

Video Live（LiveStreamCore）

Integration and Login

Anchor Connection

Custom Video Layout

Custom Co-Hosting and Connection View

RTCRoomEngine

Basic Features

Audio Broadcasting and Listening

Live Streaming and Watching

Anchor Connection

Advanced Features

Background Music

Audio Effect Settings

Beauty Settings

Setting Live Room Information

Server APIs (TUILiveKit)

REST API

Third-Party Callback

Callback Overview

Callback Command List

Callback Configuration

Query Callback Configuration

Update Callback Configuration

Create Callback Configuration

Delete Callback Configuration

Room Related

After a Room Is Created

After a Room Is Destroyed

Callback After a Room Is Updated

User Related

Callback for Room Member Status Change

Seat Connection Related

After the Seat List Is Changed

Battle Related

Callback After Creating Battle

Callback After Starting Battle

Callback After Ending Battle

Error Codes (TUILiveKit)

Release Notes（TUILiveKit）

FAQs（TUILiveKit）

Voice Chat Room (with UI)

Overview (TUILiveKit)

Activating the Service (TUILiveKit)

Run Demo（TUILiveKit）

Integration (TUILiveKit)

Customizable Interface (TUILiveKit)

Live Streaming and Listening (TUILiveKi

Microphone Management (TUILiveKit)

Room List (TUILiveKit)

Follow Anchors (TUILiveKit)

Interactive Bullet Comments (TUILiveKit)

Interactive Gifts (TUILiveKit)

Gift Effects (TUILiveKit)

Client APIs (TUICallKit)

iOS

UIKit API

Engine API

TUIRoomObserver

TUIRoomDeviceManager

TUILiveListManager

TUILiveConnectionManager

TUICommonDefine

Android

UIKit API

Engine API

TUIRoomObserver

TUIRoomDeviceManager

TUILiveListManager

TUILiveConnectionManager

TUICommonDefine

API-Example

Voice Room（SeatGridView）

Integration and Login

Seat Management

Microphone Management

Customizing a Seat

Server APIs (TUILiveKit)

REST API

RESTful API Overview

RESTful API List

Room Related

Update the Room Information

Get the Room Information

Retrieve the Live Streaming List

User-Related Matters

Member Banishment

Retrieve the Ban List

Retrieve the List of Administrators

Lifting a Member's Ban

Modify Administrator

Error Codes (TUILiveKit)

Release Notes（TUILiveKit）

FAQs（TUILiveKit）

Integration (No UI)

SDK Download

Release Notes (App)

Release Notes (Electron)

Release Notes (Web)

Release Notes (Flutter)

API Examples

API Usage Guidelines

SDK Quick Start

01. Importing the SDK

02. Entering a Room

Android, iOS, Windows, and macOS

03. Subscribing to Audio/Video Streams

Android, iOS, Windows, and macOS

04. Publishing Audio/Video Streams

Android, iOS, Windows, and macOS

05. Exiting a Room

Android, iOS, Windows, and macOS

06. Advanced Guide

Sensing Network Quality

Android, iOS, Windows, and macOS

Enabling Screen Sharing

Sharing Computer Audio

Setting Video Quality

Android&iOS&Windows&Mac

Rotating Videos

Android, iOS, Windows, and macOS

07.FAQs

FAQs for Beginners

API Reference Manual

Advanced Features

Enabling Advanced Permission Control

Push Media Stream into TRTC

Testing Hardware Devices

Android&iOS&Windows&Mac

Testing Network Quality

Android&iOS&Windows&Mac

On-Cloud Recording

Custom Capturing and Rendering

Android, iOS, Windows, and macOS

Custom Audio Capturing and Playback

Android, iOS, Windows, and macOS

Sending and Receiving Messages

Event Callbacks

Event Callbacks

Relay to CDN Callback

Cloud Recording Callback

Push Online Media Stream Callback

Conversational AI & Speech-to-Text Callbacks

Verify Signature Example

Access Management

Manageable Resources and Actions

Preset Policies

Custom Policies

Enable Watermark

How to push stream to TRTC room with OBS WHIP

Video Screenshot Upload

Server APIs

Room Management APIs

SetUserBlockedByStrRoomId

RemoveUserByStrRoomId

DismissRoomByStrRoomId

Stream mixing and relay APIs

StartPublishCdnStream

UpdatePublishCdnStream

StopPublishCdnStream

Data Monitoring APIs

DescribeTRTCRealTimeScaleData

DescribeTRTCRealTimeQualityData

DescribeTRTCMarketScaleData

DescribeTRTCMarketQualityData

Pull stream Relay Related interface

DescribeStreamIngest

StopStreamIngest

StartStreamIngest

UpdateStreamIngest

AI Transcription APIs

StartAIConversation

DescribeAIConversation

StopAIConversation

StartAITranscription

DescribeAITranscription

StopAITranscription

UpdateAIConversation

ControlAIConversation

Making API Requests

Request Structure

Call Quality Monitoring APIs

DescribeRoomInfo

DescribeUserEvent

DescribeCallDetailInfo

DescribeUserInfo

DescribeScaleInfo

On-cloud recording APIs

CreateCloudRecording

DescribeCloudRecording

ModifyCloudRecording

DeleteCloudRecording

Usage Statistics APIs

DescribeTrtcUsage

DescribeRecordingUsage

DescribeMixTranscodingUsage

DescribeRelayUsage

DescribeTrtcRoomUsage

Appendix

Event ID Mapping Table

Console Guide

Application Management

Creating Application

Function Configuration

Callback Configuration

Package Management

Usage Statistics

Interactive Audio/Video

On-Cloud Recording

On-Cloud MixTranscoding

Monitoring Dashboard

Call Data

End-to-End Details

Real-Time Monitoring

Development Assistance

UserSig Generation and Verification

RTMP Address Generator

Selection of Service region

Solution

Real-Time Chorus

Quick Integration (TUIKaraoke)

Solution Overview (TUIKaraoke)

Implementation Steps

Song Synchronization

Lyric Synchronization

Vocal Synchronization

Mixing Stream Solution

TUIKaraoke APIs

TRTCKaraoke (iOS)

TRTCKaraoke (Android)

FAQs

FAQs

Migration Guide

Twilio Video to TRTC

Firewall Restrictions

How to Downsize Installation Package

Android and iOS

TRTCCalling for Web

Audio and Video Quality

Legacy Documentation

Integrating TUIRoom (Web)

Integrating TUIRoom (Android)

Integrating TUIRoom (iOS)

Integrating TUIRoom (Flutter)

Integrating TUIRoom (Windows and macOS)

Integrating TUIRoom (Electron)

TUIRoom APIs

TUIRoom (Android)

TRTCMeeting API (Flutter)

TUIRoom (Windows and macOS)

On-Cloud Recording and Playback (Old)

Protocols and Policies

Security White Paper

Notes on Information Security

Service Level Agreement

Apple Privacy Policy: PrivacyInfo.xcprivacy

TRTC Policy

Data Processing And Security Agreement

DocumentationTencent Real-Time CommunicationMulti-Participant Conference (with UI)FAQs (TUIRoomKit)Android

Android

Last updated: 2023-10-30 11:06:45

Android

Last updated: 2023-10-30 11:06:45

What are the requirements for TUIRoomKit's dependencies on TRTC and IM SDK?
TUIRoomEngine will perform version verification when logging in, prompting you to use the correct TRTC SDK and IM SDK Version.
﻿
﻿
﻿
Can TUIRoomKit remove the dependency on IM SDK?
No, Real-time Conference SDK requires IM for signaling-related communication, including mic control, bullet screen, and other functions, so it needs to have a dependency on IM SDK.
Does TUIRoomKit support features like conference scheduling?
It is not supported yet, this feature is in planning, you can follow our update log to get the latest information on the launch status of this feature.
After integrating TUIRoomKit, how can I quickly modify the user name and user avatar?
You can set it by calling the setSelfInfo interface of TUIRoomKit.
﻿

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

No

Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support

Hong Kong, China

+852 800 906 020 (Toll Free)

United States

+1 844 606 0804 (Toll Free)

United Kingdom

+44 808 196 4551 (Toll Free)

Canada

+1 888 605 7930 (Toll Free)

Australia

+61 1300 986 386 (Toll Free)

EdgeOne hotline

+852 300 80699

More local hotlines coming soon