tencent cloud

Tencent Real-Time Communication

Release Notes and Announcements
Release Notes
Recent Product Announcement
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
Overview
Concepts
Features
Strengths
Use Cases
Performance Statistics
Tencent RTC Quickplay: Experience Ultimate Real-Time Audio and Video Interaction!
Purchase Guide
Billing Overview
Free Minutes
Monthly subscription
Pay-as-you-go
TRTC Overdue and Suspension Policy
FAQs
Refund Instructions
User Tutorial
Free Demo
Call
Overview
Activate the Service
Run Demo
Integration
Offline Call Push
Conversational Chat
On-Cloud Recording
AI Noise Reduction
UI Customization
Calls integration to Chat
Additional Features
No UI Integration
Server APIs
Client APIs
Solution
ErrorCode
Release Notes
FAQs
Conference
Overview（TUIRoomKit）
Activate the Service (TUIRoomKit)
Run Demo（TUIRoomKit）
Integration（TUIRoomKit）
Screen Sharing (TUIRoomKit)
Schedule a meeting (TUIRoomKit)
In-meeting Call (TUIRoomKit)
UI Customization（TUIRoomKit）
Virtual Background (TUIRoomKit)
Conference Control (TUIRoomKit)
Cloud Recording (TUIRoomKit)
AI Noise Reduction (TUIRoomKit)
In-Conference Chat (TUIRoomKit)
Robot Streaming (TUIRoomKit)
Enhanced Features (TUIRoomKit)
Client APIs (TUIRoomKit)
Server APIs (TUIRoomKit)
FAQs (TUIRoomKit)
Error Code (TUIRoomKit)
SDK Update Log (TUIRoomKit)
Live
Billing of Video Live Component
Overview
Activating the Service (TUILiveKit)
Run Demo
No UI Integration
UI Customization
Live Broadcast Monitoring
Video Live Streaming
Voice Chat Room
Advanced Features
Client APIs
Server APIs
Error Codes
Release Notes
FAQs
RTC Engine
Activate Service
SDK Download
API Examples
Usage Guidelines
API Reference Manual
Advanced Features
AI Integration
Overview
Configure MCP Server
Install Skills
Integration Guide
FAQ
RTC RESTFUL API
History
Introduction
API Category
Room Management APIs
Stream mixing and relay APIs
On-cloud recording APIs
Data Monitoring APIs
Pull stream Relay Related interface
Web Record APIs
AI Service APIs
Cloud Slicing APIs
Cloud Moderation APIs
Making API Requests
Call Quality Monitoring APIs
Usage Statistics APIs
Data Types
Appendix
Error Codes
Console Guide
Application Management
Package Management
Usage Statistics
Monitoring Dashboard
Development Assistance
Solution
Real-Time Chorus
FAQs
Migration Guide
Billing
Features
UserSig
Firewall Restrictions
How to Downsize Installation Package
Android and iOS
Web
Flutter
Electron
TRTCCalling for Web
Audio and Video Quality
Others
Legacy Documentation
RTC RoomEngine SDK（Old）
Integrating TUIRoom (Web)
Integrating TUIRoom (Android)
Integrating TUIRoom (iOS)
Integrating TUIRoom (Flutter)
Integrating TUIRoom (Electron)
TUIRoom APIs
On-Cloud Recording and Playback (Old)
RTC Analytics Monthly Packages (Previous Version)
Protocols and Policies
Compliance
Security White Paper
Notes on Information Security
Service Level Agreement
Apple Privacy Policy: PrivacyInfo.xcprivacy
TRTC Policy
Privacy Policy
Data Processing And Security Agreement
Glossary
DocumentationTencent Real-Time CommunicationRTC EngineAPI Reference ManualReact NativeOverview

Overview

PDF
Focus Mode
Font Size
Last updated: 2025-04-16 17:31:47

TRTCCloud

Basic APIs

API
Description
Creates a TRTCCloud singleton.
Terminates a TRTCCloud singleton.
Registers a listener.
Unregisters a listener.

Room APIs

API
Description
Enters a room. If the room does not exist, the system will create one.
Leaves a room.
Switches roles. This API works only in live streaming scenarios (TRTC_APP_SCENE_LIVE and TRTC_APP_SCENE_VOICE_CHATROOM).
Sets the audio/video data receiving mode, which must be set before room entry to take effect.
Requests a cross-room call (anchor competition).
Exits a cross-room call.
Switches rooms.

CDN APIs

API
Description
Starts publishing to Tencent Cloud’s live streaming CDN.
Stops publishing to Tencent Cloud’s live streaming CDN.
Starts relaying to the live streaming CDN of a non-Tencent Cloud vendor.
Stops relaying to non-Tencent Cloud addresses.
Sets On-Cloud MixTranscoding parameters.

