CONNECTION_STATE_TYPE | Video SDK v1.3.1_3.1 API Reference for Cocos Creator

Connection states.

Index

Enumeration members

CONNECTION_STATE_CONNECTED

CONNECTION_STATE_CONNECTED: = 3

3: The SDK is connected to Agora's edge server and has joined a channel. You can now publish or subscribe to a media stream in the channel.

If the connection to the channel is lost because, for example, if the network is down or switched, the SDK automatically tries to reconnect and triggers:

The onConnectionInterrupted callback (deprecated).
The onConnectionStateChanged callback and switches to the CONNECTION_STATE_RECONNECTING state.

CONNECTION_STATE_CONNECTING

CONNECTION_STATE_CONNECTING: = 2

2: The SDK is connecting to Agora's edge server.

When the application calls the joinChannel method, the SDK starts to establish a connection to the specified channel, triggers the onConnectionStateChanged callback, and switches to the CONNECTION_STATE_CONNECTING state.
When the SDK successfully joins the channel, it triggers the onConnectionStateChanged callback and switches to the CONNECTION_STATE_CONNECTED state.
After the SDK joins the channel and when it finishes initializing the media engine, the SDK triggers the onJoinChannelSuccess callback.

CONNECTION_STATE_DISCONNECTED

CONNECTION_STATE_DISCONNECTED: = 1

1: The SDK is disconnected from Agora's edge server.

This is the initial state before calling the joinChannel method.
The SDK also enters this state when the application calls the leaveChannel method.

CONNECTION_STATE_FAILED

CONNECTION_STATE_FAILED: = 5

5: The SDK fails to connect to Agora's edge server or join the channel.

You must call the leaveChannel method to leave this state, and call the joinChannel method again to rejoin the channel.

If the SDK is banned from joining the channel by Agora's edge server (through the RESTful API), the SDK triggers the onConnectionBanned (deprecated) and onConnectionStateChanged callbacks.

CONNECTION_STATE_RECONNECTING

CONNECTION_STATE_RECONNECTING: = 4

4: The SDK keeps rejoining the channel after being disconnected from a joined channel because of network issues.

If the SDK cannot rejoin the channel within 10 seconds after being disconnected from Agora's edge server, the SDK triggers the onConnectionLost callback, stays in the CONNECTION_STATE_RECONNECTING state, and keeps rejoining the channel.
If the SDK fails to rejoin the channel 20 minutes after being disconnected from Agora's edge server, the SDK triggers the onConnectionStateChanged callback, switches to the CONNECTION_STATE_FAILED state, and stops rejoining the channel.