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 APIsAndroidAPI Overview

API Overview

PDF
Focus Mode
Font Size
Last updated: 2025-10-31 09:57:40

TUICallKit (UI Included)

TUICallKit is an audio/video call component that includes UI elements. You can use its APIs to quickly implement an audio/video call application similar to WeChat.
API
Description
Create a TUICallKit instance (singleton mode).
Set user's avatar and nickname.
calls
Initiate a one-to-one or multi-person call.
join
Proactively join a call.
Set the ringtone.
Set whether to turn on the mute mode.
Set whether to enable floating windows.
Sets whether to display incoming banner.
Hide the specified button.

TUICallEngine (No UI)

TUICallEngine is an audio/video call component that does not include UI elements. If TUICallKit does not meet your requirements, you can use the APIs of TUICallEngine to customize your project.
API
Description
Create a TUICallEngine instance (singleton).
Destroy TUICallEngine instance (singleton).
init
Authenticates the basic audio/video call capabilities.
Add listener.
Remove listener.
calls
Initiate a one-to-one or multi-person call.
join
Proactively join a call.
accept
Accept call.
reject
Reject call.
hangup
Hang up call.
ignore
Ignore call.
Invite users to the current group call.
Switch the call media type, such as from video call to audio call.
Subscribes to the video stream of a remote user.
Unsubscribes from the video stream of a remote user.
Turns the camera on.
Turns the camera off.
Switches the camera.
Enables the mic.
Disables the mic.
Selects the audio playback device (Earpiece/Speakerphone).
Set user's avatar and nickname.
Sets whether to enable multi-device login for TUICallEngine (supported by the Group Call package).
Set the rendering mode of video.
Set the encoding parameters of video encoder.
Advanced features.
Set beauty level, support turning off default beauty.

TUICallObserver

TUICallObserver is the callback class of TUICallEngine. You can use it to listen for events.
API
Description
onError
An error occurred during the call.
A call was received.
The call was canceled.
The call was connected.
onCallEnd
The call ended.
The call type changed.
A user declined the call.
A user didn't respond.
A user was busy.
A user joined the call.
A user left the call.
Whether a user has a video stream.
Whether a user has an audio stream.
The volume levels of all users.
The network quality of all users.
The current user was kicked offline.
The user sig is expired.

Definitions of Key Types

API
Description
Call media type, Enumeration type: Unknown, Video, and Audio.
Call role, Enumeration type: None, Caller, and Called.
Call status, Enumeration type: None, Waiting, and Accept.
The room ID, which can be a number or string.
The camera type. Enumeration type: Front camera and Back camera.
The audio playback device type. Enumeration type: Earpiece and Speakerphone.
The current network quality.
Previous Topic: End CallsNext Topic: TUICallKit（With UI）

Help and Support

Was this page helpful?

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

Feedback