UI Customization

This document describes how to customize the UI of TUICallKit and provides two schemes for customization: slight UI adjustment and custom UI implementation.
Scheme 1. Slight UI Adjustment
You can adjust the UI of TUICallKit by directly modifying the UI source code in the Android/tuicallkit-kt folder in tencentyun/TUICallKit.
Replacing icons
You can directly replace the icons in the tuicallkit-kt/src/main/res/drawable-xxhdpi folder to customize the color tone and style of all the icons in your application. When you replace an icon, make sure the filename is the same as the original icon.
﻿
﻿
﻿
Replacing ringtones
You can replace ringtones by replacing the three audio files in the tuicallkit-kt/src/main/res/raw folder.
Filename
Description
phone_dialing.mp3
The sound of making a call
phone_hangup.mp3
The sound of being hung up
phone_ringing.mp3
The ringtone for incoming calls
Replacing text
You can modify the strings on the video call UI by modifying the strings.xml file in tuicallkit-kt/src/main/res/values-**/.
Scheme 2. Custom UI Implementation
The entire call feature of TUICallKit is implemented based on the UI-less component TUICallEngine. You can delete the tuicallkit folder and implement your own UIs based entirely on TUICallEngine.
TUICallEngine
TUICallEngine is the underlying API of the entire TUICallKit component. It provides key APIs such as APIs for making, answering, declining, and hanging up one-to-one audio/video and group calls and device operations.
API
Description
﻿createInstance﻿
Creates a TUICallEngine instance (singleton mode).
﻿destroyInstance﻿
Terminates a TUICallEngine instance (singleton mode).
﻿Init﻿
Authenticates the basic audio/video call capabilities.
﻿addObserver﻿
Registers an event listener.
﻿removeObserver﻿
Unregisters an event listener.
﻿calls﻿
Initiate a one-to-one or multi-person call.
﻿join﻿
Proactively join a call.
﻿accept﻿
Accepts a call.
﻿reject﻿
Rejects a call.
﻿hangup﻿
Ends a call.
﻿ignore﻿
Ignores a call.
﻿inviteUser﻿
Invites users to the current group 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 between the front and rear cameras.
﻿openMicrophone﻿
Turns the mic on.
﻿closeMicrophone﻿
Turns the mic off.
﻿selectAudioPlaybackDevice﻿
Selects the audio playback device (receiver or speaker).
﻿setSelfInfo﻿
Sets the alias and profile photo.
﻿enableMultiDeviceAbility﻿
Sets whether to enable multi-device login for TUICallEngine (supported by the Group Call package).
﻿setVideoRenderParams﻿
Set the rendering mode of video image.
﻿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 event class of TUICallEngine. You can use it to listen on the desired callback events.
API
Description
﻿onError﻿
A call occurred during the call.
﻿onCallReceived﻿
A call invitation was received.
﻿onCallBegin﻿
The call was connected.
﻿onCallEnd﻿
The call ended.
﻿onCallNotConnected﻿
The call not connected.
﻿onUserReject﻿
A user declined the call.
﻿onUserNoResponse﻿
A user didn't respond.
﻿onUserLineBusy﻿
A user was busy.
﻿onUserInviting﻿
A user is invited to join a call.
﻿onUserJoin﻿
A user joined the call.
﻿onUserLeave﻿
A user left the call.
﻿onUserVideoAvailable﻿
Whether a user had a video stream.
﻿onUserAudioAvailable﻿
Whether a user had 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﻿
The call media type. Enumeration: Video call and audio call.
﻿TUICallDefine.Role﻿
The call role. Enumeration: Caller and callee.
﻿TUICallDefine.Status﻿
The call status. Enumeration: Idle, waiting, and answering.
﻿TUICommonDefine.RoomId﻿
The audio/video room ID, which can be a number or string.
﻿TUICommonDefine.Camera﻿
The camera type. Enumeration: Front camera and rear camera.
﻿TUICommonDefine.AudioPlaybackDevice﻿
The audio playback device type. Enumeration: Speaker and receiver.
﻿TUICommonDefine.NetworkQualityInfo﻿
The information of the current network quality.

Filename	Description
phone_dialing.mp3	The sound of making a call
phone_hangup.mp3	The sound of being hung up
phone_ringing.mp3	The ringtone for incoming calls

API	Description
createInstance	Creates a `TUICallEngine` instance (singleton mode).
destroyInstance	Terminates a `TUICallEngine` instance (singleton mode).
Init	Authenticates the basic audio/video call capabilities.
addObserver	Registers an event listener.
removeObserver	Unregisters an event listener.
calls	Initiate a one-to-one or multi-person call.
join	Proactively join a call.
accept	Accepts a call.
reject	Rejects a call.
hangup	Ends a call.
ignore	Ignores a call.
inviteUser	Invites users to the current group 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 between the front and rear cameras.
openMicrophone	Turns the mic on.
closeMicrophone	Turns the mic off.
selectAudioPlaybackDevice	Selects the audio playback device (receiver or speaker).
setSelfInfo	Sets the alias and profile photo.
enableMultiDeviceAbility	Sets whether to enable multi-device login for `TUICallEngine` (supported by the Group Call package).
setVideoRenderParams	Set the rendering mode of video image.
setVideoEncoderParams	Set the encoding parameters of video encoder.
getTRTCCloudInstance	Advanced features.
setBeautyLevel	Set beauty level, support turning off default beauty.

API	Description
onError	A call occurred during the call.
onCallReceived	A call invitation was received.
onCallBegin	The call was connected.
onCallEnd	The call ended.
onCallNotConnected	The call not connected.
onUserReject	A user declined the call.
onUserNoResponse	A user didn't respond.
onUserLineBusy	A user was busy.
onUserInviting	A user is invited to join a call.
onUserJoin	A user joined the call.
onUserLeave	A user left the call.
onUserVideoAvailable	Whether a user had a video stream.
onUserAudioAvailable	Whether a user had 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	The call media type. Enumeration: Video call and audio call.
TUICallDefine.Role	The call role. Enumeration: Caller and callee.
TUICallDefine.Status	The call status. Enumeration: Idle, waiting, and answering.
TUICommonDefine.RoomId	The audio/video room ID, which can be a number or string.
TUICommonDefine.Camera	The camera type. Enumeration: Front camera and rear camera.
TUICommonDefine.AudioPlaybackDevice	The audio playback device type. Enumeration: Speaker and receiver.
TUICommonDefine.NetworkQualityInfo	The information of the current network quality.