Enumeration ErrorCodeType

Error codes.

An error code indicates that the SDK encountered an unrecoverable error that requires application intervention. For example, an error is returned when the camera fails to open, and the app needs to inform the user that the camera cannot be used.

Enumeration Members

ErrAborted: 20

20: The request is abandoned by the SDK, possibly because the request has been sent too frequently.

ErrAdmGeneralError: 1005

1005: A general error occurs (no specified reason). Check whether the audio device is already in use by another app, or try rejoining the channel.

ErrAdmInitPlayout: 1008

1008: An error occurs when initializing the playback device. Check whether the playback device is already in use by another app, or try rejoining the channel.

ErrAdmInitRecording: 1011

1011: An error occurs when initializing the recording device. Check the recording device, or try rejoining the channel.

ErrAdmStartPlayout: 1009

1009: An error occurs when starting the playback device. Check the playback device.

ErrAdmStartRecording: 1012

1012: An error occurs when starting the recording device. Check the recording device.

ErrAdmStopPlayout: 1010

1010: An error occurs when stopping the playback device.

ErrAdmStopRecording: 1013

1013: An error occurs when stopping the recording device.

ErrAlreadyInUse: 19

19: Resources are already in use.

ErrBitrateLimit: 115

115: The data bitrate exceeds 6 KB/s when calling the sendStreamMessage method.

ErrBufferTooSmall: 6

6: The buffer size is insufficient to store the returned data.

ErrCertRaw: 157

1001: The SDK fails to load the media engine.

ErrClientIsBannedByServer: 123

123: The user is banned from the server.

ErrConnectionInterrupted: 111

111: The network connection is interrupted. The SDK triggers this callback when it loses connection with the server for more than four seconds after the connection is established.

ErrConnectionLost: 112

112: The network connection is lost. Occurs when the SDK cannot reconnect to Agora's edge server 10 seconds after its connection to the server is interrupted.

ErrDatastreamDecryptionFailed: 122

122: Data streams decryption fails. The user might use an incorrect password to join the channel. Check the entered password, or tell the user to try rejoining the channel.

ErrDecryptionFailed: 120

120: Media streams decryption fails. The user might use an incorrect password to join the channel. Check the entered password, or tell the user to try rejoining the channel.

ErrEncryptedStreamNotAllowedPublish: 130

130: The SDK does not support pushing encrypted streams to CDN.

ErrFailed: 1

1: General error with no classified reason. Try calling the method again.

ErrInitNetEngine: 21

21: The IRtcEngine fails to initialize and has crashed because of specific Windows firewall settings.

ErrInvalidAppId: 101

101: The specified App ID is invalid. Rejoin the channel with a valid App ID.

ErrInvalidArgument: 2

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

ErrInvalidChannelName: 102

102: The specified channel name is invalid. A possible reason is that the parameter's data type is incorrect. Rejoin the channel with a valid channel name.

ErrInvalidState: 8

8: Invalid state.

ErrInvalidToken: 110

110: Invalid token. Typical reasons include the following: App Certificate is enabled in Agora Console, but the code still uses App ID for authentication. Once App Certificate is enabled for a project, you must use token-based authentication. The uid used to generate the token is not the same as the uid used to join the channel. Deprecated: This enumerator is deprecated. Use ConnectionChangedInvalidToken (8) in the onConnectionStateChanged callback instead.

ErrInvalidUserAccount: 134

134: The user account is invalid, possibly because it contains invalid parameters.

ErrInvalidUserId: 121

121: The user ID is invalid.

ErrJoinChannelRejected: 17

17: The request to join the channel is rejected. Possible reasons include the following: The user is already in the channel. Agora recommends that you use the onConnectionStateChanged callback to see whether the user is in the channel. Do not call this method to join the channel unless you receive the ConnectionStateDisconnected (1) state. After calling startEchoTest for the call test, the user tries to join the channel without calling stopEchoTest to end the current test. To join a channel, the call test must be ended by calling stopEchoTest.

ErrLeaveChannelRejected: 18

18: Fails to leave the channel. Possible reasons include the following: The user has left the channel before calling the leaveChannel method. Stop calling this method to clear this error. The user calls the leaveChannel method to leave the channel before joining the channel. In this case, no extra operation is needed.

ErrNoPermission: 9

9: Permission to access is not granted. Check whether your app has access to the audio and video device.

ErrNoServerResources: 103

103: Fails to get server resources in the specified region. Try another region when initializing IRtcEngine.

ErrNotInChannel: 113

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

ErrNotInitialized: 7

7: A method is called before the initialization of IRtcEngine. Ensure that the IRtcEngine object is initialized before using this method.

ErrNotReady: 3

3: The SDK is not ready. Possible reasons include the following: The initialization of IRtcEngine fails. Reinitialize the IRtcEngine. No user has joined the channel when the method is called. Check the code logic. The user has not left the channel when the rate or complain method is called. Check the code logic. The audio module is disabled. The program is not complete.

ErrNotSupported: 4

4: The IRtcEngine does not support the request. Possible reasons include the following: The built-in encryption mode is incorrect, or the SDK fails to load the external encryption library. Check the encryption mode setting, or reload the external encryption library.

ErrOk: 0

0: No error.

ErrRefused: 5

5: The request is rejected. Possible reasons include the following: The IRtcEngine initialization fails. Reinitialize the IRtcEngine. The channel name is set as the empty string "" when joining the channel. Reset the channel name. When the joinChannelEx method is called to join multiple channels, the specified channel name is already in use. Reset the channel name.

ErrResourceLimited: 22

22: The SDK fails to allocate resources because your app uses too many system resources or system resources are insufficient.

ErrSetClientRoleNotAuthorized: 119

119: Switching roles fails, try rejoining the channel.

ErrSizeTooLarge: 114

114: The data size exceeds 1 KB when calling the sendStreamMessage method.

ErrStreamMessageTimeout: 117

117: The data stream transmission times out.

ErrTimedout: 10

10: A timeout occurs. Some API calls require the SDK to return the execution result. This error occurs if the SDK takes too long (more than 10 seconds) to return the result.

ErrTokenExpired: 109

109: The current token has expired. Apply for a new token on the server and call renewToken. Deprecated: This enumerator is deprecated. Use ConnectionChangedTokenExpired (9) in the onConnectionStateChanged callback instead.

ErrTooManyDataStreams: 116

116: More than five data streams are created when calling the createDataStream method.

ErrVdmCameraNotAuthorized: 1501

1501: Permission to access the camera is not granted. Check whether permission to access the camera permission is granted.

Generated using TypeDoc