TUICallObserver
TUICallObserver APIs
TUICallObserver is the callback class of TUICallEngine. You can use it to listen for events.Overview
API | Description |
A call occurred during the call. | |
A call invitation was received. | |
The call was canceled. | |
The call was connected. | |
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. | |
current user is logged out | |
Token Expiration |
Details
Listen to the events thrown by
addObserver.TUICallEngine.instance.addObserver(TUICallObserver(onError: (int code, String message) {},onCallCancelled: (String callerId) {}, onCallBegin: (TUIRoomId roomId, TUICallMediaType callMediaType, TUICallRole callRole) {}, onCallEnd: (TUIRoomId roomId, TUICallMediaType callMediaType, TUICallRole callRole, double totalTime) {}, onCallMediaTypeChanged: (TUICallMediaType oldCallMediaType, TUICallMediaType newCallMediaType) {}, onUserReject: (String userId) {}, onUserNoResponse: (String userId) {}, onUserLineBusy: (String onUserLineBusy) {}, onUserJoin: (String userId) {}, onUserLeave: (String userId) {}, onUserVideoAvailable: (String userId, bool isVideoAvailable) {}, onUserAudioAvailable: (String userId, bool isAudioAvailable) {}, onUserNetworkQualityChanged: (List<TUINetworkQualityInfo> networkQualityList) {}, onCallReceived: (String callerId, List<String> calleeIdList, String groupId, TUICallMediaType callMediaType) {}, onUserVoiceVolumeChanged: (Map<String, int> volumeMap) {}, onKickedOffline: () {}, onUserSigExpired: () {}));
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.
TUICallEngine.instance.addObserver(TUICallObserver(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.
TUICallEngine.instance.addObserver(TUICallObserver(onCallReceived: (String callerId, List<String> calleeIdList, String groupId, TUICallMediaType callMediaType) {}));
The parameters are described below:
Parameter | Type | Description |
callerId | String | The user ID of the inviter. |
calleeIdList | List<String> | The invitee list. |
groupId | String | The group ID. |
callMediaType | The call type, which can be video or audio. |
onCallCancelled
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 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).
TUICallEngine.instance.addObserver(TUICallObserver(onCallCancelled: (String callerId) {}));
The parameters are described below:
Parameter | Type | Description |
callerId | String | The user ID of the inviter. |
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.
TUICallEngine.instance.addObserver(TUICallObserver(onCallBegin: (TUIRoomId roomId, TUICallMediaType callMediaType, TUICallRole callRole) {}));
The parameters are described below:
Parameter | Type | Description |
roomId | The room ID. | |
callMediaType | The call type, which can be video or audio. | |
callRole | The role, which can be caller or callee. |
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.
TUICallEngine.instance.addObserver(TUICallObserver(onCallEnd: (TUIRoomId roomId, TUICallMediaType callMediaType, TUICallRole callRole, double totalTime) {}));
The parameters are described below:
Parameter | Type | Description |
roomId | The room ID. | |
callMediaType | The call type, which can be video or audio. | |
callRole | Number | The role, which can be caller or callee. |
totalTime | double | The call duration: ms |
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.
onCallMediaTypeChanged
TUICallEngine.instance.addObserver(TUICallObserver(onCallMediaTypeChanged: (TUICallMediaType oldCallMediaType, TUICallMediaType newCallMediaType) {}));
The parameters are described below:
Parameter | Type | Description |
oldCallMediaType | The call media type before the change. | |
newCallMediaType | The call media type after the change. |
onUserReject
The call was rejected. In a one-to-one call, only the inviter will receive this callback. In a group call, all invitees will receive this callback.
TUICallEngine.instance.addObserver(TUICallObserver(onUserReject: (String userId) {}));
The parameters are described below:
Parameter | Type | Description |
res.userId | String | The user ID of the invitee who rejected the call. |
onUserNoResponse
A user did not respond.
TUICallEngine.instance.addObserver(TUICallObserver(onUserNoResponse: (String userId) {}));
The parameters are described below:
Parameter | Type | Description |
userId | String | The user ID of the invitee who did not answer. |
onUserLineBusy
A user is busy.
TUICallEngine.instance.addObserver(TUICallObserver(onUserLineBusy: (String onUserLineBusy) {},));
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.
TUICallEngine.instance.addObserver(TUICallObserver(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.
TUICallEngine.instance.addObserver(TUICallObserver(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.
TUICallEngine.instance.addObserver(TUICallObserver(onUserVideoAvailable: (String userId, bool isVideoAvailable) {}));
The parameters are described below:
Parameter | Type | Description |
userId | String | The user ID. |
isVideoAvailable | bool | User video available |
onUserAudioAvailable
Whether a user is sending audio.
TUICallEngine.instance.addObserver(TUICallObserver(onUserAudioAvailable: (String userId, bool isAudioAvailable) {}));
The parameters are described below:
Parameter | Type | Description |
userId | String | The user ID. |
isAudioAvailable | bool | Whether the user has audio. |
onUserVoiceVolumeChanged
The volumes of all users.
TUICallEngine.instance.addObserver(TUICallObserver(onUserVoiceVolumeChanged: (Map<String, int> volumeMap) {}));
The parameters are described below:
Parameter | Type | Description |
volumeMap | Map<String, int> | The volume table, which includes the volume of each user (userId). Value range: 0-100. |
onUserNetworkQualityChanged
The network quality of all users.
TUICallEngine.instance.addObserver(TUICallObserver(onUserNetworkQualityChanged: (List<TUINetworkQualityInfo> networkQualityList) {}));class TUINetworkQualityInfo {String userId;TUINetworkQuality quality;TUINetworkQualityInfo({required this.userId, required this.quality});}enum TUINetworkQuality {unknown,excellent,good,poor,bad,vBad,down}
The parameters are described below:
Parameter | Type | Description |
networkQualityList | he current network conditions for all users (userId). |
onKickedOffline
The current user is kicked offline: at this time, the UI can prompt the user and call initialization again.
TUICallEngine.instance.addObserver(TUICallObserver(onKickedOffline: () {}));
onUserSigExpired
Token expired: you need to generate a new userSig and login again.
TUICallEngine.instance.addObserver(TUICallObserver(onUserSigExpired: () {}));