please select
Call
  • Web
    • Overview
      • Product Introduction
      • Activate the Service
      • Pricing
        • Free Minutes
        • Call Monthly Packages
        • Billing Explanation for Subscription Package Duration
    • Get Started
      • Run Sample Code
      • Integration (React)
      • Integration (Vue3)
      • Secure authentication with userSig
    • Basic Features
      • UI Customization
      • Configuring Nickname and Avatar
      • GroupCall
      • Floating Window
      • Custom Ringtone
      • Configure Resolution and Fill Mode
      • Monitoring Call Status
      • Language Settings
    • Advanced Features
      • Virtual Background
      • AI Noise Suppression
      • On-Cloud Recording
    • Client APIs
      • UIKit APIs
        • API Overview
        • TUICallKit
      • Engine APIs
        • TUICallEngine
        • TUICallEvent
    • Server APIs
      • Call Status Callback
        • Call Status Callback
        • Call Event Callback
        • Callback Configuration
          • API List for Callback Configuration
          • Establishing Callback Configuration
          • Retrieving Callback Configuration
          • Update Callback Configuration
          • Remove Callback Configuration
      • REST API
        • Introduction to REST API
        • Retrieve records via callId
        • Retrieve Records Based on Conditions
    • FAQs
      • All Platfroms
      • Web
      • ErrorCode
      • Release Notes
  • Android
    • Overview
      • Product Introduction
      • Activate the Service
      • Pricing
        • Free Minutes
        • Call Monthly Packages
        • Billing Explanation for Subscription Package Duration
    • Get Started
      • Run Sample Code
      • Integration
      • Secure authentication with userSig
    • Basic Features
      • UI Customization
      • Offline Call Push
      • Configuring Nicknames and Avatars
      • Group Call
      • Floating Window
      • Custom Ringtone
      • Monitoring Call Status
    • Advanced Features
      • Virtual Background
      • AI Noise Suppression
      • On-Cloud Recording
    • Client APIs
      • UIKit APIs
        • API Overview
        • TUICallKit
        • TUICallObserver
        • Type Definition
      • Engine APIs
        • TUICallEngine
    • Server APIs
      • Call Status Callback
        • Call Status Callback
        • Call Event Callback
        • Callback Configuration
          • API List for Callback Configuration
          • Establishing Callback Configuration
          • Retrieving Callback Configuration
          • Update Callback Configuration
          • Remove Callback Configuration
      • REST API
        • Introduction to REST API
        • Retrieve records via callId
        • Retrieve Records Based on Conditions
    • FAQs
      • All Platforms
      • Android
      • ErrorCode
      • Release Notes
  • iOS
    • Overview
      • Product Introduction
      • Activate the Service
      • Pricing
        • Free Minutes
        • Call Monthly Packages
        • Billing Explanation for Subscription Package Duration
    • Get Started
      • Run Sample Code
      • Integration
      • Secure authentication with userSig
    • Basic Features
      • UI Customization
      • Offline Call Push
        • VoIP
        • APNs
      • Configuring Nicknames and Avatars
      • Group Call
      • Floating Window
      • Custom Ringtone
      • Monitoring Call Status
    • Advanced Features
      • Virtual Background
      • AI Noise Suppression
      • On-Cloud Recording
    • Client APIs
      • UIKit APIs
        • API Overview
        • TUICallKit
        • TUICallObserver
        • Type Definition
      • Engine APIs
        • TUICallEngine
    • Server APIs
      • Call Status Callback
        • Call Status Callback
        • Call Event Callback
        • Callback Configuration
          • API List for Callback Configuration
          • Establishing Callback Configuration
          • Retrieving Callback Configuration
          • Update Callback Configuration
          • Remove Callback Configuration
      • REST API
        • Introduction to REST API
        • Retrieve records via callId
        • Retrieve Records Based on Conditions
    • FQAs
      • All Platform
      • iOS
      • ErrorCode
      • Release Notes
  • Flutter
    • Overview
      • Product Introduction
      • Activate the Service
      • Pricing
        • Free Minutes
        • Call Monthly Packages
        • Billing Explanation for Subscription Package Duration
    • Get Started
      • Run Sample Code
      • Integration
      • Secure authentication with userSig
    • Basic Features
      • UI Customization
      • offline Call Push
        • Notification
        • VoIP (Optional)
      • Configuring Nicknames and Avatars
      • Group Call
      • Floating Window
      • Custom Ringtone
      • Monitoring Call Status
    • Advanced Features
      • Virtual Background
      • AI Noise Suppression
      • On-Cloud Recording
      • Beauty Effects
    • Client APIs
      • API Overview
      • TUICallKit
      • TUICallEngine
      • TUICallObserver
      • Type Definition
    • Server APIs
      • Call Status Callback
        • Call Status Callback
        • Call Event Callback
        • Callback Configuration
          • API List for Callback Configuration
          • Establishing Callback Configuration
          • Retrieving Callback Configuration
          • Update Callback Configuration
          • Remove Callback Configuration
      • REST API
        • Introduction to REST API
        • Retrieve records via callId
        • Retrieve Records Based on Conditions
    • FQAs
      • All Platform
      • Flutter
      • ErrorCode
      • Upgrading
      • Release Notes
