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﻿
Log in
﻿logout﻿
Sign out
﻿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.
﻿enableMuteMode﻿
Sets whether to turn on the mute mode.
﻿enableFloatWindow﻿
Sets whether to enable floating windows.
﻿setCallingBell﻿
Custom ringtone.
﻿enableVirtualBackground﻿
Turn On/Off the Virtual Background feature
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
﻿init﻿
Authenticates the basic audio/video call capabilities.
﻿
﻿
﻿unInit﻿
The destructor function, which releases resources used by TUICallEngine.
﻿addObserver﻿
Registers an event listener.
﻿removeObserver﻿
Unregisters an event listener.
﻿call﻿
Makes a one-to-one call.
﻿groupCall﻿
Makes a group call.
﻿accept﻿
Accepts a call.
﻿reject﻿
Rejects a call.
﻿hangup﻿
Ends a call.
﻿ignore﻿
Ignores a call.
﻿inviteUser﻿
Invites users to the current group call.
﻿joinInGroupCall﻿
Joins a group call.
﻿switchCallMediaType﻿
Changes the call type, for example, 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 between the front and rear cameras.
﻿openMicrophone﻿
Turns the mic on.
﻿closeMicrophone﻿
Turns the mic off.
﻿selectAudioPlaybackDevice﻿
Selects the audio playback device (receiver or speaker).
﻿setSelfInfo﻿
Sets the alias and profile photo.
﻿enableMultiDeviceAbility﻿
Sets whether to enable multi-device login for TUICallEngine (supported by the premium package).
﻿setVideoRenderParams﻿
Set the rendering mode of video image.
﻿setVideoEncoderParams﻿
Set the encoding parameters of video encoder.
﻿queryRecentCalls﻿
Query call record.
﻿deleteRecordCalls﻿
Delete call record.
﻿setBlurBackground﻿
Set Blurry Video Effect
﻿setVirtualBackground﻿
Set Virtual Background Image
﻿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 is kicked offline
﻿onUserSigExpired﻿
Ticket expires while online

TUICallKit (UI Included)
TUICallEngine (No UI)
TUICallObserver

API	Description
login	Log in
logout	Sign out
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.
enableMuteMode	Sets whether to turn on the mute mode.
enableFloatWindow	Sets whether to enable floating windows.
setCallingBell	Custom ringtone.
enableVirtualBackground	Turn On/Off the Virtual Background feature

API	Description
init	Authenticates the basic audio/video call capabilities.

unInit	The destructor function, which releases resources used by TUICallEngine.
addObserver	Registers an event listener.
removeObserver	Unregisters an event listener.
call	Makes a one-to-one call.
groupCall	Makes a group call.
accept	Accepts a call.
reject	Rejects a call.
hangup	Ends a call.
ignore	Ignores a call.
inviteUser	Invites users to the current group call.
joinInGroupCall	Joins a group call.
switchCallMediaType	Changes the call type, for example, 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 between the front and rear cameras.
openMicrophone	Turns the mic on.
closeMicrophone	Turns the mic off.
selectAudioPlaybackDevice	Selects the audio playback device (receiver or speaker).
setSelfInfo	Sets the alias and profile photo.
enableMultiDeviceAbility	Sets whether to enable multi-device login for TUICallEngine (supported by the premium package).
setVideoRenderParams	Set the rendering mode of video image.
setVideoEncoderParams	Set the encoding parameters of video encoder.
queryRecentCalls	Query call record.
deleteRecordCalls	Delete call record.
setBlurBackground	Set Blurry Video Effect
setVirtualBackground	Set Virtual Background Image
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 is kicked offline
onUserSigExpired	Ticket expires while online