tencent cloud

Tencent Real-Time Communication

DocumentationTencent Real-Time CommunicationCallClient APIsAndroidTUICallObserver

TUICallObserver

PDF
Focus Mode
Font Size
Last updated: 2025-10-10 11:27:42

TUICallObserver APIs

TUICallObserver is the callback class of TUICallEngine. You can use it to listen for events.

Overview

API
Description
onError
A call occurred during the call.
A call invitation was received.
The call was connected.
onCallEnd
The call ended.
The call not connected.
A user declined the call.
A user didn't respond.
A user was busy.
A user is invited to join a call.
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.
The current user was kicked offline.
The user Sig is expired.

Details

onError

An error occurred.
Note:
This callback indicates that the SDK encountered an unrecoverable error. Such errors must be listened for, and UI reminders should be sent to users if necessary.
void onError(int code, String message);
The parameters are described below:
Parameter
Type
Description
code
int
The error code.
message
String
The error message.

onCallReceived


A call invitation was received
. This callback is received by an invitee. You can listen for this event to determine whether to display the incoming call view.
void onCallReceived(String callId, String callerId, List<String> calleeIdList, 
                    TUICallDefine.MediaType mediaType, TUICallDefine.CallObserverExtraInfo info);
The parameters are described below:
Parameter
Type
Description
callId
String
Unique ID of this call
callerId
String
Caller ID
calleeIdList
List<String>
Callee ID List
mediaType
The call type, which can be video or audio.
info
Extended information

onCallBegin

The call was connected. This callback is received by both the inviter and invitees. You can listen for this event to determine whether to start on-cloud recording, content moderation, or other tasks.
void onCallBegin(String callId, TUICallDefine.MediaType mediaType, TUICallDefine.CallObserverExtraInfo info);
The parameters are described below:
Parameter
Type
Description
callId
String
Unique ID of this call
mediaType
The call type, which can be video or audio.
info
Extended information

onCallEnd

The call ended. This callback is received by both the inviter and invitees. You can listen for this event to determine when to display call information such as call duration and call type, or stop on-cloud recording.
void onCallEnd(String callId, TUICallDefine.MediaType mediaType, TUICallDefine.CallEndReason reason, 
               String userId, long totalTime, TUICallDefine.CallObserverExtraInfo info);
The parameters are described below:
Parameter
Type
Description
callId
String
Unique ID of this call
mediaType
The call type, which can be video or audio.
reason
Call end reason
userId
String
​​Ended by user ID
totalTime
long
The call duration.
info
Extended information
Note:
Client-side callbacks are often lost when errors occur, for example, when the process is closed. If you need to measure the duration of a call for billing or other purposes, we recommend you use the RESTful API.

onCallNotConnected

The call was canceled by the inviter or timed out. This callback is received by an invitee. You can listen for this event to determine whether to show a missed call message.
This indicates that the call was canceled by the caller, timed out by the callee, rejected by the callee, or the callee was busy. There are multiple scenarios involved. You can listen to this event to achieve UI logic such as missed calls and resetting UI status.
Call cancellation by the caller: The caller receives the callback (userId is himself); the callee receives the callback (userId is the ID of the caller)
Callee timeout: the caller will simultaneously receive the onUserNoResponse and onCallNotConnected callbacks (userId is his own ID); the callee receives the onCallNotConnected callback (userId is his own ID)
Callee rejection: The caller will simultaneously receive the onUserReject and onCallNotConnected callbacks (userId is his own ID); the callee receives the onCallNotConnected callback (userId is his own ID)
Callee busy: The caller will simultaneously receive the onUserLineBusy and onCallNotConnected callbacks (userId is his own ID);
Abnormal interruption: The callee failed to receive the call ，he receives this callback (userId is his own ID).
void onCallNotConnected(String callId, TUICallDefine.MediaType mediaType, TUICallDefine.CallEndReason reason, 
                        String userId, TUICallDefine.CallObserverExtraInfo info);
The parameters are described below:
Parameter
Type
Description
callId
String
Unique ID of this call
mediaType
The call type, which can be video or audio.
reason
Call end reason
userId
String
​​Not connected by user ID
info
Extended information

