API Overview

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
﻿login﻿
login
﻿logout﻿
logou
﻿setSelfInfo﻿
Sets the user nickname and profile photo.
﻿call﻿
Makes a one-to-one call.
﻿groupCall﻿
Makes a group call.
﻿joinInGroupCall﻿
Joins a group call.
﻿setCallingBell﻿
Sets the ringtone.
﻿enableMuteMode﻿
Sets whether to turn on the mute mode.
﻿enableFloatWindow﻿
Sets whether to enable floating windows.
﻿enableIncomingBanner﻿
Sets whether to display incoming banner. v2.3.1+ supported.
Event
TUICallKit throws the following events.
API
Description
﻿onError﻿
An error occurred during the call.
﻿onCallReceived﻿
A call was received.
﻿onCallCancelled﻿
The call was canceled.
﻿onCallBegin﻿
The call was connected.
﻿onCallEnd﻿
The call ended.
﻿onCallMediaTypeChanged﻿
The call type changed.
﻿onUserReject﻿
A user declined the call.
﻿onUserNoResponse﻿
A user didn't respond.
﻿onUserLineBusy﻿
A user was busy.
﻿onUserJoin﻿
A user joined the call.
﻿onUserLeave﻿
A user left the call.
﻿onUserVideoAvailable﻿
Whether a user has a video stream.
﻿onUserAudioAvailable﻿
Whether a user has an audio stream.
﻿onUserVoiceVolumeChanged﻿
The volume levels of all users.
﻿onUserNetworkQualityChanged﻿
The network quality of all users.
﻿onKickedOffline﻿
The current user was kicked offline.
﻿onUserSigExpired﻿
The user sig is expired.
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
﻿hangup﻿
Ends a call.
﻿accept﻿
Answers a call.
﻿setVideoRenderParams﻿
Set the rendering mode of video image.
﻿setVideoEncoderParams﻿
Set the encoding parameters of video encoder.
﻿
﻿

Was this page helpful?

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

Yes

API	Description
login	login
logout	logou
setSelfInfo	Sets the user nickname and profile photo.
call	Makes a one-to-one call.
groupCall	Makes a group call.
joinInGroupCall	Joins a group call.
setCallingBell	Sets the ringtone.
enableMuteMode	Sets whether to turn on the mute mode.
enableFloatWindow	Sets whether to enable floating windows.
enableIncomingBanner	Sets whether to display incoming banner. v2.3.1+ supported.

API	Description
onError	An error occurred during the call.
onCallReceived	A call was received.
onCallCancelled	The call was canceled.
onCallBegin	The call was connected.
onCallEnd	The call ended.
onCallMediaTypeChanged	The call type changed.
onUserReject	A user declined the call.
onUserNoResponse	A user didn't respond.
onUserLineBusy	A user was busy.
onUserJoin	A user joined the call.
onUserLeave	A user left the call.
onUserVideoAvailable	Whether a user has a video stream.
onUserAudioAvailable	Whether a user has an audio stream.
onUserVoiceVolumeChanged	The volume levels of all users.
onUserNetworkQualityChanged	The network quality of all users.
onKickedOffline	The current user was kicked offline.
onUserSigExpired	The user sig is expired.

API	Description
hangup	Ends a call.
accept	Answers a call.
setVideoRenderParams	Set the rendering mode of video image.
setVideoEncoderParams	Set the encoding parameters of video encoder.

tencent cloud

New User Offers

Next-Generation CDN：EdgeOne

Elasticsearch Service free trial

Free Tier

Tencent Cloud Startup Program

Special Offers

Lighthouse Special Offers

Cloud Object Storage Special Offers

Featured Products

New Products

Education

Tencent Cloud Online Education Solutions

Gaming

Gaming Solution

Game Media Solutions

E-commerce

E-commerce retail solutions

Audio & Video

Audio/Video Solution

LVB Recording Solution

Interactive Classroom Solution

Interactive Live Streaming Solution

Audio Chat Social Networking Solution

Financial Services

Financial Services Solution

Compute

Cloud Virtual Machine

Auto Scaling

Batch Compute

CVM Dedicated Host

Database

TencentDB for MySQL

TencentDB for Redis®

TencentDB for CTSDB

TDSQL for MySQL

Data Transfer Service

TencentDB for MongoDB

TencentDB for PostgreSQL

TencentDB for SQL Server

TencentDB for TcaplusDB

Video Service

Cloud Streaming Services

Video on Demand

Media Processing Service

Cloud Application Rendering

Cloud Contact Center

Game Multimedia Engine

Chat

Real-time Communication

Tencent Effect SDK

AI and Machine Learning

Image Creation Large Model

Face Fusion

eKYC

Optical Character Recognition

Video Creation Large Model

Industry Applications

Tencent HealthCare Omics Platform

Container and Middleware

TDMQ for CKafka

Serverless Cloud Function

Tencent Kubernetes Engine

Tencent Kubernetes Engine for Serverless

Networking

Cloud Load Balancer

Virtual Private Cloud

Direct Connect

Cloud Connect Network

NAT Gateway

VPN Connection

Bandwidth Package

Anycast Internet Acceleration

Elastic Network Interface

Flow Logs

Global Application Acceleration Platform

Security

Captcha

Cloud Workload Protection Platform

Data Security Governance Center