TUICallEngine

TUICallEngine APIs
TUICallEngine API is the No UI Interface of the Audio and Video Call Components.
API Overview
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
﻿call﻿
Initiate a one-on-one call
﻿groupCall﻿
Group Chat Invitation 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. v3.0.0+ supported
﻿openMicrophone﻿
Enable Microphone
﻿closeMicrophone﻿
Turn off the microphone
﻿setVideoQuality﻿
Set video quality
﻿getDeviceList﻿
Access device list
﻿switchDevice﻿
Switch camera or microphone devices
﻿enableAIVoice﻿
Enable/disable AI noise reduction
﻿enableMultiDeviceAbility﻿
Turn on/off the multi-device login mode of TUICallEngine. v2.1.1+ supported
﻿setBlurBackground﻿
Switch/set background blur, v3.0.6+ supported
﻿setVirtualBackground﻿
Switch/set image background blur, v3.0.6+ supported
Deprecated Interface
API
Description
﻿call﻿
Initiate a one-on-one call,  Note:  it is recommended to use the calls API.
﻿groupCall﻿
Group Chat Invitation Call,  Note:  it is recommended to use the calls API.
﻿startLocalView﻿
Start Local Screen Rendering, Note: This will be deprecated; use openCamera instead
﻿stopLocalView﻿
Stop Local Screen Rendering, Note: This will be deprecated; use closeCamera instead
﻿joinInGroupCall﻿
This API is used to join a group call. Note:  it is recommended to use the join API.
﻿switchCallMediaType﻿
Switch Audio and Video Calls

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
call	Initiate a one-on-one call
groupCall	Group Chat Invitation 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. v3.0.0+ supported
openMicrophone	Enable Microphone
closeMicrophone	Turn off the microphone
setVideoQuality	Set video quality
getDeviceList	Access device list
switchDevice	Switch camera or microphone devices
enableAIVoice	Enable/disable AI noise reduction
enableMultiDeviceAbility	Turn on/off the multi-device login mode of TUICallEngine. v2.1.1+ supported
setBlurBackground	Switch/set background blur, v3.0.6+ supported
setVirtualBackground	Switch/set image background blur, v3.0.6+ supported

API	Description
call	Initiate a one-on-one call, Note: it is recommended to use the calls API.
groupCall	Group Chat Invitation Call, Note: it is recommended to use the calls API.
startLocalView	Start Local Screen Rendering, Note: This will be deprecated; use openCamera instead
stopLocalView	Stop Local Screen Rendering, Note: This will be deprecated; use closeCamera instead
joinInGroupCall	This API is used to join a group call. Note: it is recommended to use the join API.
switchCallMediaType	Switch Audio and Video Calls