Tencent Cloud

Recent Pages

API Overview

Last updated: 2024-07-30 11:19: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
﻿createInstance﻿
Creates a TUICallKit instance (singleton mode).
﻿setSelfInfo﻿
Sets the user nickname and profile photo.
﻿call﻿
Makes a one-to-one call.
﻿call﻿
Makes a one-to-one call, Support for custom room ID, call timeout, offline push content, etc
﻿groupCall﻿
Makes a group call.
﻿groupCall﻿
Makes a group call, Support for custom room ID, call timeout, offline push content, etc
﻿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 enable the incoming banner.
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
﻿createInstance﻿
Creates a TUICallEngine instance (singleton).
﻿destroyInstance﻿
Terminates a TUICallEngine instance (singleton).
﻿init﻿
Authenticates the basic audio/video call capabilities.
﻿addObserver﻿
Registers an event listener.
﻿removeObserver﻿
Unregisters an event listener.
﻿call﻿
Makes a one-to-one call.
﻿groupCall﻿
Makes a group call.
﻿accept﻿
Answers a call.
﻿reject﻿
Declines a call.
﻿hangup﻿
Ends a call.
﻿ignore﻿
Ignores a call.
﻿inviteUser﻿
Invites users to the current group call.
﻿joinInGroupCall﻿
Joins a group call.
﻿switchCallMediaType﻿
Switches the call media type, such as from video call to audio call.
﻿startRemoteView﻿
Subscribes to the video stream of a remote user.
﻿stopRemoteView﻿
Unsubscribes from the video stream of a remote user.
﻿openCamera﻿
Turns the camera on.
﻿closeCamera﻿
Turns the camera off.
﻿switchCamera﻿
Switches the camera.
﻿openMicrophone﻿
Enables the mic.
﻿closeMicrophone﻿
Disables the mic.
﻿selectAudioPlaybackDevice﻿
Selects the audio playback device (receiver/speaker).
﻿setSelfInfo﻿
Sets the user nickname and profile photo.
﻿enableMultiDeviceAbility﻿
Sets whether to enable multi-device login for TUICallEngine (supported by the Group Call package).
﻿setVideoRenderParams﻿
Set the rendering mode of video image.
﻿setVideoEncoderParams﻿
Set the encoding parameters of video encoder.
﻿getTRTCCloudInstance﻿
Advanced features.
﻿setBeautyLevel﻿
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.
﻿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.
Definitions of Key Types
API
Description
﻿TUICallDefine.MediaType﻿
The call type. Enumeration: Video call and audio call.
﻿TUICallDefine.Role﻿
The call role. Enumeration: Caller and callee.
﻿TUICallDefine.Status﻿
The call status. Enumeration: Idle, waiting, and answering.
﻿TUICommonDefine.RoomId﻿
The room ID, which can be a number or string.
﻿TUICommonDefine.Camera﻿
The camera type. Enumeration: Front camera and rear camera.
﻿TUICommonDefine.AudioPlaybackDevice﻿
The audio playback device type. Enumeration: Speaker and receiver.
﻿TUICommonDefine.NetworkQualityInfo﻿
The current network quality.
﻿

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)

TUICallEngine (No UI)

TUICallObserver

Definitions of Key Types

Was this page helpful?

Was this page helpful?

API	Description
createInstance	Creates a TUICallKit instance (singleton mode).
setSelfInfo	Sets the user nickname and profile photo.
call	Makes a one-to-one call.
call	Makes a one-to-one call, Support for custom room ID, call timeout, offline push content, etc
groupCall	Makes a group call.
groupCall	Makes a group call, Support for custom room ID, call timeout, offline push content, etc
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 enable the incoming banner.

API	Description
createInstance	Creates a `TUICallEngine` instance (singleton).
destroyInstance	Terminates a `TUICallEngine` instance (singleton).
init	Authenticates the basic audio/video call capabilities.
addObserver	Registers an event listener.
removeObserver	Unregisters an event listener.
call	Makes a one-to-one call.
groupCall	Makes a group call.
accept	Answers a call.
reject	Declines a call.
hangup	Ends a call.
ignore	Ignores a call.
inviteUser	Invites users to the current group call.
joinInGroupCall	Joins a group call.
switchCallMediaType	Switches the call media type, such as from video call to audio call.
startRemoteView	Subscribes to the video stream of a remote user.
stopRemoteView	Unsubscribes from the video stream of a remote user.
openCamera	Turns the camera on.
closeCamera	Turns the camera off.
switchCamera	Switches the camera.
openMicrophone	Enables the mic.
closeMicrophone	Disables the mic.
selectAudioPlaybackDevice	Selects the audio playback device (receiver/speaker).
setSelfInfo	Sets the user nickname and profile photo.
enableMultiDeviceAbility	Sets whether to enable multi-device login for `TUICallEngine` (supported by the Group Call package).
setVideoRenderParams	Set the rendering mode of video image.
setVideoEncoderParams	Set the encoding parameters of video encoder.
getTRTCCloudInstance	Advanced features.
setBeautyLevel	Set beauty level, support turning off default beauty.

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
TUICallDefine.MediaType	The call type. Enumeration: Video call and audio call.
TUICallDefine.Role	The call role. Enumeration: Caller and callee.
TUICallDefine.Status	The call status. Enumeration: Idle, waiting, and answering.
TUICommonDefine.RoomId	The room ID, which can be a number or string.
TUICommonDefine.Camera	The camera type. Enumeration: Front camera and rear camera.
TUICommonDefine.AudioPlaybackDevice	The audio playback device type. Enumeration: Speaker and receiver.
TUICommonDefine.NetworkQualityInfo	The current network quality.

tencent cloud

Sign Up

Log in

Recent Pages

API Overview

TUICallKit (UI Included)

TUICallEngine (No UI)

TUICallObserver

Definitions of Key Types

Was this page helpful?

Was this page helpful?