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
﻿createInstance﻿
Create a TUICallKit instance (singleton mode).
﻿setSelfInfo﻿
Set user's avatar and nickname.
﻿call﻿
Make a one-to-one call.
﻿call﻿
Makes a one-to-one call, Support for custom room ID, call timeout, offline push content, etc
﻿groupCall﻿
Make a group call.
﻿groupCall﻿
Makes a group call, Support for custom room ID, call timeout, offline push content, etc
﻿joinInGroupCall﻿
Join a group call.
﻿setCallingBell﻿
Set the ringtone.
﻿enableMuteMode﻿
Set whether to turn on the mute mode.
﻿enableFloatWindow﻿
Set whether to enable floating windows.
﻿enableIncomingBanner﻿
Sets whether to display 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
﻿createInstance﻿
Create a TUICallEngine instance (singleton).
﻿destroyInstance﻿
Destroy TUICallEngine instance (singleton).
﻿init﻿
Authenticates the basic audio/video call capabilities.
﻿addObserver﻿
Add listener.
﻿removeObserver﻿
Remove listener.
﻿call﻿
Make a one-to-one call.
﻿groupCall﻿
Make a group call.
﻿accept﻿
Accept call.
﻿reject﻿
Reject call.
﻿hangup﻿
Hang up call.
﻿ignore﻿
Ignore call.
﻿inviteUser﻿
Invite users to the current group call.
﻿joinInGroupCall﻿
Join a group call.
﻿switchCallMediaType﻿
Switch the call media type, such as from video call to audio call.
﻿startRemoteView﻿
Subscribes to the video stream of a remote user.
﻿stopRemoteView﻿
Unsubscribes from the video stream of a remote user.
﻿openCamera﻿
Turns the camera on.
﻿closeCamera﻿
Turns the camera off.
﻿switchCamera﻿
Switches the camera.
﻿openMicrophone﻿
Enables the mic.
﻿closeMicrophone﻿
Disables the mic.
﻿selectAudioPlaybackDevice﻿
Selects the audio playback device (Earpiece/Speakerphone).
﻿setSelfInfo﻿
Set user's avatar and nickname.
﻿enableMultiDeviceAbility﻿
Sets whether to enable multi-device login for TUICallEngine (supported by the Group Call package).
﻿setVideoRenderParams﻿
Set the rendering mode of video.
﻿setVideoEncoderParams﻿
Set the encoding parameters of video encoder.
﻿getTRTCCloudInstance﻿
Advanced features.
﻿setBeautyLevel﻿
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
﻿onError﻿
An error occurred during the call.
﻿onCallReceived﻿
A call was received.
﻿onCallCancelled﻿
The call was canceled.
﻿onCallBegin﻿
The call was connected.
﻿onCallEnd﻿
The call ended.
﻿onCallMediaTypeChanged﻿
The call type changed.
﻿onUserReject﻿
A user declined the call.
﻿onUserNoResponse﻿
A user didn't respond.
﻿onUserLineBusy﻿
A user was busy.
﻿onUserJoin﻿
A user joined the call.
﻿onUserLeave﻿
A user left the call.
﻿onUserVideoAvailable﻿
Whether a user has a video stream.
﻿onUserAudioAvailable﻿
Whether a user has an audio stream.
﻿onUserVoiceVolumeChanged﻿
The volume levels of all users.
﻿onUserNetworkQualityChanged﻿
The network quality of all users.
﻿onKickedOffline﻿
The current user was kicked offline.
﻿onUserSigExpired﻿
The user sig is expired.
Definitions of Key Types
API
Description
﻿TUICallDefine.MediaType﻿
Call media type, Enumeration type: Unknown, Video, and Audio.
﻿TUICallDefine.Role﻿
Call role, Enumeration type: None, Caller, and Called.
﻿TUICallDefine.Status﻿
Call status, Enumeration type: None, Waiting, and Accept.
﻿TUICommonDefine.RoomId﻿
The room ID, which can be a number or string.
﻿TUICommonDefine.Camera﻿
The camera type. Enumeration type: Front and Back.
﻿TUICommonDefine.AudioPlaybackDevice﻿
The audio playback device type. Enumeration type: Earpiece and Speakerphone.
﻿TUICommonDefine.NetworkQualityInfo﻿
The current network quality.
﻿

