Enumeration ConnectionChangedReasonType

Reasons causing the change of the connection state.

Enumeration Members

ConnectionChangedBannedByServer: 3

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.

ConnectionChangedClientIpAddressChanged: 13

13: The IP address of the client has changed, possibly because the network type, IP address, or port has been changed.

ConnectionChangedClientIpAddressChangedByUser: 18

18: The local IP address was changed by the user.

ConnectionChangedConnecting: 0

0: The SDK is connecting to the Agora edge server.

ConnectionChangedEchoTest: 17

17: The connection state changes due to the echo test.

ConnectionChangedInterrupted: 2

2: The connection between the SDK and the Agora edge server is interrupted.

ConnectionChangedInvalidAppId: 6

6: The connection failed because the App ID is not valid. Please rejoin the channel with a valid App ID.

ConnectionChangedInvalidChannelName: 7

7: The connection failed since channel name is not valid. Rejoin the channel with a valid channel name.

ConnectionChangedInvalidToken: 8

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 to join the channel is inconsistent with the uid passed in when generating the token.

ConnectionChangedJoinFailed: 4

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.

ConnectionChangedJoinSuccess: 1

1: The SDK has joined the channel successfully.

ConnectionChangedKeepAliveTimeout: 14

14: Timeout for the keep-alive of the connection between the SDK and the Agora edge server. The connection state changes to .

ConnectionChangedLeaveChannel: 5

5: The SDK has left the channel.

ConnectionChangedLost: 16

16: The connection between the SDK and the server is lost.

ConnectionChangedRejectedByServer: 10

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, 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.

ConnectionChangedRejoinSuccess: 15

15: The user has rejoined the channel successfully.

ConnectionChangedRenewToken: 12

12: The connection state changed because the token is renewed.

ConnectionChangedSameUidLogin: 19

19: The user joined the same channel from different devices with the same UID.

ConnectionChangedSettingProxyServer: 11

11: The connection state changed to reconnecting because the SDK has set a proxy server.

ConnectionChangedTokenExpired: 9

9: The connection failed since token is expired.

ConnectionChangedTooManyBroadcasters: 20

20: The number of hosts in the channel has reached the upper limit.

Generated using TypeDoc