API Overview
TUICallKit (UI Included)
TUICallKit is an audio/video call component that includes UI elements. You can use its APIs to quickly implement an audio/video call application similar to WeChat.
API | Description |
Creates a TUICallKit instance (singleton mode). | |
Sets the user nickname and profile photo. | |
Makes a one-to-one call. | |
Makes a one-to-one call, Support for custom room ID, call timeout, offline push content, etc | |
Makes a group call. | |
Makes a group call, Support for custom room ID, call timeout, offline push content, etc | |
Joins a group call. | |
Sets the ringtone. | |
Sets whether to turn on the mute mode. | |
Sets whether to enable floating windows. | |
Sets whether to enable the incoming banner. |
TUICallEngine (No UI)
TUICallEngine
is an audio/video call component that does not include UI elements. If TUICallKit
does not meet your requirements, you can use the APIs of TUICallEngine
to customize your project.API | Description |
Creates a TUICallEngine instance (singleton). | |
Terminates a TUICallEngine instance (singleton). | |
Authenticates the basic audio/video call capabilities. | |
Registers an event listener. | |
Unregisters an event listener. | |
Makes a one-to-one call. | |
Makes a group call. | |
Answers a call. | |
Declines a call. | |
Ends a call. | |
Ignores a call. | |
Invites users to the current group call. | |
Joins a group call. | |
Switches the call media type, such as from video call to audio call. | |
Subscribes to the video stream of a remote user. | |
Unsubscribes from the video stream of a remote user. | |
Turns the camera on. | |
Turns the camera off. | |
Switches the camera. | |
Enables the mic. | |
Disables the mic. | |
Selects the audio playback device (receiver/speaker). | |
Sets the user nickname and profile photo. | |
Set the rendering mode of video image. | |
Set the encoding parameters of video encoder. | |
Advanced features. | |
Set beauty level, support turning off default beauty. |
TUICallObserver
TUICallObserver
is the callback class of TUICallEngine
. You can use it to listen for events.API | Description |
An error occurred during the call. | |
A call was received. | |
The call was canceled. | |
The call was connected. | |
The call ended. | |
The call type changed. | |
A user declined the call. | |
A user didn't respond. | |
A user was busy. | |
A user joined the call. | |
A user left the call. | |
Whether a user had a video stream. | |
Whether a user had an audio stream. | |
The volume levels of all users. | |
The network quality of all users. | |
The current user was kicked offline. | |
The user sig is expired. |
Definitions of Key Types
API | Description |
The call type. Enumeration: Video call and audio call. | |
The call role. Enumeration: Caller and callee. | |
The call status. Enumeration: Idle, waiting, and answering. | |
The room ID, which can be a number or string. | |
The camera type. Enumeration: Front camera and rear camera. | |
The audio playback device type. Enumeration: Speaker and receiver. | |
The current network quality. |