Join Tencent RTC at NAB Show 2024 in Las Vegas!
Learn more 
Only  $9.9! Get 50,000 minutes with our Starter Plan, perfect for your MVP project.
Only $9.9! Get 50,000 minutes with our Starter Plan, perfect for your MVP project.
Grab It Now 
Join Tencent RTC at NAB Show 2024 in Las Vegas!
Learn more 
Only  $9.9! Get 50,000 minutes with our Starter Plan, perfect for your MVP project.
Only $9.9! Get 50,000 minutes with our Starter Plan, perfect for your MVP project.
Grab It Now 
Call
Overview
  • Android
    • Integration
    • UI Customization
    • Offline Call Push
    • On-Cloud Recording
    • More Features
      • Configuring Nicknames and Avatars
      • Group Call
      • Floating Window
      • Custom Ringtone
      • Monitoring Call Status
    • API Documentation
      • API Overview
      • TUICallKit
      • TUICallEngine
      • TUICallObserver
      • Type Definition
    • Release Notes
  • iOS
    • Integration
    • UI Customization
    • Offline Call Push
      • VoIP
      • APNs
    • On-Cloud Recording
    • More Features
      • Configuring Nicknames and Avatars
      • Group Call
      • Floating Window
      • Custom Ringtone
      • Monitoring Call Status
    • API Documentation
      • API Overview
      • TUICallKit
      • TUICallEngine
      • TUICallObserver
      • Type Definition
    • Release Notes
  • Web
    • Integration
      • Web&H5 (React)
      • Web&H5 (Vue3)
    • UI Customization
    • On-Cloud Recording
    • More Features
      • Configuring Nicknames and Avatars
      • Configure Resolution and Fill Mode
      • Group Call
      • Floating Window
      • Custom Ringtone
      • Monitoring Call Status
    • API Documentation
      • API Overview
      • TUICallKit
      • TUICallEngine
      • TUICallEvent
    • Release Notes
  • Flutter
    • Integration
    • Offline Call Push
    • UI Customization
    • On-Cloud Recording
    • More Features
      • Configuring Nicknames and Avatars
      • Group Call
      • Floating Window
      • Beauty Effects
      • Custom Ringtone
      • Monitoring Call Status
    • API Documentation
      • API Overview
      • TUICallKit
      • TUICallEngine
      • TUICallObserver
      • Type Definition
    • Upgrading
    • Release Notes
  • Overview
    • Overview
  • Activate the Service
  • Pricing
    • Call Monthly Packages
    • Pay-As-You-Go
    • Free Minutes
  • ErrorCode
  • FAQs
    • All Platform
    • Flutter
    • Web
Call

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 folder in tencentyun/TUICallKit.
Replacing icons: You can directly replace the icons in the Resources\Calling.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 CallingLocalized.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
Creates a TUICallEngine instance (singleton).
Terminates a TUICallEngine instance (singleton).
init
Completes the authentication of basic audio/video call capabilities.
Registers an event listener.
Unregisters an event listener.
call
Makes a one-to-one call.
groupCall
Makes a group call.
accept
Answers a call.
reject
Declines a call.
hangup
Hangs up a call.
ignore
Ignores a call.
Invites a user during a group call.
Joins the current group call actively.
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.
Enables the camera.
Disables the camera.
Switches between the front and rear cameras.
Enables the mic.
Disables the mic.
Selects the audio playback device (receiver/speaker).
Sets the user nickname and profile photo.
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.
A call was received.
The call was canceled.
The call was connected.
onCallEnd
The call ended.
The call media 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.

Definitions of key classes

API
Description
The call media type. Enumeration: Video call and audio call.
The call role. Enumeration: Caller and callee.
The call status. Enumeration: Idle, waiting, and answering.
TUIRoomId
The audio/video room ID, which can be a number or string.
TUICamera
The camera type. Enumeration: Front camera and rear camera.
The audio playback device type. Enumeration: Speaker and receiver.
The information of the current network quality.