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 |
Initialize TUICallKit. | |
Initiate a one-to-one or multi-person call. | |
Proactively join a call. | |
Customize user's ringtone. | |
Set your own nickname and avatar. | |
Turn on/off ringtone. | |
Turn on/off the floating window function. | |
Turn on/off the blurred background function button. | |
Set the call language for the TUICallKit component. | |
Hidden Button. | |
Set the background image for the local user's call interface. | |
Set the background image for the remote user's call interface. | |
Set the call interface layout mode. | |
et whether the camera is opened by default. | |
Destroy TUICallKit. | |
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 |
Creating a TUICallEngine Instance (Singleton Pattern) | |
Terminating a TUICallEngine Instance (Singleton Pattern) | |
Listening on events | |
Canceling Event Listening | |
Sign in Interface | |
Logout Interface | |
Configure the user's nickname and profile photo | |
Initiate a one-on-one call | |
Proactively join a call. | |
Answer Calls | |
Decline Call | |
End Calls | |
Switch Audio and Video Calls | |
Initiate Remote Screen Rendering | |
Stop Remote Screen Rendering | |
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 event is received when the SDK enters the ready state | |
Receiving this event after a duplicate sign-in indicates that the user has been removed from the room | |
If a user answers, this event 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 | |
Call request event, v1.4.6+ supported | |
Call canceled event. | |
Call connected event, v1.4.6+ supported | |
The call ended. | |
Device list update, this event will be received | |
Call type switching, this event will be received | |
All user network quality events, v3.0.7+ supported |
