io.agora.rtc

Class DefaultRtcConnObserver

java.lang.Object

io.agora.rtc.DefaultRtcConnObserver

All Implemented Interfaces:

IRtcConnObserver

public class DefaultRtcConnObserver
extends java.lang.Object
implements IRtcConnObserver

Constructor Summary

Constructors

Constructor and Description
DefaultRtcConnObserver()

Method Summary

Modifier and Type	Method and Description
void	onApiCallExecuted(AgoraRtcConn agoraRtcConn, int err, java.lang.String api, java.lang.String result) Reports the result of an API call execution.
void	onChangeRoleFailure(AgoraRtcConn agoraRtcConn) Occurs when the local user fails to change the user role.
void	onChangeRoleSuccess(AgoraRtcConn agoraRtcConn, int oldRole, int newRole) Occurs when the role of the local user changes successfully.
void	onChannelMediaRelayStateChanged(AgoraRtcConn agoraRtcConn, int state, int code) Occurs when the state of the channel media relay changes.
void	onConnected(AgoraRtcConn agoraRtcConn, RtcConnInfo connInfo, int reason) Occurs when the connection state between the SDK and the Agora channel changes to CONNECTION_STATE_CONNECTED(3).
void	onConnecting(AgoraRtcConn agoraRtcConn, RtcConnInfo connInfo, int reason) Occurs when the connection state between the SDK and the Agora channel changes to CONNECTION_STATE_CONNECTING(2).
void	onConnectionFailure(AgoraRtcConn agoraRtcConn, RtcConnInfo connInfo, int reason) Occurs when the connection state between the SDK and the Agora channel changes to CONNECTION_STATE_FAILED(5).
void	onConnectionLicenseValidationFailure(AgoraRtcConn agoraRtcConn, RtcConnInfo connInfo, int reason) Occurs when connection license verification fails.
void	onConnectionLost(AgoraRtcConn agoraRtcConn, RtcConnInfo connInfo) Occurs when the SDK loses connection with the Agora channel.
void	onContentInspectResult(AgoraRtcConn agoraRtcConn, int result) Reports the result of content inspection.
void	onDisconnected(AgoraRtcConn agoraRtcConn, RtcConnInfo connInfo, int reason) Occurs when the connection state between the SDK and the Agora channel changes to CONNECTION_STATE_DISCONNECTED(1).
void	onEncryptionError(AgoraRtcConn agoraRtcConn, int errorType) Occurs when an encryption error happens during the transmission.
void	onError(AgoraRtcConn agoraRtcConn, int error, java.lang.String msg) Reports an error during SDK runtime.
void	onLastmileProbeResult(AgoraRtcConn agoraRtcConn, LastmileProbeResult result) Reports the result of the last-mile network probe test.
void	onLastmileQuality(AgoraRtcConn agoraRtcConn, int quality) Reports the quality of the last-mile network.
void	onLocalUserRegistered(AgoraRtcConn agoraRtcConn, int uid, java.lang.String userAccount) Occurs when the local user successfully registers a user account by calling the joinChannelWithUserAccount method.
void	onNetworkTypeChanged(AgoraRtcConn agoraRtcConn, int type) Occurs when the network type is changed.
void	onReconnected(AgoraRtcConn agoraRtcConn, RtcConnInfo connInfo, int reason) Occurs when the connection is reestablished after a disconnection.
void	onReconnecting(AgoraRtcConn agoraRtcConn, RtcConnInfo connInfo, int reason) Occurs when the connection state between the SDK and the Agora channel changes to CONNECTION_STATE_RECONNECTING(4).
void	onSnapshotTaken(AgoraRtcConn agoraRtcConn, java.lang.String channel, int uid, java.lang.String filePath, int width, int height, int errCode) Occurs when a snapshot is successfully taken.
void	onStreamMessageError(AgoraRtcConn agoraRtcConn, java.lang.String userId, int streamId, int code, int missed, int cached) Reports the error that occurs when receiving data stream messages.
void	onTokenPrivilegeDidExpire(AgoraRtcConn agoraRtcConn) Occurs when the token has expired.
void	onTokenPrivilegeWillExpire(AgoraRtcConn agoraRtcConn, java.lang.String token) Occurs when the token expires in 30 seconds.
void	onTransportStats(AgoraRtcConn agoraRtcConn, RtcStats stats) Reports the transport statistics of the connection.
void	onUploadLogResult(AgoraRtcConn agoraRtcConn, java.lang.String requestId, int success, int reason) Reports the user log upload result.
void	onUserAccountUpdated(AgoraRtcConn agoraRtcConn, int uid, java.lang.String userAccount) Occurs when the user account information is updated.
void	onUserJoined(AgoraRtcConn agoraRtcConn, java.lang.String userId) Occurs when a remote user joins the channel.
void	onUserLeft(AgoraRtcConn agoraRtcConn, java.lang.String userId, int reason) Occurs when a remote user leaves the channel.
void	onUserNetworkQuality(AgoraRtcConn agoraRtcConn, java.lang.String userId, int txQuality, int rxQuality) Reports the network quality of each user.
void	onWarning(AgoraRtcConn agoraRtcConn, int warning, java.lang.String msg) Reports a warning during SDK runtime.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultRtcConnObserver

