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﻿
Creates a TUICallEngine instance (singleton).
﻿destroyInstance﻿
Destroy a TUICallEngine instance (singleton).
﻿init﻿
Completes the authentication of basic audio/video call capabilities.
﻿addObserver﻿
Registers an event listener.
﻿removeObserver﻿
Unregisters an event listener.
﻿call﻿
Makes a one-to-one call.
﻿groupCall﻿
Makes a group call.
﻿accept﻿
Answers a call.
﻿reject﻿
Reject a call.
﻿hangup﻿
Hangs up a call.
﻿ignore﻿
Ignores a call.
﻿inviteUser﻿
Invites a user during a group call.
﻿joinInGroupCall﻿
Joins the current group call actively.
﻿switchCallMediaType﻿
Switches 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﻿
Enables the camera.
﻿closeCamera﻿
Disables the camera.
﻿switchCamera﻿
Switches between the front and rear cameras.
﻿openMicrophone﻿
Enables the mic.
﻿closeMicrophone﻿
Disables the mic.
﻿selectAudioPlaybackDevice﻿
Selects the audio playback device (receiver/speaker).
﻿setSelfInfo﻿
Sets the user nickname and profile photo.
﻿enableMultiDeviceAbility﻿
Enables/Disables the multi-device login mode of TUICallEngine (supported by the premium plan).
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 media 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 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.
Definitions of key classes
API
Description
﻿TUICallMediaType﻿
The call media type. Enumeration: Video and Audio.
﻿TUICallRole﻿
The call role. Enumeration: Call and Called.
﻿TUICallStatus﻿
The call status. Enumeration: None, Waiting, and Accept.
﻿TUIRoomId﻿
The audio/video room ID, which can be a number or string.
﻿TUICamera﻿
The camera type. Enumeration: Front and Back.
﻿TUIAudioPlaybackDevice﻿
The audio playback device type. Enumeration: Speakerphone and Earpiece.
﻿TUINetworkQualityInfo﻿
The information of the current network quality.
﻿

Scheme 1. Slight UI Adjustment
Scheme 2. Custom UI Implementation

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	Creates a `TUICallEngine` instance (singleton).
destroyInstance	Destroy a `TUICallEngine` instance (singleton).
init	Completes the authentication of basic audio/video call capabilities.
addObserver	Registers an event listener.
removeObserver	Unregisters an event listener.
call	Makes a one-to-one call.
groupCall	Makes a group call.
accept	Answers a call.
reject	Reject a call.
hangup	Hangs up a call.
ignore	Ignores a call.
inviteUser	Invites a user during a group call.
joinInGroupCall	Joins the current group call actively.
switchCallMediaType	Switches 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	Enables the camera.
closeCamera	Disables the camera.
switchCamera	Switches between the front and rear cameras.
openMicrophone	Enables the mic.
closeMicrophone	Disables the mic.
selectAudioPlaybackDevice	Selects the audio playback device (receiver/speaker).
setSelfInfo	Sets the user nickname and profile photo.
enableMultiDeviceAbility	Enables/Disables the multi-device login mode of `TUICallEngine` (supported by the premium plan).

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 media 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 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.

API	Description
TUICallMediaType	The call media type. Enumeration: Video and Audio.
TUICallRole	The call role. Enumeration: Call and Called.
TUICallStatus	The call status. Enumeration: None, Waiting, and Accept.
TUIRoomId	The audio/video room ID, which can be a number or string.
TUICamera	The camera type. Enumeration: Front and Back.
TUIAudioPlaybackDevice	The audio playback device type. Enumeration: Speakerphone and Earpiece.
TUINetworkQualityInfo	The information of the current network quality.