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 iOS/TUICallKit-Swift folder in tencentyun/TUICallKit.
Replacing icons: You can directly replace the icons in the Resources\Assets.xcassets 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 Resources\AudioFile folder.
Filename
Description
phone_dialing.m4a
The sound of making a call.
phone_hangup.mp3
The sound of being hung up.
phone_ringing.flac
The ringtone for incoming calls.
Replacing text: You can modify the strings on the video call UI by modifying the Localized.strings file in zh-Hans.lproj  and en.lproj.
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﻿
Create a TUICallEngine instance (singleton).
﻿destroyInstance﻿
Destroy TUICallEngine instance (singleton).
﻿Init﻿
Authenticates the basic audio/video call capabilities.
﻿addObserver﻿
Add listener.
﻿removeObserver﻿
Remove listener.
﻿calls﻿
Initiate a one-to-one or multi-person call
﻿join﻿
Proactively join a call
﻿accept﻿
Accept call.
﻿reject﻿
Reject call.
﻿hangup﻿
Hang up call.
﻿ignore﻿
Ignore call.
﻿inviteUser﻿
Invite users to the current call.
﻿switchCallMediaType﻿
Switch the call media type, such as from video call to audio call.
﻿startRemoteView﻿
Subscribe to the video stream of a remote user.
﻿stopRemoteView﻿
Unsubscribe from the video stream of a remote user.
﻿openCamera﻿
Turn on the camera.
﻿closeCamera﻿
Turn off the camera.
﻿switchCamera﻿
Switch camera.
﻿openMicrophone﻿
Enable microphone.
﻿closeMicrophone﻿
Disable the microphone.
﻿selectAudioPlaybackDevice﻿
Select the audio playback device (Earpiece/Speakerphone).
﻿setSelfInfo﻿
Set the user's profile picture 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 even class of TUICallEngine. You can use it to listen on the desired callback 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 classes
API
Description
﻿TUICallMediaType﻿
Call media type, Enumeration type: Unknown, Video, and Audio.
﻿TUICallRole﻿
Call role, Enumeration type: None, Call, and Called.
﻿TUICallStatus﻿
Call status, Enumeration type: None, Waiting, and Accept.
﻿TUIRoomId﻿
The room ID, which can be a number or string.
﻿TUICallCamera﻿
The camera type. Enumeration type: Front camera and Back camera.
﻿TUIAudioPlaybackDevice﻿
The audio playback device type. Enumeration type: Earpiece and Speakerphone.
﻿TUINetworkQualityInfo﻿
The current network quality.
﻿

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

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.
calls	Initiate a one-to-one or multi-person call
join	Proactively join a call
accept	Accept call.
reject	Reject call.
hangup	Hang up call.
ignore	Ignore call.
inviteUser	Invite users to the current call.
switchCallMediaType	Switch the call media type, such as from video call to audio call.
startRemoteView	Subscribe to the video stream of a remote user.
stopRemoteView	Unsubscribe from the video stream of a remote user.
openCamera	Turn on the camera.
closeCamera	Turn off the camera.
switchCamera	Switch camera.
openMicrophone	Enable microphone.
closeMicrophone	Disable the microphone.
selectAudioPlaybackDevice	Select the audio playback device (Earpiece/Speakerphone).
setSelfInfo	Set the user's profile picture 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
TUICallMediaType	Call media type, Enumeration type: Unknown, Video, and Audio.
TUICallRole	Call role, Enumeration type: None, Call, and Called.
TUICallStatus	Call status, Enumeration type: None, Waiting, and Accept.
TUIRoomId	The room ID, which can be a number or string.
TUICallCamera	The camera type. Enumeration type: Front camera and Back camera.
TUIAudioPlaybackDevice	The audio playback device type. Enumeration type: Earpiece and Speakerphone.
TUINetworkQualityInfo	The current network quality.