Docs Overview/
Android/

Android

This document describes how to customize the UI of TUICallKit and provides two schemes for customization: slight UI adjustment and custom UI implementation.

Scheme One. Slight UI Adjustment

You can adjust the UI of TUICallKit by directly modifying the UI source code in the Android/tuicallkit folder in tencentyun/TUICallKit.

Replacing Icons

You can directly replace the icons in the 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.

img



Replacing Ringtones

You can replace ringtones by replacing the three audio files in the res\raw folder.
Filename
Purpose
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 values-zh and values-e.

Scheme Two. 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 pattern).
Terminates a TUICallEngine instance (singleton pattern).
init
Completes the authentication of basic audio/video call capabilities.
Adds an event callback.
Removes a callback API.
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.
Starts subscribing to the video stream of a remote user.
Stops subscribing to 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 on the device).
Sets the user nickname and profile photo.
Enables/Disables the multi-device log-in mode of TUICallEngine (supported by the premium plan).

TUICallObserver

TUICallObserver is the corresponding callback event 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 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.