onUserReject


The call was rej
ected. In a one-to-one call, only the inviter will receive this callback. In a group call, all invitees will receive this callback.
void onUserReject(String userId);
The parameters are described below:
Parameter
Type
Description
userId
String
The user ID of the invitee who rejected the call.

onUserNoResponse


A user did not respond.

void onUserNoResponse(String userId);
The parameters are described below:
Parameter
Type
Description
userId
String
The user ID of the invitee who did not answer.

onUserInviting

A user is invited to join a call.
void onUserInviting(String userId);
The parameters are described below:
Parameter
Type
Description
userId
String
The user ID of the invite.

onUserLineBusy


A user is busy.

void onUserLineBusy(String userId);
The parameters are described below:
Parameter
Type
Description
userId
String
The user ID of the invitee who is busy.

onUserJoin

A user joined the call.
void onUserJoin(String userId);
The parameters are described below:
Parameter
Type
Description
userId
String
The ID of the user who joined the call.

onUserLeave

A user left the call.
void onUserLeave(String userId);
The parameters are described below:
Parameter
Type
Description
userId
String
The ID of the user who left the call.

onUserVideoAvailable

Whether a user is sending video.
void onUserVideoAvailable(String userId, boolean isVideoAvailable);
The parameters are described below:
Parameter
Type
Description
userId
String
The user ID.
isVideoAvailable
boolean
Whether the user has video.

onUserAudioAvailable

Whether a user is sending audio.
void onUserAudioAvailable(String userId, boolean isAudioAvailable);
The parameters are described below:
Parameter
Type
Description
userId
String
The user ID.
isAudioAvailable
boolean
Whether the user has audio.

onUserVoiceVolumeChanged

The volumes of all users.
void onUserVoiceVolumeChanged(Map<String, Integer> volumeMap);
The parameters are described below:
Parameter
Type
Description
volumeMap
Map
The volume table, which includes the volume of each user (userId). Value range: 0-100.

onUserNetworkQualityChanged

The network quality of all users.
void onUserNetworkQualityChanged(List<TUICallDefine.NetworkQualityInfo> networkQualityList);
The parameters are described below:
Parameter
Type
Description
networkQualityList
List
The current network conditions for all users (userId).

onKickedOffline

The current user was kicked offline: At this time, you can prompt the user with a UI message and then invoke init again.
void onKickedOffline();

onUserSigExpired

The user sig is expired: At this time, you need to generate a new userSig, and then invoke init again.
void onUserSigExpired();

Deprecated Interface

onCallCancelled

This indicates that the call was canceled by the caller, timed out by the callee, rejected by the callee, or the callee was busy. There are multiple scenarios involved. You can listen to this event to achieve UI logic such as missed calls and resetting UI status.
Call cancellation by the caller: The caller receives the callback (userId is himself); the callee receives the callback (userId is the ID of the caller)
Callee timeout: The caller will simultaneously receive the onUserNoResponse and onCallCancelled callbacks (userId is his own ID); the callee receives the onCallCancelled callback (userId is his own ID)
Callee rejection: The caller will simultaneously receive the onUserReject and onCallCancelled callbacks (userId is his own ID); the callee receives the onCallCancelled callback (userId is his own ID)
Callee busy: The caller will simultaneously receive the onUserLineBusy and onCallCancelled callbacks (userId is his own ID);
Abnormal interruption: The callee failed to receive the call ，he receives this callback (userId is his own ID).
void onCallCancelled(String userId);
The parameters are described below:
Parameter
Type
Description
userId
String
The user ID of the inviter.

onCallMediaTypeChanged

The call type changed.
void onCallMediaTypeChanged(TUICallDefine.MediaType oldCallMediaType,TUICallDefine.MediaType newCallMediaType);
The parameters are described below:
Parameter
Type
Description
oldCallMediaType
The call type before the change.
newCallMediaType
The call type after the change.
Previous Topic: TUICallEngineNext Topic: Type Definition

Help and Support

Was this page helpful?

Help us improve! Rate your documentation experience in 5 mins.

Feedback