Indicates the adaption of current media quality, i.e., video bitrate or video framerate. The quality of the local video stays the same.

The quality improves because the network bandwidth increases.

The quality worsens because the network bandwidth decreases.

1: The last-mile probe result is complete.

2: The last-mile network probe test is incomplete and the bandwidth estimation is not available, probably due to limited test resources.

3: The last-mile network probe test is not carried out, probably due to poor network conditions.

0: The quality is unknown.

1: The quality is excellent.

2: The quality is quite good, but the bitrate may be slightly lower than excellent.

3: Users can feel the communication slightly impaired.

4: Users can communicate not very smoothly.

5: The quality is so bad that users can barely communicate.

6: The network is disconnected and users cannot communicate at all.

8: The specified view is invalid. Specify a view when using the video call function.

16: Fails to initialize the video function, possibly caused by a lack of resources. The users cannot see the video while the voice communication is not affected.

20: The request is pending, usually due to some module not being ready, and the SDK postponed processing the request.

103: No channel resources are available. Maybe because the server cannot allocate any channel resource.

104: A timeout occurs when looking up the channel. When joining a channel, the SDK looks up the specified channel. This warning usually occurs when the network condition is too poor for the SDK to connect to the server.

Deprecated:

This error code is deprecated. Use CONNECTION_CHANGED_REJECTED_BY_SERVER(10) in the onConnectionStateChanged callback instead. 105: The server rejects the request to look up the channel. The server cannot process this request or the request is illegal.

106: A timeout occurs when opening the channel. Once the specific channel is found, the SDK opens the channel. This warning usually occurs when the network condition is too poor for the SDK to connect to the server.

107: The server rejects the request to open the channel. The server cannot process this request or the request is illegal.

111: A timeout occurs when switching to the live video.

118: A timeout occurs when setting the user role in the Live Broadcast profile.

119: The user role is unauthorized.

121: The ticket to open the channel is invalid.

122: Try connecting to another server.

701: An error occurs in opening the audio mixing file.

1014: Audio Device Module: A warning occurs in the playback device.

1016: Audio Device Module: A warning occurs in the recording device.

1019: Audio Device Module: No valid audio data is collected.

1031: Audio Device Module: The recorded audio volume is too low.

1032: Audio Device Module: The playback audio volume is too low.

1033: Audio Device Module: The recording device is busy.

1051: Audio Device Module: Howling is detected.

1052: Audio Device Module: The device is in the glitch state.

1053: Audio Device Module: The underlying audio settings have changed.

0: No error occurs.

1: A general error occurs (no specified reason).

2: An invalid parameter is used. For example, the specific channel name includes illegal characters.

3: The SDK module is not ready. We recommend the following methods to solve this error:

• Check the audio device.
• Check the completeness of the app.
• Re-initialize the SDK.

4: The SDK does not support this function.

5: The request is rejected. This is for internal SDK use only, and is not returned to the app through any API method or callback.

6: The buffer size is not big enough to store the returned data.

7: The SDK is not initialized before calling this method.

9: No permission exists. This is for internal SDK use only, and is not returned to the app through any API method or callback.

10: An API timeout occurs. Some API methods require the SDK to return the execution result, and this error occurs if the request takes too long for the SDK to process.

11: The request is canceled. This is for internal SDK use only, and is not returned to the app through any API method or callback.

12: This method is called too often. This is for internal SDK use only, and is not returned to the app through any API method or callback.

13: The SDK fails to bind to the network socket. This is for internal SDK use only, and is not returned to the app through any API method or callback.

14: The network is unavailable. This is for internal SDK use only, and is not returned to the app through any API method or callback.

15: No network buffers are available. This is for internal SDK use only, and is not returned to the app through any API method or callback.

17: The request to join the channel is rejected. This error usually occurs when the user is already in the channel and still calls the joinChannel method to join the channel.

18: The request to leave the channel is rejected. This error usually occurs:

• When the user has left the channel and still calls the leaveChannel method to leave the channel. This error stops once the user stops calling this method.
• When the user calls the leaveChannel method before joining a channel. No extra operation is needed.

19: The resources are occupied and cannot be reused.

101: The specified App ID is invalid. Please try to rejoin the channel with a valid App ID.

102: The specified channel name is invalid. Please try to rejoin the channel with a valid channel name.

109: The token expired due to one of the following reasons:

• Authorized Timestamp expired: The timestamp is represented by the number of seconds elapsed since 1/1/1970. The user can use the token to access the Agora service within five minutes after the token is generated. If the user does not access the Agora service after five minutes, this token will no longer be valid.
• Call Expiration Timestamp expired: The timestamp is the exact time when a user can no longer use the Agora service (for example, when a user is forced to leave an ongoing call). When a value is set for the Call Expiration Timestamp, it does not mean that the Dynamic Key will expire, but that the user will be banned from the channel.