Call
Docs Overview/
Call/
Web/
Client APIs/
UIKit APIs/
API Overview/

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.
call
Makes a one-to-one call, Support for custom room ID, call timeout, offline push content, etc
groupCall
Makes a group call, Support for custom room ID, call timeout, offline push content, etc
Join a group call.
Customize user's ringtone.
Set your own nickname and avatar.
Turn on/off ringtone
Activate/Deactivate the floating window function Turn on/off the floating window function
Turn on/off the blurred background function button. v3.2.4+ support
Set the call language for the TUICallKit component
Hidden Button, v3.2.9+ support
Set the background image for the local user's call interface, v3.2.9+ support
Set the background image for the remote user's call interface, v3.2.9+ support
Set the call interface layout mode, supported from v3.3.0+
Set whether the camera is opened by default, supported from v3.3.0+
destroyed
Terminating TUICallKit Destroy TUICallKit

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
Creating a TUICallEngine Instance (Singleton Pattern)
Terminating a TUICallEngine Instance (Singleton Pattern)
on
Listening on events
off
Canceling Event Listening
login
Sign in Interface
logout
Logout Interface
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
Switch Audio and Video Calls
Initiate Remote Screen Rendering
Stop Remote Screen Rendering
Start Local Screen Rendering, Note: This will be deprecated; use openCamera instead
Stop Local Screen Rendering, Note: This will be deprecated; use closeCamera instead
Enable the camera
Turn Off Camera
Switch between front and rear cameras, note: only supported on mobile devices. v3.0.0+ supported
Enable Microphone
Turn off the microphone
Set video quality
Access device list
Switch camera or microphone devices
Enable/disable AI noise reduction
Turn on/off the multi-device login mode of TUICallEngine. v2.1.1+ supported
Switch/set background blur, v3.0.6+ supported
Switch/set image background blur, v3.0.6+ supported

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
An error occurred during the call.
This callback is received when the SDK enters the Ready State
Duplicate Sign in, receiving this callback indicates being Kicked out of Room
If a user answers, this callback will be received
A user joined the call.
A user left the call.
A user declined the call.
A user didn't respond.
A user was busy.
Whether a user has a video stream.
Whether a user has an audio stream.
The volume levels of all users.
Group Chat Update, Invitation List this callback will be received
Call connected event, v1.4.6+ supported
A call was received. It will be discarded later and it is recommended to use TUICallEvent.ON_CALL_RECEIVED
Call request event, v1.4.6+ supported
Call cancellation event,
It will be abandoned later and it is recommended to use TUICallEvent.ON_CALL_CANCELED
Call canceled event, v1.4.6+ supported
The call ended.
Device list update, this callback will be received
This callback is received when switching call types
All user network quality events, v3.0.7+ supported

Document Link

TUICallEngine
TUICallEvent