API Overview

TUICallKit (Includes UI Components)
TUICallKit is an audio and video call component that includes a UI component. You can quickly implement a WhatsApp-like audio and video calling scenario with this component.
API
Description
﻿init﻿
Initialize TUICallKit.
﻿calls﻿
Initiate a one-to-one or multi-person call.
﻿join﻿
Proactively join a call.
﻿setCallingBell﻿
Customize user's ringtone.
﻿setSelfInfo﻿
Set your own nickname and avatar.
﻿enableMuteMode﻿
Turn on/off ringtone.
﻿enableFloatWindow﻿
Turn on/off the floating window function.
﻿enableVirtualBackground﻿
Turn on/off the blurred background function button.
﻿setLanguage﻿
Set the call language for the TUICallKit component.
﻿hideFeatureButton﻿
Hidden Button.
﻿setLocalViewBackgroundImage﻿
Set the background image for the local user's call interface.
﻿setRemoteViewBackgroundImage﻿
Set the background image for the remote user's call interface.
﻿setLayoutMode﻿
Set the call interface layout mode.
﻿setCameraDefaultState﻿
et whether the camera is opened by default.
﻿destroyed﻿
Destroy TUICallKit.
﻿getTUICallEngineInstance﻿
Get TUICallEngine instance.
TUICallEngine (No UI)
TUICallEngine API is an audio and video call component that offers a No UI interface. You can use this set of APIs to custom encapsulate according to your business needs.
API
Description
﻿createInstance﻿
Creating a TUICallEngine Instance (Singleton Pattern)
﻿destroyInstance﻿
Terminating a TUICallEngine Instance (Singleton Pattern)
﻿on﻿
Listening on events
﻿off﻿
Canceling Event Listening
﻿login﻿
Sign in Interface
﻿logout﻿
Logout Interface
﻿setSelfInfo﻿
Configure the user's nickname and profile photo
﻿calls﻿
Initiate a one-on-one call
﻿join﻿
Proactively join a call.
﻿accept﻿
Answer Calls
﻿reject﻿
Decline Call
﻿hangup﻿
End Calls
﻿startRemoteView﻿
Initiate Remote Screen Rendering
﻿stopRemoteView﻿
Stop Remote Screen Rendering
﻿openCamera﻿
Enable the camera
﻿closeCamara﻿
Turn Off Camera
﻿switchCamera﻿
Switch between front and rear cameras, note: only supported on mobile devices.
﻿openMicrophone﻿
Enable Microphone
﻿closeMicrophone﻿
Turn off the microphone
﻿setVideoQuality﻿
Set video quality
﻿getDeviceList﻿
Access device list
﻿switchDevice﻿
Switch camera or microphone devices
﻿enableMultiDeviceAbility﻿
Turn on/off the multi-device login mode of TUICallEngine.
﻿setBlurBackground﻿
Switch/set background blur
﻿setVirtualBackground﻿
Switch/set image background blur
Event Types
TUICallEvent is the callback event class corresponding to TUICallEngine. Through this callback, you can listen to the callback events of interest.
EVENT
Description
﻿TUICallEvent.ERROR﻿
An error occurred during the call.
﻿TUICallEvent.KICKED_OUT﻿
Receiving this event after a duplicate sign-in indicates that the user has been removed from the room
﻿TUICallEvent.USER_ACCEPT﻿
If a user answers, this event will be received
﻿TUICallEvent.USER_ENTER﻿
A user joined the call.
﻿TUICallEvent.USER_LEAVE﻿
A user left the call.
﻿TUICallEvent.REJECT﻿
A user declined the call.
﻿TUICallEvent.NO_RESP﻿
A user didn't respond.
﻿TUICallEvent.LINE_BUSY﻿
A user was busy.
﻿TUICallEvent.USER_VIDEO_AVAILABLE﻿
Whether a user has a video stream.
﻿TUICallEvent.USER_AUDIO_AVAILABLE﻿
Whether a user has an audio stream.
﻿TUICallEvent.USER_VOICE_VOLUME﻿
The volume levels of all users.
﻿TUICallEvent.ON_CALL_BEGIN﻿
Call connected event
﻿TUICallEvent.ON_CALL_RECEIVED﻿
Call request event
﻿TUICallEvent.ON_CALL_CONNECTED﻿
Call not connect event
﻿TUICallEvent.ON_CALL_END﻿
The call ended.
﻿TUICallEvent.DEVICED_UPDATED﻿
Device list update, this event will be received
﻿TUICallEvent.ON_USER_NETWORK_QUALITY_CHANGED﻿
All user network quality events
Document Link
﻿TUICallEngine﻿
﻿TUICallEvent﻿