public DefaultRtcConnObserver()

Method Detail

onConnected

public void onConnected(AgoraRtcConn agoraRtcConn,
                        RtcConnInfo connInfo,
                        int reason)

Description copied from interface: IRtcConnObserver

Occurs when the connection state between the SDK and the Agora channel changes to CONNECTION_STATE_CONNECTED(3).

Specified by:

onConnected in interface IRtcConnObserver

Parameters:

agoraRtcConn - The connection object.

connInfo - The information of the connection. See RtcConnInfo.

reason - The reason of the connection state change. See Constants.ConnectionChangedReasonType.

onDisconnected

public void onDisconnected(AgoraRtcConn agoraRtcConn,
                           RtcConnInfo connInfo,
                           int reason)

Description copied from interface: IRtcConnObserver

Occurs when the connection state between the SDK and the Agora channel changes to CONNECTION_STATE_DISCONNECTED(1).

Specified by:

onDisconnected in interface IRtcConnObserver

Parameters:

agoraRtcConn - The connection object.

connInfo - The information of the connection. See RtcConnInfo.

reason - The reason of the connection state change. See Constants.ConnectionChangedReasonType.

onConnecting

public void onConnecting(AgoraRtcConn agoraRtcConn,
                         RtcConnInfo connInfo,
                         int reason)

Description copied from interface: IRtcConnObserver

Occurs when the connection state between the SDK and the Agora channel changes to CONNECTION_STATE_CONNECTING(2).

Specified by:

onConnecting in interface IRtcConnObserver

Parameters:

agoraRtcConn - The connection object.

connInfo - The information of the connection. See RtcConnInfo.

reason - The reason of the connection state change. See Constants.ConnectionChangedReasonType.

onReconnecting

public void onReconnecting(AgoraRtcConn agoraRtcConn,
                           RtcConnInfo connInfo,
                           int reason)

Description copied from interface: IRtcConnObserver

Occurs when the connection state between the SDK and the Agora channel changes to CONNECTION_STATE_RECONNECTING(4).

Specified by:

onReconnecting in interface IRtcConnObserver

Parameters:

agoraRtcConn - The connection object.

connInfo - The information of the connection. See RtcConnInfo.

reason - The reason of the connection state change. See Constants.ConnectionChangedReasonType.

onReconnected

public void onReconnected(AgoraRtcConn agoraRtcConn,
                          RtcConnInfo connInfo,
                          int reason)

Description copied from interface: IRtcConnObserver

Occurs when the connection is reestablished after a disconnection. Deprecated: Use IRtcConnObserver.onConnected(AgoraRtcConn, RtcConnInfo, int) with reason Constants.ConnectionChangedReasonType.CONNECTION_CHANGED_REJOIN_SUCCESS instead.

Specified by:

onReconnected in interface IRtcConnObserver

Parameters:

agoraRtcConn - The connection object.

connInfo - The information of the connection. See RtcConnInfo.

