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 CommunicationCallClient APIsWebAPI Overview

API Overview

PDF
Focus Mode
Font Size
Last updated: 2025-12-30 16:11:48

TUICallKit (Includes UI Components)

TUICallKit is an audio and video call component that includes a UI component. You can quickly implement a WhatsApp-like audio and video calling scenario with this component.
API
Description
init
Initialize TUICallKit.
calls
Initiate a one-to-one or multi-person call.
join
Proactively join a call.
Customize user's ringtone.
Set your own nickname and avatar.
Turn on/off ringtone.
Turn on/off the floating window function.
Turn on/off the blurred background function button.
Set the call language for the TUICallKit component.
Hidden Button.
Set the background image for the local user's call interface.
Set the background image for the remote user's call interface.
Set the call interface layout mode.
Set whether the camera is opened by default.
destroyed
Destroy TUICallKit.
Get TUICallEngine instance.

TUICallEngine (No UI)

TUICallEngine API is an audio and video call component that offers a No UI interface. You can use this set of APIs to custom encapsulate according to your business needs.
API
Description
Creating a TUICallEngine Instance (Singleton Pattern)
Terminating a TUICallEngine Instance (Singleton Pattern)
on
Listening on events
off
Canceling Event Listening
login
Sign in Interface
logout
Logout Interface
Configure the user's nickname and profile photo
calls
Initiate a one-on-one call
join
Proactively join a call.
accept
Answer Calls
reject
Decline Call
hangup
End Calls
Initiate Remote Screen Rendering
Stop Remote Screen Rendering
Enable the camera
Turn Off Camera
Switch between front and rear cameras, note: only supported on mobile devices.
Enable Microphone
Turn off the microphone
Set video quality
Access device list
Switch camera or microphone devices
Turn on/off the multi-device login mode of TUICallEngine.
Switch/set background blur
Switch/set image background blur

Event Types

TUICallEvent is the callback event class corresponding to TUICallEngine. Through this callback, you can listen to the callback events of interest.
EVENT
Description
An error occurred during the call.
Receiving this event after a duplicate sign-in indicates that the user has been removed from the room
If a user answers, this event will be received. v4.x.x is deprecated
A user joined the call.
A user left the call.
A user declined the call.
A user didn't respond.
A user was busy.
Whether a user has a video stream.
Whether a user has an audio stream.
The volume levels of all users.
Call connected event
Call request event
Call not connected event
The call ended.
Device list update, this event will be received
All user network quality events

Document Link

TUICallEngine
TUICallEvent
Previous Topic: Type DefinitionNext Topic: TUICallKit

Help and Support

Was this page helpful?

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

Feedback