Deprecated:

From v2.4.1. Use CONNECTION_CHANGED_TOKEN_EXPIRED(9) in the onConnectionStateChanged callback instead.

110: The token is invalid due to one of the following reasons:

• The App Certificate for the project is enabled in Dashboard, but the user is still using the App ID. Once the App Certificate is enabled, the user must use a token.
• The uid is mandatory, and users must set the same uid as the one set in the joinChannel method.

Deprecated:

From v2.4.1. Use CONNECTION_CHANGED_INVALID_TOKEN(8) in the onConnectionStateChanged callback instead.

111: The Internet connection is interrupted. This applies to the Agora Web SDK only.

112: The Internet connection is lost. This applies to the Agora Web SDK only.

113: The user is not in the channel when calling the sendStreamMessage method.

114: The size of the sent data is over 1024 bytes when the user calls the sendStreamMessage method.

115: The bitrate of the sent data exceeds the limit of 6 Kbps when the user calls the sendStreamMessage method.

116: Too many data streams (over five streams) are created when the user calls the createDataStream method.

120: Decryption fails. The user may have used a different encryption password to join the channel. Check your settings or try rejoining the channel.

123: The client is banned by the server.

124: Incorrect watermark file parameter.

125: Incorrect watermark file path.

126: Incorrect watermark file format.

127: Incorrect watermark file information.

128: Incorrect watermark file data format.

129: An error occurs in reading the watermark file.

130: Encryption is enabled when the user calls the addPublishStreamUrl method (CDN live streaming does not support encrypted streams).

151: CDN related errors. Remove the original URL address and add a new one by calling the removePublishStreamUrl and addPublishStreamUrl methods.

152: The host manipulates more than 10 URLs. Delete the unnecessary URLs before adding new ones.

153: The host manipulates other hosts' URLs. Check your app logic.

154: An error occurs in Agora's streaming server. Call the addPublishStreamUrl method to publish the streaming again.

155: The server fails to find the stream.

156: The format of the RTMP stream URL is not supported. Check whether the URL format is correct.

1001: Fails to load the media engine.

1002: Fails to start the call after enabling the media engine.

1003: Fails to start the camera.

Deprecated:

From v2.4.1. Use LOCAL_VIDEO_STREAM_ERROR_CAPTURE_FAILURE(4) in the onLocalVideoStateChanged callback instead.

1004: Fails to start the video rendering module.

1005: Audio Device Module: A general error occurs in the Audio Device Module (no classified reason). Check if the audio device is used by another application, or try rejoining the channel.

1006: Audio Device Module: An error occurs in using the Java resources.

1007: Audio Device Module: An error occurs in setting the sampling frequency.

1008: Audio Device Module: An error occurs in initializing the playback device.

1009: Audio Device Module: An error occurs in starting the playback device.

1010: Audio Device Module: An error occurs in stopping the playback device.

1011: Audio Device Module: An error occurs in initializing the recording device.

1012: Audio Device Module: An error occurs in starting the recording device.

1013: Audio Device Module: An error occurs in stopping the recording device.

1015: Audio Device Module: A playback error occurs. Check your playback device or try rejoining the channel.

1017: Audio Device Module: A recording error occurs.

1018: Audio Device Module: Fails to record.

1022: Audio Device Module: An error occurs in initializing the loopback device.

1023: Audio Device Module: An error occurs in starting the loopback device.

1030: Audio Routing: Fails to route the audio to the connected Bluetooth device. The default route is used.

1359: Audio Device Module: No recording device exists.

1360: Audio Device Module: No playback device exists.

1501: Video Device Module: The camera is unauthorized.

1600: Video Device Module: Unknown error.

1601: Video Device Module: Error in initializing the video encoder. This is a serious error and you can try to rejoin the channel.

1602: Video Device Module: Error in the video encoder. This is a serious error and you can try to rejoin the channel.

Deprecated:

This error code is deprecated. 1603: Video Device Module: Error in setting the video encoder.

Deprecated:

0: Resolution: 160 × 120; Frame rate: 15 fps; Bitrate: 65 Kbps

Deprecated:

2: Resolution: 120 × 120; Frame rate: 15 fps; Bitrate 50 Kbps

Deprecated:

10: Resolution: 320 × 180; Frame rate: 15 fps; Bitrate: 140 Kbps

Deprecated:

12: Resolution: 180 × 180; Frame rate: 15 fps; Bitrate: 100 Kbps