reason - The reason of the connection state change. See Constants.ConnectionChangedReasonType.

onConnectionLost

public void onConnectionLost(AgoraRtcConn agoraRtcConn,
                             RtcConnInfo connInfo)

Description copied from interface: IRtcConnObserver

Occurs when the SDK loses connection with the Agora channel.

Specified by:

onConnectionLost in interface IRtcConnObserver

Parameters:

agoraRtcConn - The connection object.

connInfo - The information of the connection. See RtcConnInfo.

onLastmileQuality

public void onLastmileQuality(AgoraRtcConn agoraRtcConn,
                              int quality)

Description copied from interface: IRtcConnObserver

Reports the quality of the last-mile network. The SDK triggers this callback within two seconds after the app calls startLastmileProbeTest.

Specified by:

onLastmileQuality in interface IRtcConnObserver

Parameters:

agoraRtcConn - The connection object.

quality - Quality of the last-mile network. See Constants.QualityType.

onLastmileProbeResult

public void onLastmileProbeResult(AgoraRtcConn agoraRtcConn,
                                  LastmileProbeResult result)

Description copied from interface: IRtcConnObserver

Reports the result of the last-mile network probe test. The SDK triggers this callback within 30 seconds after the app calls startLastmileProbeTest.

Specified by:

onLastmileProbeResult in interface IRtcConnObserver

Parameters:

agoraRtcConn - The connection object.

result - The result of the last-mile network probe test. See LastmileProbeResult.

onTokenPrivilegeWillExpire

public void onTokenPrivilegeWillExpire(AgoraRtcConn agoraRtcConn,
                                       java.lang.String token)

Description copied from interface: IRtcConnObserver

Occurs when the token expires in 30 seconds. The SDK triggers this callback to remind the app to get a new token before the token privilege expires. Upon receiving this callback, you must generate a new token on your server and call renewToken to pass the new token to the SDK.

Specified by:

onTokenPrivilegeWillExpire in interface IRtcConnObserver

Parameters:

agoraRtcConn - The connection object.

token - The token that expires in 30 seconds.

onTokenPrivilegeDidExpire

public void onTokenPrivilegeDidExpire(AgoraRtcConn agoraRtcConn)

Description copied from interface: IRtcConnObserver

Occurs when the token has expired. Upon receiving this callback, you must generate a new token on your server and call renewToken to pass the new token to the SDK.

Specified by:

onTokenPrivilegeDidExpire in interface IRtcConnObserver

Parameters:

agoraRtcConn - The connection object.

onConnectionFailure

public void onConnectionFailure(AgoraRtcConn agoraRtcConn,
                                RtcConnInfo connInfo,
                                int reason)

Description copied from interface: IRtcConnObserver

Occurs when the connection state between the SDK and the Agora channel changes to CONNECTION_STATE_FAILED(5).

Specified by:

onConnectionFailure in interface IRtcConnObserver

Parameters:

agoraRtcConn - The connection object.

connInfo - The connection information. See RtcConnInfo.

reason - The reason of the connection state change. See Constants.ConnectionChangedReasonType.

onConnectionLicenseValidationFailure

public void onConnectionLicenseValidationFailure(AgoraRtcConn agoraRtcConn,
                                                 RtcConnInfo connInfo,
                                                 int reason)

Description copied from interface: IRtcConnObserver

Occurs when connection license verification fails.

Specified by:

onConnectionLicenseValidationFailure in interface IRtcConnObserver

Parameters:

agoraRtcConn - The connection object.

connInfo - The connection information. See RtcConnInfo.

reason - The reason for the license validation failure.

onUserJoined

public void onUserJoined(AgoraRtcConn agoraRtcConn,
                         java.lang.String userId)

Description copied from interface: IRtcConnObserver

Occurs when a remote user joins the channel. You can get the ID of the remote user in this callback.

Specified by:

onUserJoined in interface IRtcConnObserver

Parameters:

agoraRtcConn - The connection object.

userId - The ID of the remote user who joins the channel.

onUserLeft

public void onUserLeft(AgoraRtcConn agoraRtcConn,
                       java.lang.String userId,
                       int reason)