API	Description
init	Initialize TUICallKit.
calls	Initiate a one-to-one or multi-person call.
join	Proactively join a call.
setCallingBell	Customize user's ringtone.
setSelfInfo	Set your own nickname and avatar.
enableMuteMode	Turn on/off ringtone.
enableFloatWindow	Turn on/off the floating window function.
enableVirtualBackground	Turn on/off the blurred background function button.
setLanguage	Set the call language for the TUICallKit component.
hideFeatureButton	Hidden Button.
setLocalViewBackgroundImage	Set the background image for the local user's call interface.
setRemoteViewBackgroundImage	Set the background image for the remote user's call interface.
setLayoutMode	Set the call interface layout mode.
setCameraDefaultState	et whether the camera is opened by default.
destroyed	Destroy TUICallKit.
getTUICallEngineInstance	Get TUICallEngine instance.

API	Description
createInstance	Creating a TUICallEngine Instance (Singleton Pattern)
destroyInstance	Terminating a TUICallEngine Instance (Singleton Pattern)
on	Listening on events
off	Canceling Event Listening
login	Sign in Interface
logout	Logout Interface
setSelfInfo	Configure the user's nickname and profile photo
calls	Initiate a one-on-one call
join	Proactively join a call.
accept	Answer Calls
reject	Decline Call
hangup	End Calls
startRemoteView	Initiate Remote Screen Rendering
stopRemoteView	Stop Remote Screen Rendering
openCamera	Enable the camera
closeCamara	Turn Off Camera
switchCamera	Switch between front and rear cameras, note: only supported on mobile devices.
openMicrophone	Enable Microphone
closeMicrophone	Turn off the microphone
setVideoQuality	Set video quality
getDeviceList	Access device list
switchDevice	Switch camera or microphone devices
enableMultiDeviceAbility	Turn on/off the multi-device login mode of TUICallEngine.
setBlurBackground	Switch/set background blur
setVirtualBackground	Switch/set image background blur

EVENT	Description
TUICallEvent.ERROR	An error occurred during the call.
TUICallEvent.KICKED_OUT	Receiving this event after a duplicate sign-in indicates that the user has been removed from the room
TUICallEvent.USER_ACCEPT	If a user answers, this event will be received
TUICallEvent.USER_ENTER	A user joined the call.
TUICallEvent.USER_LEAVE	A user left the call.
TUICallEvent.REJECT	A user declined the call.
TUICallEvent.NO_RESP	A user didn't respond.
TUICallEvent.LINE_BUSY	A user was busy.
TUICallEvent.USER_VIDEO_AVAILABLE	Whether a user has a video stream.
TUICallEvent.USER_AUDIO_AVAILABLE	Whether a user has an audio stream.
TUICallEvent.USER_VOICE_VOLUME	The volume levels of all users.
TUICallEvent.ON_CALL_BEGIN	Call connected event
TUICallEvent.ON_CALL_RECEIVED	Call request event
TUICallEvent.ON_CALL_CONNECTED	Call not connect event
TUICallEvent.ON_CALL_END	The call ended.
TUICallEvent.DEVICED_UPDATED	Device list update, this event will be received
TUICallEvent.ON_USER_NETWORK_QUALITY_CHANGED	All user network quality events