CONNECTION_CHANGED_REASON_TYPE

Reasons causing the change of the connection state.

Enumerator

CONNECTION_CHANGED_CONNECTING
0: The SDK is connecting to the Agora edge server.
CONNECTION_CHANGED_JOIN_SUCCESS
1: The SDK has joined the channel successfully.
CONNECTION_CHANGED_INTERRUPTED
2: The connection between the SDK and the Agora edge server is interrupted.
CONNECTION_CHANGED_BANNED_BY_SERVER
3: The connection between the SDK and the Agora edge server is banned by the Agora edge server. This error occurs when the user is kicked out of the channel by the server.
CONNECTION_CHANGED_JOIN_FAILED
4: The SDK fails to join the channel. When the SDK fails to join the channel for more than 20 minutes, this error occurs and the SDK stops reconnecting to the channel.
CONNECTION_CHANGED_LEAVE_CHANNEL
5: The SDK has left the channel.
CONNECTION_CHANGED_INVALID_APP_ID
6: The connection failed because the App ID is not valid. Please rejoin the channel with a valid App ID.
CONNECTION_CHANGED_INVALID_CHANNEL_NAME
7: The connection failed since channel name is not valid. Rejoin the channel with a valid channel name.
CONNECTION_CHANGED_INVALID_TOKEN
8: The connection failed because the token is not valid. Possible reasons are as follows:
  • The App Certificate for the project is enabled in Agora Console, but you do not use a token when joining the channel. If you enable the App Certificate, you must use a token to join the channel.
  • The uid specified when calling joinChannel [2/2] to join the channel is inconsistent with the uid passed in when generating the token.
CONNECTION_CHANGED_TOKEN_EXPIRED
9: The connection failed since token is expired.
CONNECTION_CHANGED_REJECTED_BY_SERVER
10: The connection is rejected by server. Possible reasons are as follows:
  • The user is already in the channel and still calls a method, for example, joinChannel [2/2], to join the channel. Stop calling this method to clear this error.
  • The user tries to join a channel while a test call is in progress. The user needs to join the channel after the call test ends.
CONNECTION_CHANGED_SETTING_PROXY_SERVER
11: The connection state changed to reconnecting because the SDK has set a proxy server.
CONNECTION_CHANGED_RENEW_TOKEN
12: The connection state changed because the token is renewed.
CONNECTION_CHANGED_CLIENT_IP_ADDRESS_CHANGED
13: The IP address of the client has changed, possibly because the network type, IP address, or port has been changed.
CONNECTION_CHANGED_KEEP_ALIVE_TIMEOUT
14: Timeout for the keep-alive of the connection between the SDK and the Agora edge server. The SDK tries to reconnect to the server automatically.
CONNECTION_CHANGED_REJOIN_SUCCESS
15: The user has rejoined the channel successfully.
CONNECTION_CHANGED_LOST
16: The connection between the SDK and the server is lost.
CONNECTION_CHANGED_ECHO_TEST
17: The connection state changes due to the echo test.
CONNECTION_CHANGED_CLIENT_IP_ADDRESS_CHANGED_BY_USER
18: The local IP address was changed by the user.
CONNECTION_CHANGED_SAME_UID_LOGIN
19: The user joined the same channel from different devices with the same UID.
CONNECTION_CHANGED_TOO_MANY_BROADCASTERS
20: The number of hosts in the channel has reached the upper limit.