Description copied from interface: IRtcConnObserver

Occurs when a remote user leaves the channel. You can know why the user leaves the channel through the `reason` parameter.

Specified by:

onUserLeft in interface IRtcConnObserver

Parameters:

agoraRtcConn - The connection object.

userId - The ID of the user who leaves the channel.

reason - The reason why the remote user leaves the channel. See Constants.UserOfflineReasonType.

onTransportStats

public void onTransportStats(AgoraRtcConn agoraRtcConn,
                             RtcStats stats)

Description copied from interface: IRtcConnObserver

Reports the transport statistics of the connection. The SDK triggers this callback once every two seconds when the connection state is CONNECTION_STATE_CONNECTED.

Specified by:

onTransportStats in interface IRtcConnObserver

Parameters:

agoraRtcConn - The connection object.

stats - The transport statistics. See RtcStats.

onChangeRoleSuccess

public void onChangeRoleSuccess(AgoraRtcConn agoraRtcConn,
                                int oldRole,
                                int newRole)

Description copied from interface: IRtcConnObserver

Occurs when the role of the local user changes successfully.

Specified by:

onChangeRoleSuccess in interface IRtcConnObserver

Parameters:

agoraRtcConn - The connection object.

oldRole - The previous role of the local user. See Constants.ClientRoleType.

newRole - The current role of the local user. See Constants.ClientRoleType.

onChangeRoleFailure

public void onChangeRoleFailure(AgoraRtcConn agoraRtcConn)

Description copied from interface: IRtcConnObserver

Occurs when the local user fails to change the user role.

Specified by:

onChangeRoleFailure in interface IRtcConnObserver

Parameters:

agoraRtcConn - The connection object.

onUserNetworkQuality

public void onUserNetworkQuality(AgoraRtcConn agoraRtcConn,
                                 java.lang.String userId,
                                 int txQuality,
                                 int rxQuality)

Description copied from interface: IRtcConnObserver

Reports the network quality of each user. The SDK triggers this callback once every two seconds to report the uplink and downlink network conditions of each user in the channel, including the local user.

Specified by:

onUserNetworkQuality in interface IRtcConnObserver

Parameters:

agoraRtcConn - The connection object.

userId - The ID of the user. If `userId` is empty, this callback reports the network quality of the local user.

txQuality - The uplink network quality. See Constants.QualityType.

rxQuality - The downlink network quality. See Constants.QualityType.

onNetworkTypeChanged

public void onNetworkTypeChanged(AgoraRtcConn agoraRtcConn,
                                 int type)

Description copied from interface: IRtcConnObserver

Occurs when the network type is changed.

Specified by:

onNetworkTypeChanged in interface IRtcConnObserver

Parameters:

agoraRtcConn - The connection object.

type - The current network type. See Constants.NetworkType.

onApiCallExecuted

public void onApiCallExecuted(AgoraRtcConn agoraRtcConn,
                              int err,
                              java.lang.String api,
                              java.lang.String result)

Description copied from interface: IRtcConnObserver

Reports the result of an API call execution. This is usually used for asynchronous operations.

Specified by:

onApiCallExecuted in interface IRtcConnObserver

Parameters:

agoraRtcConn - The connection object.

err - The error code returned by the API call. See

api - The API name that was called.

result - The result string of the API call.

onContentInspectResult

public void onContentInspectResult(AgoraRtcConn agoraRtcConn,
                                   int result)

Description copied from interface: IRtcConnObserver

Reports the result of content inspection.

Specified by:

onContentInspectResult in interface IRtcConnObserver

Parameters:

agoraRtcConn - The connection object.

result - The content inspection result. See Constants.ContentInspectResult.

onSnapshotTaken

public void onSnapshotTaken(AgoraRtcConn agoraRtcConn,
                            java.lang.String channel,
                            int uid,
                            java.lang.String filePath,
                            int width,
                            int height,
                            int errCode)

Description copied from interface: IRtcConnObserver

Occurs when a snapshot is successfully taken.

Specified by:

onSnapshotTaken in interface IRtcConnObserver