TUICallKit (UI Included)
TUICallEngine (No UI)
TUICallObserver
Definitions of Key Types

API	Description
createInstance	Create a TUICallKit instance (singleton mode).
setSelfInfo	Set user's avatar and nickname.
call	Make a one-to-one call.
call	Makes a one-to-one call, Support for custom room ID, call timeout, offline push content, etc
groupCall	Make a group call.
groupCall	Makes a group call, Support for custom room ID, call timeout, offline push content, etc
joinInGroupCall	Join a group call.
setCallingBell	Set the ringtone.
enableMuteMode	Set whether to turn on the mute mode.
enableFloatWindow	Set whether to enable floating windows.
enableIncomingBanner	Sets whether to display incoming banner.

API	Description
createInstance	Create a `TUICallEngine` instance (singleton).
destroyInstance	Destroy `TUICallEngine` instance (singleton).
init	Authenticates the basic audio/video call capabilities.
addObserver	Add listener.
removeObserver	Remove listener.
call	Make a one-to-one call.
groupCall	Make a group call.
accept	Accept call.
reject	Reject call.
hangup	Hang up call.
ignore	Ignore call.
inviteUser	Invite users to the current group call.
joinInGroupCall	Join a group call.
switchCallMediaType	Switch the call media type, such as from video call to audio call.
startRemoteView	Subscribes to the video stream of a remote user.
stopRemoteView	Unsubscribes from the video stream of a remote user.
openCamera	Turns the camera on.
closeCamera	Turns the camera off.
switchCamera	Switches the camera.
openMicrophone	Enables the mic.
closeMicrophone	Disables the mic.
selectAudioPlaybackDevice	Selects the audio playback device (Earpiece/Speakerphone).
setSelfInfo	Set user's avatar and nickname.
enableMultiDeviceAbility	Sets whether to enable multi-device login for `TUICallEngine` (supported by the Group Call package).
setVideoRenderParams	Set the rendering mode of video.
setVideoEncoderParams	Set the encoding parameters of video encoder.
getTRTCCloudInstance	Advanced features.
setBeautyLevel	Set beauty level, support turning off default beauty.

API	Description
onError	An error occurred during the call.
onCallReceived	A call was received.
onCallCancelled	The call was canceled.
onCallBegin	The call was connected.
onCallEnd	The call ended.
onCallMediaTypeChanged	The call type changed.
onUserReject	A user declined the call.
onUserNoResponse	A user didn't respond.
onUserLineBusy	A user was busy.
onUserJoin	A user joined the call.
onUserLeave	A user left the call.
onUserVideoAvailable	Whether a user has a video stream.
onUserAudioAvailable	Whether a user has an audio stream.
onUserVoiceVolumeChanged	The volume levels of all users.
onUserNetworkQualityChanged	The network quality of all users.
onKickedOffline	The current user was kicked offline.
onUserSigExpired	The user sig is expired.

API	Description
TUICallDefine.MediaType	Call media type, Enumeration type: Unknown, Video, and Audio.
TUICallDefine.Role	Call role, Enumeration type: None, Caller, and Called.
TUICallDefine.Status	Call status, Enumeration type: None, Waiting, and Accept.
TUICommonDefine.RoomId	The room ID, which can be a number or string.
TUICommonDefine.Camera	The camera type. Enumeration type: Front and Back.
TUICommonDefine.AudioPlaybackDevice	The audio playback device type. Enumeration type: Earpiece and Speakerphone.
TUICommonDefine.NetworkQualityInfo	The current network quality.