Join Tencent RTC at NAB Show 2024 in Las Vegas!
Learn more 
Only  $9.9! Get 50,000 minutes with our Starter Plan, perfect for your MVP project.
Only $9.9! Get 50,000 minutes with our Starter Plan, perfect for your MVP project.
Grab It Now 
Join Tencent RTC at NAB Show 2024 in Las Vegas!
Learn more 
Only  $9.9! Get 50,000 minutes with our Starter Plan, perfect for your MVP project.
Only $9.9! Get 50,000 minutes with our Starter Plan, perfect for your MVP project.
Grab It Now 
Call
Overview
  • Android
    • Integration
    • UI Customization
    • Offline Call Push
    • On-Cloud Recording
    • More Features
      • Configuring Nicknames and Avatars
      • Group Call
      • Floating Window
      • Custom Ringtone
      • Monitoring Call Status
    • API Documentation
      • API Overview
      • TUICallKit
      • TUICallEngine
      • TUICallObserver
      • Type Definition
    • Release Notes
  • iOS
    • Integration
    • UI Customization
    • Offline Call Push
      • VoIP
      • APNs
    • On-Cloud Recording
    • More Features
      • Configuring Nicknames and Avatars
      • Group Call
      • Floating Window
      • Custom Ringtone
      • Monitoring Call Status
    • API Documentation
      • API Overview
      • TUICallKit
      • TUICallEngine
      • TUICallObserver
      • Type Definition
    • Release Notes
  • Web
    • Integration
      • Web&H5 (React)
      • Web&H5 (Vue3)
    • UI Customization
    • On-Cloud Recording
    • More Features
      • Configuring Nicknames and Avatars
      • Configure Resolution and Fill Mode
      • Group Call
      • Floating Window
      • Custom Ringtone
      • Monitoring Call Status
    • API Documentation
      • API Overview
      • TUICallKit
      • TUICallEngine
      • TUICallEvent
    • Release Notes
  • Flutter
    • Integration
    • Offline Call Push
    • UI Customization
    • On-Cloud Recording
    • More Features
      • Configuring Nicknames and Avatars
      • Group Call
      • Floating Window
      • Beauty Effects
      • Custom Ringtone
      • Monitoring Call Status
    • API Documentation
      • API Overview
      • TUICallKit
      • TUICallEngine
      • TUICallObserver
      • Type Definition
    • Upgrading
    • Release Notes
  • Overview
    • Overview
  • Activate the Service
  • Pricing
    • Call Monthly Packages
    • Pay-As-You-Go
    • Free Minutes
  • ErrorCode
  • FAQs
    • All Platform
    • Flutter
    • Web
Call

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.
<TUICallKit/>: The core UI call component.
TUICallKitServer is the call instance, offering the following API interfaces.
API
Description
init
Initializing TUICallKit.
call
Initiate a one-on-one call
groupCall
Initiate a group call
Actively join the ongoing group call
Establish a personalised ringtone for incoming calls
Configure the user's nickname and profile photo
Toggle On/Off the ringtone for incoming calls
Activate/Deactivate the floating window function
Set the call language for the TUICallKit component
destroyed
Terminating 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
Enable Microphone
Turn off the microphone
Set video quality
Access device list
Switch camera or microphone devices
Enable/disable AI noise reduction

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 inside the SDK
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
If a user agrees to join the call, this callback will be received
If a user agrees to leave the call, this callback will be received
User declines the call
Invite user, no response
Invitee Busy Line
As an invitee, receiving this callback indicates that the call has timed out without an answer
Remote User turns Camera On/Off, this callback will be received
Remote User turns Microphone On/Off, this callback will be received
Remote User Speech Volume Adjustment, this callback will be received
Group Chat Update, Invitation List this callback will be received
Invited for a call
As an invitee, receiving this callback indicates that the call has been canceled
Receiving this callback indicates that the call has ended
Device list update, this callback will be received
This callback is received when switching call types

Document Link