Parameters:

agoraRtcConn - The connection object.

channel - The channel name.

uid - The user ID. If the user ID is 0, the snapshot is for the local user.

filePath - The local path of the snapshot file.

width - The width (pixels) of the snapshot.

height - The height (pixels) of the snapshot.

errCode - The error code. 0 means success.

onError

public void onError(AgoraRtcConn agoraRtcConn,
                    int error,
                    java.lang.String msg)

Description copied from interface: IRtcConnObserver

Reports an error during SDK runtime.

Specified by:

onError in interface IRtcConnObserver

Parameters:

agoraRtcConn - The connection object.

error - The error code. See Constants.ErrorCodeType.

msg - The error message.

onWarning

public void onWarning(AgoraRtcConn agoraRtcConn,
                      int warning,
                      java.lang.String msg)

Description copied from interface: IRtcConnObserver

Reports a warning during SDK runtime.

Specified by:

onWarning in interface IRtcConnObserver

Parameters:

agoraRtcConn - The connection object.

warning - The warning code.

msg - The warning message.

onChannelMediaRelayStateChanged

public void onChannelMediaRelayStateChanged(AgoraRtcConn agoraRtcConn,
                                            int state,
                                            int code)

Description copied from interface: IRtcConnObserver

Occurs when the state of the channel media relay changes.

Specified by:

onChannelMediaRelayStateChanged in interface IRtcConnObserver

Parameters:

agoraRtcConn - The connection object.

state - The state code.

code - The error code.

onLocalUserRegistered

public void onLocalUserRegistered(AgoraRtcConn agoraRtcConn,
                                  int uid,
                                  java.lang.String userAccount)

Description copied from interface: IRtcConnObserver

Occurs when the local user successfully registers a user account by calling the joinChannelWithUserAccount method. This callback reports the user ID and user account of the local user.

Specified by:

onLocalUserRegistered in interface IRtcConnObserver

Parameters:

agoraRtcConn - The connection object.

uid - The ID of the local user.

userAccount - The user account of the local user.

onUserAccountUpdated

public void onUserAccountUpdated(AgoraRtcConn agoraRtcConn,
                                 int uid,
                                 java.lang.String userAccount)

Description copied from interface: IRtcConnObserver

Occurs when the user account information is updated. Technical Preview, please do not depend on this event.

Specified by:

onUserAccountUpdated in interface IRtcConnObserver

Parameters:

agoraRtcConn - The connection object.

uid - The ID of the local user.

userAccount - The user account of the local user.

onStreamMessageError

public void onStreamMessageError(AgoraRtcConn agoraRtcConn,
                                 java.lang.String userId,
                                 int streamId,
                                 int code,
                                 int missed,
                                 int cached)

Description copied from interface: IRtcConnObserver

Reports the error that occurs when receiving data stream messages.

Specified by:

onStreamMessageError in interface IRtcConnObserver

Parameters:

agoraRtcConn - The connection object.

userId - The ID of the user sending the data stream.

streamId - The ID of the data stream.

code - The error code.

missed - The number of lost messages.

cached - The number of incoming cached messages when the data stream is interrupted.

onEncryptionError

public void onEncryptionError(AgoraRtcConn agoraRtcConn,
                              int errorType)

Description copied from interface: IRtcConnObserver

Occurs when an encryption error happens during the transmission.

Specified by:

onEncryptionError in interface IRtcConnObserver

Parameters:

agoraRtcConn - The connection object.

errorType - The type of the encryption error. See Constants.EncryptionErrorType.

onUploadLogResult

public void onUploadLogResult(AgoraRtcConn agoraRtcConn,
                              java.lang.String requestId,
                              int success,
                              int reason)

Description copied from interface: IRtcConnObserver

Reports the user log upload result.

Specified by:

onUploadLogResult in interface IRtcConnObserver

Parameters:

agoraRtcConn - The connection object.

requestId - Request ID of the upload.

success - Whether the upload was successful.

reason - Reason for the upload result. 0: OK, 1: Network Error, 2: Server Error. See Constants.UploadErrorReason.