Video APIs

API
Description
Pauses/Resumes publishing local video data.
Starts playing the video of a remote user.
Stops playing and pulling the video of a remote user.
Pauses/Resumes receiving the video of a remote user.
Pauses/Resumes receiving the videos of all remote users.
Sets video encoder parameters.
Sets video preference.
Sets the rotation of encoded video images, i.e., images presented to remote users and recorded by the server.
Sets the mirror mode of encoded images.
Sets the adaptation mode of the G-sensor.
Sets the image to display when local video publishing is paused.

Audio APIs

API
Description
Enables local audio capturing and publishing.
Disables local audio capturing and publishing.
Mutes/Unmutes the local user.
Sets the audio route.
Mutes/Unmutes a remote user.
Mutes/Unmutes all remote users.
Sets the SDK capturing volume.
Gets the SDK capturing volume.
Sets the SDK playback volume.
Gets the SDK playback volume.
Enables the volume reminder.
Starts audio recording.
Stops audio recording.

Device management APIs

API
Description
Gets the device manager. For API details, see the document on device management.

Beauty filter APIs

API
Description
Gets the beauty filter manager. For API details, see the document on beauty filter management.
Adds a watermark.

Music and audio effect APIs

API
Description
Gets the audio effect manager TXAudioEffectManager, which is used to manage background music, short audio effects, and voice changing effects. For API details, see the document on audio effect management.

Network testing APIs

API
Description
Starts network speed testing, which should be avoided during video calls to ensure call quality.
Stops server speed testing.

Log APIs

API
Description
Gets the SDK version.
Sets the log output level.
Changes the path to save logs.
Enables/Disables local log compression.
Enables/Disables console log printing.

TRTCCloudListener

TRTC callback APIs

Error and warning event callback APIs

API
Description
Error callback. This indicates that the SDK encountered an unrecoverable error. Such errors must be listened for, and UI reminders should be sent to users if necessary.
Warning callback. This callback alerts you to non-serious problems such as stutter or recoverable decoding failure.

Room event callback APIs

API
Description
Callback for room entry
Callback for room exit
Callback for role switching
Callback of the result of requesting a cross-room call (anchor competition)
Callback of the result of ending a cross-room call (anchor competition)
Callback of the result of room switching (switchRoom)

User event callback APIs

API
Description
Callback for the entry of a remote user
Callback for the exit of a remote user
Callback of whether a remote user has a playable primary image (usually the image of the camera)
Callback of whether a remote user has a playable substream image (usually the screen sharing image)
Callback of whether a remote user has playable audio data
Callback for rendering the first video frame of the local user or a remote user
Callback for playing the first audio frame of a remote user. No notifications are sent for local audio.
Callback for sending the first local video frame
Callback for sending the first local audio frame

Callback APIs for background music playback

Callback APIs for background music playback
API
Description
Callback for starting music
Callback of the music playback progress
Callback for ending music

Callback APIs for statistics on network quality and technical metrics

API
Description
Callback of network quality. This callback is triggered every 2 seconds to collect statistics on the quality of current upstream and downstream data transfer.
Callback of statistics on technical metrics

Server event callback APIs

API
Description
Callback for the disconnection of the SDK from the server
Callback for the SDK trying to reconnect to the server
Callback for the reconnection of the SDK to the server
Callback of server speed test results. The SDK tests the speed of multiple server addresses, and the result of each test is returned through this callback.

Hardware event callback APIs

API
Description
Callback for the camera being ready
Callback for the mic being ready
Callback of volume, including the volume of each userId and the total remote volume

Callback APIs for CDN relayed push

API
Description
Callback for starting publishing to Tencent Cloud’s live streaming CDN. This callback is triggered by the startPublishing() API in TRTCCloud.
Callback for stopping publishing to Tencent Cloud’s live streaming CDN. This callback is triggered by the stopPublishing() API in TRTCCloud.
Callback for starting relayed push to CDNs
Callback for stopping relayed push to CDNs
Callback for setting On-Cloud MixTranscoding parameters. This callback is triggered by the setMixTranscodingConfig() API in TRTCCloud.

Definitions of Key Types

Class
Description
Variables of key type definitions
Room entry parameters
Room switching parameters
Video encoding parameters
QoS control parameters
Remote video parameters
Position of the image of each channel in On-Cloud MixTranscoding
On-Cloud MixTranscoding configuration
Voice changing effects (little girl, middle-aged man, metal, punk, etc.)
Reverb effects (karaoke, room, hall, low and deep, resonant, etc.)
Parameters for music and audio effect setting APIs
Audio recording parameters
CDN relaying parameters
Previous Topic: Error CodesNext Topic: Error Codes

Help and Support

Was this page helpful?

Help us improve! Rate your documentation experience in 5 mins.

Feedback