Deprecated:

13: Resolution: 240 × 180; Frame rate: 15 fps; Bitrate: 120 Kbps

Deprecated:

20: Resolution: 320 × 240; Frame rate: 15 fps; Bitrate: 200 Kbps

Deprecated:

22: Resolution: 240 × 240; Frame rate: 15 fps; Bitrate: 140 Kbps

Deprecated:

23: Resolution: 424 × 240; Frame rate: 15 fps; Bitrate: 220 Kbps

Deprecated:

30: Resolution: 640 × 360; Frame rate: 15 fps; Bitrate: 400 Kbps

Deprecated:

32: Resolution: 360 × 360; Frame rate: 15 fps; Bitrate: 260 Kbps

Deprecated:

33: Resolution: 640 × 360; Frame rate: 30 fps; Bitrate: 600 Kbps

Deprecated:

35: Resolution: 360 × 360; Frame rate: 30 fps; Bitrate: 400 Kbps

Deprecated:

36: Resolution: 480 × 360; Frame rate: 15 fps; Bitrate: 320 Kbps

Deprecated:

37: Resolution: 480 × 360; Frame rate: 30 fps; Bitrate: 490 Kbps

Deprecated:

38: Resolution: 640 × 360; Frame rate: 15 fps; Bitrate: 800 Kbps

Note

This profile applies to the Live Broadcast profile profile only.

Deprecated:

39: Resolution: 640 × 360; Frame rate: 24 fps; Bitrate: 800 Kbps

Note

This profile applies to the Live Broadcast profile profile only.

Deprecated:

100: Resolution: 640 × 360; Frame rate: 24 fps; Bitrate: 1000 Kbps

Note

This profile applies to the Live Broadcast profile profile only.

Deprecated:

40: Resolution: 640 × 480; Frame rate: 15 fps; Bitrate: 500 Kbps

Deprecated:

42: Resolution: 480 × 480; Frame rate: 15 fps; Bitrate: 400 Kbps

Deprecated:

43: Resolution: 640 × 480; Frame rate: 30 fps; Bitrate: 750 Kbps

Deprecated:

45: Resolution: 480 × 480; Frame rate: 30 fps; Bitrate: 600 Kbps

Deprecated:

47: Resolution: 848 × 480; Frame rate: 15 fps; Bitrate: 610 Kbps

Deprecated:

48: Resolution: 848 × 480; Frame rate: 30 fps; Bitrate: 930 Kbps

Deprecated:

49: Resolution: 640 × 480; Frame rate: 10 fps; Bitrate: 400 Kbps

Deprecated:

50: Resolution: 1280 × 720; Frame rate: 15 fps; Bitrate: 1130 Kbps

Deprecated:

52: Resolution: 1280 × 720; Frame rate: 30 fps; Bitrate: 1710 Kbps

Deprecated:

54: Resolution: 960 × 720; Frame rate: 15 fps; Bitrate: 910 Kbps

Deprecated:

55: Resolution: 960 × 720; Frame rate: 30 fps; Bitrate: 1380 Kbps

Deprecated:

Default video profile: Resolution: 640 × 360; Frame rate: 15 fps; Bitrate: 400 Kbps

0: Default audio profile.

• In the Communication profile, the default audio profile is SPEECH STANDARD(1).
• In the Live Broadcast profile, the default audio profile is MUSIC STANDARD(2).

1: A sample rate of 32 kHz, audio encoding, mono, and a bitrate of up to 18 Kbps.

2: A sample rate of 48 kHz, music encoding, mono, and a bitrate of up to 48 Kbps.

3: A sample rate of 48 kHz, music encoding, stereo, and a bitrate of up to 56 Kbps.

4: A sample rate of 48 kHz, music encoding, mono, and a bitrate of up to 128 Kbps.

5: A sample rate of 48 kHz, music encoding, stereo, and a bitrate of up to 192 Kbps.

0: Default audio application scenario.

1: Entertainment scenario supporting voice during gameplay.

2: Education scenario prioritizing smoothness and stability.

3: Live gaming scenario enabling the gaming audio effects in the speaker mode in a live broadcast scenario.

4: Showroom scenario optimizing the audio quality with professional external equipment.

5: Gaming scenario.

0: 31 Hz

1: 62 Hz

2: 125 Hz

3: 250 Hz

4: 500 Hz

5: 1 kHz

6: 2 kHz

7: 4 kHz

8: 8 kHz

9: 16 kHz

0: Level of the dry signal (-20 to 10 dB).

1: Level of the early reflection signal (wet signal) (-20 to 10 dB).

2: Room size of the reflection (0 to 100 dB).

