Tencent Cloud

Recent Pages

API Overview

Last updated: 2024-07-19 14:15:49

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.
﻿
﻿

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

tencent cloud

Recent Pages

API Overview

TUICallKit (UI Included)

Event

TUICallEngine (No UI)

Was this page helpful?

Was this page helpful?

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

Sign Up

Log in

Recent Pages

API Overview

TUICallKit (UI Included)

Event

TUICallEngine (No UI)

Was this page helpful?

Was this page helpful?