3: Length of the initial delay of the wet signal (0 to 200 ms).

4: Strength of the late reverberation (0 to 100).

0: the original voice (no local voice change).

1: an old man's voice.

2: a little boy's voice.

3: a little girl's voice.

4: Zhu Bajie's voice (Zhu Bajie is a character from Journey to the West who has a voice like a growling bear).

5: ethereal vocal effects.

6: Hulk's voice.

0: the original voice (no local voice reverberation).

1: pop music.

2: R&B.

3: rock music.

4: hip-hop.

5: pop concert.

6: karaoke.

7: recording studio.

0: The channel profile is Communication.

This is used in one-on-one calls or group calls, where all users in the channel can talk freely.

1: The channel profile is Live Broadcast.

Host and audience roles that can be set by calling the setClientRole method. The host sends and receives voice/video, while the audience only receives voice/video.

2: The channel profile is Gaming.

Any user in the channel can talk freely. This mode uses the codec with low-power consumption and low bitrate by default.

Note

This profile applies to the Agora Gaming SDK only.

1: The host in a live broadcast.

2: The audience in a live broadcast.

0: The user quits the call.

1: The SDK timed out and the user dropped offline because it has not received any data packet for a period of time. If a user quits the call and the message is not passed to the SDK (due to an unreliable channel), the SDK assumes the user has dropped offline.

2: The client role switches from a host to an audience.

0: The external video stream imports successfully.

1: The external video stream already exists.

2: The external video stream import is unauthorized.

3: An import external video stream timeout.

4: The external video stream fails to import.

5: The external video stream stops importing successfully.

6: No external video stream is found.

7: The external video stream to be stopped importing is unauthorized.

8: Stop importing external video stream timeout.

9: Stop importing external video stream failed.

10: The external video stream is corrupted.

0: The quality report is in JSON format.

1: The quality report is in HTML format.

1: Uniformly scale the video until it fills the visible boundaries (cropped). One dimension of the video may have clipped contents.

2: Uniformly scale the video until one of its dimension fits the boundary (zoomed to fit). Areas that are not filled due to the disparity in the aspect ratio are filled with black.

Deprecated:

3: Adaptive mode: If both callers use the same screen orientation, such as both use vertical screens or both use horizontal screens, the RENDER_MODE_HIDDEN mode applies; if they use different screen orientations, such as one vertical and one horizontal, the RENDER_MODE_FIT mode applies.

0: The default mirror mode (the mode set by the SDK).

1: Enable the mirror mode.

2: Disable the mirror mode

0: Do not output any log.

0x80f: Output all API logs. Set your log filter as DEBUG if you want to get the most complete log file.

0x0f: Output logs of the CRITICAL, ERROR, WARNING, and INFO level. We recommend setting your log filter as this level.

0x0e: Output logs of the CRITICAL, ERROR, and WARNING level.

0x0c: Output logs of the CRITICAL and ERROR level.

0x08: Output logs of the CRITICAL level.

-1: Default audio route.

0: Headset.

1: Earpiece.

2: Headset with no microphone.

3: Speakerphone.

4: Loudspeaker.

5: Bluetooth headset.

0: High-stream (high-resolution, high-bitrate) video.

1: Low-stream (low-resolution, low-bitrate) video.

High Priority, if you set a user with high priority, then streams of this user will have high priority than streams of other users with normal default priority. i.e., the SDK will take priority into account when deciding which user's stream need to fallback when network congestion occurs.

Default priority.

0: Hardware encoder.

1: Software encoder.

0: Read-only mode. Users only read the Agora Audio Frame data without modifying anything. For example, when users acquire data with the Agora SDK and push RTMP streams by themselves.

1: Write-only mode. Users replace the Agora Audio Frame data with their own data and pass it to the SDK for encoding. For example, when users acquire data by themselves.

2: Read and write mode. Users read the data from the Agora Audio Frame, modify it and then play it. For example, when users have their own sound-effect processing module and want to do voice pre-processing, such as a voice change.

701: the SDK cannot open the audio mixing file.

702: the SDK opens the audio mixing file too frequently.

703: the audio mixing file playback is interrupted.

710: the audio mixing file is playing.

711: the audio mixing file pauses playing.

713: the audio mixing file stops playing.

714: an exception occurs when playing the audio mixing file. See the errorCode for details.

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 app calls the leaveChannel method.

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

• When the app 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 a user successfully joins a channel, the SDK 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.

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, the network is down or switched, the SDK triggers:

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

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

• If the SDK cannot join the channel within 10 seconds after being disconnected from Agora's edge server, the SDK triggers the onConnectionLost (deprecated) 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 keeps rejoining the channel.

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 the Agora server (through the RESTful API), the SDK triggers the onConnectionBanned and onConnectionStateChanged callbacks.

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

1: The SDK has joined the channel successfully.

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

3: The connection between the SDK and Agora's edge server is banned by Agora's edge server.

4: The SDK fails to join the channel for more than 20 minutes and stops reconnecting to the channel.

5: The SDK has left the channel.

6: The specified App ID is invalid. Try to rejoin the channel with a valid App ID.

7: The specified channel name is invalid. Try to rejoin the channel with a valid channel name.

8: The generated token is invalid probably due to the following reasons:

• The App Certificate for the project is enabled in Dashboard, but you do not use the token.
• The uid that you specify in the joinChannel method is different from the uid that you pass for generating the token.

9: The token has expired. Generate a new token from your server.

10: The user is banned by the server.

11: The SDK tries to reconnect after setting a proxy server.

12: The token renews.

13: The client IP address has changed, probably due to a change of the network type, IP address, or network port.

-1: The network type is unknown.

0: The SDK disconnects from the network.

1: The network type is LAN.

2: The network type is Wi-Fi (including hotspots).

3: The network type is mobile 2G.

4: The network type is mobile 3G.

5: The network type is mobile 4G.

Deprecated:

1: Binds the RTMP stream lifecycle to the channel lifecycle. If all hosts leave the channel, CDN live streaming stops after 30 seconds.

Deprecated:

2: Binds the RTMP stream lifecycle to the owner of the RTMP stream. If the owner leaves the channel, CDN live streaming stops immediately.

0: Low quality. The file size is around 1.2 MB after 10 minutes of recording.

1: Medium quality. The file size is around 2 MB after 10 minutes of recording.

2: High quality. The file size is around 3.75 MB after 10 minutes of recording.

0: None.

1: Audio only.

2: Video only.

3: Audio and video.

0: No fallback behavior for the local/remote streams when the uplink/downlink network condition is poor. The quality of the stream is not guaranteed.

1: Under poor downlink network conditions, the remotely subscribed stream falls back to the low-stream (low-resolution and low-bitrate) video. You can only set this option in the setRemoteSubscribeFallbackOption method. Nothing happens when you set this in the setLocalPublishFallbackOption method.

2:

• Under poor uplink network conditions, the locally published stream falls back audio only.
• Under poor downlink network conditions, the remotely subscribed stream first falls back to the low-stream (low-resolution and low-bitrate) video; and then to an audio-only stream if the network condition deteriorates.

0: The local video is in the initial state.

1: The local video capturer starts successfully.

2: The first local video frame encodes successfully.

3: The local video fails to start.

0: The local video is normal.

1: No specified reason for the local video failure.

2: No permission to use the local video device.

3: The local video capturer is in use.

4: The local video capture fails. Check whether the capturer is working properly.

5: The local video encoding fails.

0: The RTMP streaming has not started or has ended.

1: The SDK is connecting to Agora's streaming server and the RTMP server. This state is triggered after you call the addPublishStreamUrl method.

2: The RTMP streaming publishes. The SDK successfully publishes the RTMP streaming and returns this state.

3: The RTMP streaming is recovering. When exceptions occur to the CDN, or the streaming is interrupted, the SDK attempts to resume RTMP streaming and returns this state.

• If the SDK successfully resumes the streaming, RTMP_STREAM_PUBLISH_STATE_RUNNING(2) returns.
• If the streaming does not resume within 60 seconds or server errors occur, RTMP_STREAM_PUBLISH_STATE_FAILURE(4) returns. You can also reconnect to the server by calling the removePublishStreamUrl and addPublishStreamUrl methods.

4: The RTMP streaming fails. See the errCode parameter for the detailed error information. You can also call the addPublishStreamUrl method to publish the RTMP streaming again.

0: The RTMP streaming publishes successfully.

1: Invalid argument used. If, for example, you do not call the setLiveTranscoding method to configure the LiveTranscoding parameters before calling the addPublishStreamUrl method, the SDK returns this error. Check whether you set the parameters in the setLiveTranscoding method properly.

2: The RTMP streaming is encrypted and cannot be published.

3: Timeout for the RTMP streaming. Call the ddPublishStreamUrl method to publish the streaming again.

4: An error occurs in Agora's streaming server. Call the addPublishStreamUrl method to publish the streaming again.

5: An error occurs in the RTMP server.

6: The RTMP streaming publishes too frequently.

7: The host publishes more than 10 URLs. Delete the unnecessary URLs before adding new ones.

8: The host manipulates other hosts' URLs. Check your app logic.

9: Agora's server fails to find the RTMP streaming.