ZegoErrorCode class

Constructors

ZegoErrorCode()

Properties

hashCode → int: The hash code for this object.
no setterinherited
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
toString() → String: A string representation of this object.
inherited

Operators

operator ==(Object other) → bool: The equality operator.
inherited

Constants

AIVoiceChangerDeviceNotSupportedError → const int: Description: Can not run AI voice changer on this device.
Cause: AI voice changer feature can not run on this device because of poor perforamance.
Solutions: Do not use AI voice changer feature on this device.
AIVoiceChangerExceedMaxCount → const int: Description: Failed to create AI voice changer.
Cause: The instance exceeds the maximum limit.
Solutions: Use an existing AI voice changer instance or destroy the previous instance.
AIVoiceChangerInitFailedError → const int: Description: Initialize AI voie changer failed.
Cause: Did not set user ID before initialize AI voice changer, or AI voice changer service expired.
Solutions: Set user ID before initialize AI voice changer, or contact ZEGO technical support to deal with it.
AIVoiceChangerInnerError → const int: Description: Failed due to internal system exceptions.
Cause: Unknown internal error.
Solutions: Contact ZEGO technical support to deal with it.
AIVoiceChangerModelDownloadFailedError → const int: Description: Download AI voice changer resource files failed.
Cause: Poor network connection.
Solutions: Please check the network connection is ok.
AIVoiceChangerNoInstance → const int: Description: The function call failed.
Cause: No AI voice changer instance has been created.
Solutions: Create an AI voice changer instance.
AIVoiceChangerNoModelError → const int: Description: No AI voice changer resource files.
Cause: AI voice changer resource files were not downloaded.
Solutions: Please make sure AI voice changer resource files downloaded before use it.
AIVoiceChangerNotInitError → const int: Description: AI voice changer was not initialized.
Cause: Did not initialize AI voice changer before use it.
Solutions: Use AI voice changer after initialize it.
AudioEffectPlayerExceedMaxCount → const int: Description: The number of instances of the audio effect player created exceeds the maximum limit.
Cause: The number of instances of the audio effect player created exceeds the maximum limit.
Solutions: Please check if the number of instances of the audio effect player created exceeds the maximum limit, the maximum number of instances allowed to be created is 1.
AudioEffectPlayerLoadFailed → const int: Description: Load audio effect resource failed.
Cause: Invalid audio effect resource file.
Solutions: Check the file format is in the AudioEffectPlayer support file format list or not.
AudioEffectPlayerNoInstance → const int: Description: No audio effect player instance.
Cause: The audio effect player instance not created.
Solutions: Create an audio effect player instance before using it(createAudioEffectPlayer).
AudioEffectPlayerPlayFailed → const int: Description: Play audio effect failed.
Cause: Invalid audio effect resource file.
Solutions: Check the file format is in the AudioEffectPlayer support file format list or not.
AudioEffectPlayerSeekFailed → const int: Description: Change audio effect progress failed.
Cause: The audio effect progress value exceed audio effect file duration.
Solutions: Please check the audio effect progress value exceed audio effect file duration or not.
AudioVADClientInnerNullptr → const int: Description: SDK internal return null pointer.
AudioVADClientNoInstance → const int: Description: The function call failed.
Cause: No audio vad instance has been created.
Solutions: Create a audio vad instance.
CommonAppAccessDeniedError → const int: Description: Server access denied.
Cause: 1.The APP has enabled the restriction of access from foreign IP addresses, and the current client is outside of the domain.
Solutions: Please contact ZEGO technical support.
CommonAppFlexiableConfigError → const int: Description: The backend configuration of the server is incorrect.
Cause: 1. The domain name configuration is incorrect; 2. The media network is abnormal; 3. The media network link is empty.
Solutions: Please contact ZEGO technical support.
CommonAppOfflineError → const int: Description: This AppID has been removed from production.
Solutions: Please check the status of the AppID on the ZEGO official website console or contact ZEGO technical support.
CommonCdnAuthParamTooLong → const int: Description: The Input CDN auth param is too long.
Cause: The length of auth parameter passed in when calling enablePublishDirectToCDN or startPlayingStream exceeds the limit.
Solutions: Auth param length should be less than 1024 bytes.
CommonCdnUrlInvalid → const int: Description: Incorrect CDN address.
Cause: The set CDN URL is not a standard RTMP or FLV protocol.
Solutions: Please check the supported protocol and format.
CommonCdnUrlTooLong → const int: Description: The Input CDN URL is too long.
Cause: The length of URL parameter passed in when calling enablePublishDirectToCDN or startPlayingStream exceeds the limit.
Solutions: URL length should be less than 1024 bytes.
CommonConfigAfterEngineStarted → const int: Description: The engine audio and video module has been activated, and this setting is not supported.
Cause: Only supports setting before starting the audio and video module of the engine.
Solutions: Please set it before calling startPreviewView startPublishingStream startPlayingStream to start the audio and video module.
CommonConfigAfterRoomLoggedIn → const int: Description: The room is logged in, this setting is not supported.
Cause: Only supports setting before logging into the room.
Solutions: Please set it before calling loginRoom or after calling logoutRoom. Note that if you log in to multiple rooms, you need to log out of all rooms before setting.
CommonDispatchError → const int: Server dispatching exception. Please contact ZEGO technical support to solve the problem. This error code is deprecated.
CommonDnsResolveError → const int: DNS resolution failed. Please check network configurations. This error code is deprecated.
CommonEngineNotCreate → const int: Description: The engine is not initialized and cannot call non-static functions.
Cause: Engine not created.
Solutions: Please call the createEngine function to create the engine first, and then call the current function.
CommonEngineNotStarted → const int: Description: The audio and video module of the engine is not started and cannot support function realization.
Cause: Audio and video modules with no engine started.
Solutions: Please call startPreviewView startPublishingStream startPlayingStream to start the audio and video module first.
CommonEventHandlerExists → const int: Description: setEventHandler has been called to set the handler, please do not set it repeatedly.
Cause: Call setEventHandler repeatedly to set the handler.
Solutions: If you need to repeat the settings, please call setEventHandler first to empty the previous handler.
CommonIllegalParam → const int: Description: Illegal param.
Cause: The parameter is empty, or the parameter is an illegal value.
Solutions: Please check param when entered function to make sure it is correct.
CommonInnerNullptr → const int: Description: SDK internal null pointer error.
Cause: The Android JVM environment is abnormal.
Solutions: Please check whether the Android JVM environment is normal or contact ZEGO technical support.
CommonInvalidAndroidEnvironment → const int: Description: Invalid Android context.
Cause: Not set or set the wrong Android context environment.
Solutions: Set the correct Android context.
CommonLoadLibraryFailed → const int: Description: Failed to load SDK dynamic library.
Cause: Incorrect SDK dynamic path passed in.
Solutions: Please pass in the correct SDK dynamic library path.
CommonLoadLibraryFuncNotFound → const int: Description: Failed to obtain SDK export function when loading SDK dynamic library.
Cause: SDK dynamic library version does not match.
Solutions: Please load the matching version of the SDK dynamic library.
CommonLoadLibraryNotSupport → const int: Description: This call is not supported.
Cause: ZEGOEXP_EXPLICIT macro is not enabled.
Solutions: Please add the ZEGOEXP_EXPLICIT macro to the preprocessor.
CommonNotLoginRoom → const int: Description: Not logged in to the room, unable to support function implementation.
Cause: Not logged in to the room.
Solutions: Please call loginRoom to log in to the room first, and use related functions during the online period after entering the room.
CommonSdkNoModule → const int: Description: The current SDK does not support this feature.
Cause: The SDK version used does not include this feature.
Solutions: Please contact ZEGO technical support.
CommonStreamIdInvalidCharacter → const int: Description: The input streamID contains invalid characters.
Cause: The streamID parameter passed in when calling startPublishingStream or startPlayingStream contains invalid characters.
Solutions: Check whether the streamID parameter passed in when calling the function is normal, only support numbers, English characters and '-', '_'.
CommonStreamIdNull → const int: Description: The input StreamID is null.
Cause: The streamID parameter passed in when calling startPublishingStream or startPlayingStream is null or empty string.
Solutions: Check whether the streamID parameter passed in when calling the function is normal.
CommonStreamIdTooLong → const int: Description: The input streamID is too long.
Cause: The length of the streamID parameter passed in when calling startPublishingStream or startPlayingStream exceeds the limit.
Solutions: The streamID should be less than 256 bytes.
CommonSuccess → const int: Execution successful.
CommonUnsupportedPlatform → const int: Description: Call functions that are not supported on the current system/platform.
Cause: For example, calling the function of setting the Android context environment on a non-Android system.
Solutions: Check if the system environment matches.
CommonUserNotSame → const int: Description: When login room or login scene, userID or user name is different.
Cause: Login room, login scene use different user id or user name.
Solutions: Use same user id and user name when login room, login scene.
CopyrightedMusicAppidInvalid → const int: Description: AppID invalid.
Cause: The appID is not support copyrighted music.
Solutions: Please contact ZEGO technical support.
CopyrightedMusicBillingModeInvalid → const int: Description: Billing mode invalid.
Cause: Billing mode invalid.
Solutions: Please select correct billing mode.
CopyrightedMusicCommandInvalid → const int: Description: The command invalid.
Cause: The command entered by the sendExtendedRequest function is empty.
Solutions: Please check the command entered when calling the sendExtendedRequest function to make sure it is not empty.
CopyrightedMusicCopyrightedMusicAuthParamInvalid → const int: Description: Copyright music init authentication failed.
Cause: Appsign or token is not set.
Solutions: When using token authentication, call loginRoom before calling initCopyrightedMusic or use appsign authentication.
CopyrightedMusicCopyrightedServerFail → const int: Description: Request copyrighted server fail.
Cause: The params entered make mistake or some network reasons.
Solutions: Please check the params entered and retry.
CopyrightedMusicDownloadCanceled → const int: Description: Download canceled.
Cause: Call cancelDownload to actively cancel the download.
CopyrightedMusicDownloading → const int: Description: Downloading.
Cause: Download same resource.
Solutions: Please wait for the resource to download successfully.
CopyrightedMusicFreeSpaceLimit → const int: Description: Free space limit.
Cause: Free space limit.
Solutions: Please clean up local files and make sure there is enough free disk space.
CopyrightedMusicGetLyricFail → const int: Description: Get lyric fail.
Cause: Lyrics not found.
Solutions: Please try again later.
CopyrightedMusicGetPitchFail → const int: Description: Get pitch fail.
Cause: Pitch not found.
Solutions: Please select correct song.
CopyrightedMusicGetSharedResourceTimesOver → const int: Description: The number of times the resource is free in the room is exhausted.
Cause: 1. The shared resources cannot be obtained again; 2. Shared resources have been obtained.
Solutions: Please use the acquired resources, or use requestResource to share resources again.
CopyrightedMusicIllegalParam → const int: Description: Illegal param.
Cause: The entered param is incorrect.
Solutions: Please check param when entered function to make sure it is correct.
CopyrightedMusicInnerError → const int: Description: Failed due to internal system exceptions.
Cause: Unknown internal error.
Solutions: Contact ZEGO technical support to deal with it.
CopyrightedMusicKrcTokenExpired → const int: Description: krcToken expired.
Cause: krcToken expired.
Solutions: Please select an unexpired krcToken to get lyrics in KRC format.
CopyrightedMusicKrcTokenIllegal → const int: Description: krcToken illegal.
Cause: krcToken illegal.
Solutions: Please check krcToken when entered by calling getKrcLyricByKrcToken to make sure it is correct.
CopyrightedMusicKrcTokenInvalid → const int: Description: The krcToken invalid.
Cause: The krcToken entered is empty.
Solutions: Please check the krcToken entered when calling the function to make sure it is not empty.krcToken can be obtained by call requestResource getSharedResource
CopyrightedMusicLoadPluginFail → const int: Description: Loading copyright music plugin failed.
Cause: The program runtime path does not include the copyright music plugin dynamic library.
Solutions: Please configure the copyright music plugin dynamic library dependency correctly.
CopyrightedMusicMasterIdInvalid → const int: Description: master ID invalid.
Cause: When billing by owner is selected, master ID is empty.
Solutions: Please pass in the correct master ID.
CopyrightedMusicNetworkError → const int: Description: Failed due to network exceptions.
Cause: Unknown internal error.
Solutions: Contact ZEGO technical support to deal with it.
CopyrightedMusicNoAccompany → const int: Description: No accompany.
Cause: Music don't have accompany.
Solutions: Please choice music have accompany.
CopyrightedMusicNoCopyright → const int: Description: No copyright, unable to listen to and sing songs.
Cause: No copyright.
Solutions: Please select another music.
CopyrightedMusicNoInit → const int: Description: The copyright music module is not initialized.
Cause: The initCopyrightedMusic method is not called to initialize the copyright module.
Solutions: Please call the initCopyrightedMusic method first.
CopyrightedMusicNonMonthlyMembership → const int: Description: Non monthly membership.
Cause: Unopened monthly membership.
Solutions: Open monthly membership or ues COUNT mode request music.
CopyrightedMusicNoPermissionsOfLyricsAndMusic → const int: Description: No permissions of accompaniment, can only listen to songs, not sing.
Cause: No permissions of accompaniment.
Solutions: Please select another music.
CopyrightedMusicNoPitch → const int: Description: resource has no pitch.
Cause: resource has no pitch.
Solutions: Please pass in the correct song ID.
CopyrightedMusicNotSharedResource → const int: Description: This resource is not shared in the room.
Cause: No users in the room share this resource.
Solutions: Please any one user in the room to call the requestresource function to request resources and share them.
CopyrightedMusicNotSupportMethod → const int: Description: The copyright music module does not support this method.
Cause: The copyright music module does not support this function under the current platform.
Solutions: Contact ZEGO technical support to deal with it.
CopyrightedMusicPageInvalid → const int: Description: The page parameter is invalid for multiple copyright searches.
Cause: The page parameter must be 1 when multiple rights search is called for the first time.
Solutions: Please pass in the correct page.
CopyrightedMusicParamsInvalid → const int: Description: The params invalid.
Cause: The params entered by the sendExtendedRequest function is empty.
Solutions: Please check the params entered when calling the sendExtendedRequest function to make sure it is not empty.
CopyrightedMusicPositionInvalid → const int: Description: The position invalid.
Cause: The position entered by the fuction seek is invalid.
Solutions: Please check the position entered when calling the function seek to make sure it is in 0 ~ song duration.
CopyrightedMusicResourceExpired → const int: Description: The copyrighted resource has expired.
Cause: The copyrighted resource has expired.
Solutions: Please request the copyrighted resource again.
CopyrightedMusicResourceFileExpired → const int: Description: Resource file expired.
Cause: The resource file has expired.
Solutions: Please request song or accompaniment again.
CopyrightedMusicResourceFileInvalid → const int: Description: Resource file invalid.
Cause: File is corrupted
Solutions: Please call download function to reload media resource.
CopyrightedMusicResourceFileNotExist → const int: Description: Resource file not exist.
Cause: Resource file has been deleted.
Solutions: Please reload resource.
CopyrightedMusicResourceIdInvalid → const int: Description: The resource_id invalid.
Cause: The resource_id entered is empty.
Solutions: Please check the resource_id entered when calling the function to make sure it is not empty.resource_id can be obtained by call requestResource getSharedResource getMusicByToken
CopyrightedMusicResourceIdUnauthorized → const int: Description: The resource_id unauthorized.
Cause: The resource ID is not obtained through requestResource getSharedResource function.
Solutions: Please call the requestResource getSharedResource function to get valid resource ID.
CopyrightedMusicResourceNotExist → const int: Description: Resource not exist.
Cause: Resource not exist.
Solutions: Please select another music.
CopyrightedMusicResourceNotSupportFunction → const int: Description: The resource does not support this method.
Cause: Wrong resource ID selection.
Solutions: Please pass in the correct resource ID.
CopyrightedMusicRoomNoLogin → const int: Description: The room ID is not logged in.
Cause: Room ID input error.
Solutions: If the copyright is not used in a multi room scenario, there is no need to pass in the roomID, otherwise please pass in the correct logged in room ID.
CopyrightedMusicSceneIdInvalid → const int: Description: scene ID invalid.
Cause: scene ID invalid.
Solutions: Please pass in the scene ID corresponding to the opened scene.
CopyrightedMusicShareTokenExpired → const int: Description: Share token expired.
Cause: Share token expired.
Solutions: Please select an unexpired sharing token to get resources.
CopyrightedMusicShareTokenIllegal → const int: Description: Share token illegal.
Cause: Share token illegal.
Solutions: Please check songToken when entered by calling getMusicByToken to make sure it is correct.
CopyrightedMusicShareTokenInvalid → const int: Description: The share_token invalid.
Cause: The share_token entered is empty.
Solutions: Please check the share_token entered when calling the function to make sure it is not empty.share_token can be obtained by call requestResource
CopyrightedMusicSongIdInvalid → const int: Description: The song_id invalid.
Cause: The song_id entered is empty.
Solutions: Please check the song_id entered when calling the function to make sure it is not empty.
CopyrightedMusicSongIdNotSupport → const int: Description: This vendor does not support this song ID.
Cause: This song ID does not exist in the copyright music library.
Solutions: Please pass in the correct song ID.
CopyrightedMusicStartPositionInvalid → const int: Description: The start_position invalid.
Cause: The start_position entered by the fuction loadCopyrightedMusicResourceWithPosition is invalid.
Solutions: Please check the start_position entered when calling the function loadCopyrightedMusicResourceWithPosition to make sure it is in 0 ~ song duration.
CopyrightedMusicSystemBusy → const int: Description: System is busy.
Cause: System is busy.
Solutions: Please try again.
CopyrightedMusicTopIdInvalid → const int: Description: top ID invalid.
Cause: An unsupported top ID was passed in when fetching chart songs.
Solutions: Please pass in the correct top ID.
CopyrightedMusicUnreasonableAccess → const int: Description: Unreasonable_access.
Cause: Monthly membership request music by COUNT.
Solutions: Please select correct billing mode.
CopyrightedMusicVendorIdInvalid → const int: Description: Vendor ID invalid.
Cause: Wrong vendor selection.
Solutions: Please pass in the correct vendor ID.
CopyrightedMusicVendorIdNotAvaliable → const int: Description: The vendor is unavailable.
Cause: The corresponding copyright party has not been activated.
Solutions: Please pass in the correct vendor ID.
CopyrightedMusicVendorNotSupportFunction → const int: Description: This vendor does not support this function.
Cause: Wrong vendor selection.
Solutions: Please pass in the correct vendor ID.
CopyrightedMusicVolumeInvalid → const int: Description: The volume invalid..
Cause: The Volume entered by the fuction setPlayVolume is invalid.
Solutions: Please check the Volume entered when calling the function setPlayVolume to make sure it is in 0 ~ 200.
CustomAudioIOAudioDataCallbackSampleRateNoSupport → const int: Description: The sample rate parameter is illegal.
Cause: Capture and render mix results recording does not support 8000, 22050, 24000 sample rates.
Solutions: Please confirm whether the sample rate parameter value allowed by the interface is legal.
CustomAudioIOCapturerNotCreated → const int: Description: The custom audio capture feature is not enabled.
Cause: The custom audio capture feature is not enabled.
Solutions: Please make sure that the custom audio IO module is enabled for the specified stream publishing channel.
CustomAudioIOEnableCustomAudioIoFailed → const int: Description: Failed to enable/disable custom audio IO.
Cause: Failed to enable/disable custom audio IO.
Solutions: Please make sure to enable/disable it before the engine is started (i.e., before calling startPreview, startPublishingStream or startPlayingStream).
CustomAudioIORendererNotCreated → const int: Description: The custom audio rendering feature is not enabled.
Cause: The custom audio rendering feature is not enabled.
Solutions: Please make sure that the custom audio IO module is enabled.
CustomAudioIOUnsupportedAudioSourceType → const int: Description: Unsupported custom audio source type.
Cause: Only channel_aux supports zego_audio_source_type_media_player.
Solutions: Select the correct custom audio source type.
CustomVideoIOCapturerNotCreated → const int: Description: The custom video capturer is not created.
Cause: Create custom video capturer before onStart callback received.
Solutions: Please create custom video capturer after received onStart callback.
CustomVideoIOEnableCustomIoFailed → const int: Description: Failed to enable/disable custom video capture/rendering.
Cause: Not enable/disable custom video capture/rendering before engine is started.
Solutions: Please make sure to enable/disable custom video capture/rendering before engine is started, i.e., before calling (startPreview), (startPublishingStream), (startPlayingStream), (createMediaPlayer) or (createAudioEffectPlayer).
CustomVideoIOInvalidActiveD3d11Device → const int: Description: customVideoCaptureSendD3DTextureData specifies texture not supported by the SDK.
Cause: TThe device corresponding to the texture specified by customVideoCaptureSendD3DTextureData was not created by D3D11CreateDevice(0, D3D_DRIVER_TYPE_HARDWARE, NULL,...).
Solutions: customVideoCaptureSendD3DTextureData specifies the texture created by D3D11CreateDevice (0, D3D_DRIVER_TYPE_HARDWARE, NULL,...).
CustomVideoIONoCustomVideoCapture → const int: Description: The custom video capture module is not enabled.
Cause: Custom video capture module is not enabled in initialization configurations.
Solutions: Please contact ZEGO technical support, make sure custom video capture module is enabled in initialization configurations.
CustomVideoIONoCustomVideoProcessing → const int: Description: The custom video process module is not enabled.
Cause: The custom video process module is not enabled.
Solutions: Call enableCustomVideoProcessing to enable a custom video capturermodule.
CustomVideoIONotSupportedBufferType → const int: Description: Custom video rendering does not support the currently set video buffer type.
Cause: The buffer_type in the config parameter of enableCustomVideoRender only supports raw_data, cv_pixel_buffer, encoded_data. For enableCustomVideoProcessing, only raw_data is supported on Windows platform, only cv_pixel_buffer is supported on Apple devices, and gl_texture_2d and surface_texture are supported on Android platform.
Solutions: Select the correct video buffer type.
CustomVideoIONotSupportedFormat → const int: Description: The currently configured custom video capture format does not support this API.
Cause: The currently configured custom video capture format does not support this API.
Solutions: Please contact ZEGO technical support.
CustomVideoIOProcessModuleNotCreated → const int: Description: The custom video capturer is not created.
Cause: Internal video-related modules are not created.
Solutions: Please call startPreview or startPublishingStream first.
DeviceAudioSpectrumIntervalInvalid → const int: Description: The set audio spectrum monitoring interval is out of range.
Cause: The set audio spectrum monitoring interval is less than 10 milliseconds.
Solutions: Reset audio spectrum monitoring interval which is not less than 10 milliseconds.
DeviceAudioVadStableStateMonitorTypeInvalid → const int: invalid audio VAD monitor type
DeviceErrorMediaServicesLost → const int: Description: The device media is lost.
Cause: Media service cannot be restored.
Solutions: Restart device.
DeviceErrorTypeGeneric → const int: Description: Generic device error.
Cause: Device dose not work normally.
Solutions: Use the system's video or audio recording application to check whether the device can work normally. If the device is normal, please contact ZEGO technical support.
DeviceErrorTypeInUseByOther → const int: Description: The device is occupied.
Cause: The device is occupied by other programs.
Solutions: Please use the system's video or audio recording application to check whether the device is working properly and make sure that the device is not occupied by other applications.
DeviceErrorTypeInvalidId → const int: Description: The device ID does not exist.
Cause: The device ID is spelled incorrectly, or the corresponding device is unplugged.
Solutions: Please use the SDK interface to obtain the device ID, and check whether the device is properly connected.
DeviceErrorTypeNoAuthorization → const int: Description: No permission to access the device.
Cause: Did not apply for or obtain the permission to use the corresponding device.
Solutions: Please check whether the application has correctly applied for the camera or microphone permission, and whether the user has granted the corresponding permission.
DeviceErrorTypeRebootRequired → const int: Description: The device needs to be restarted.
Cause: Device driver update, or device error requires restart.
Solutions: Restart device.
DeviceErrorTypeUnplugged → const int: Description: The device is unplugged.
Cause: The device is unplugged or not properly connected.
Solutions: Check the device wiring and reconnect the device.
DeviceErrorTypeZeroFps → const int: Description: The frame rate of the capture device is 0.
Cause: Device error, or device does not have permission.
Solutions: Please use the system's video or audio recording application to check whether the device can work normally. Please check whether the application has correctly applied for the camera or microphone permission, and whether the user has granted the corresponding permission. If the device is normal and the application has obtained the corresponding device permissions, please contact ZEGO technical support.
DeviceExposureCompensationValueInvalid → const int: Description: Failed to set the camera exposure compensation.
Cause: The set camera exposure compensation value is out of range.
Solutions: Set the camera exposure compensation range between -1,1.
DeviceFreeDeviceListNull → const int: Description: The device list cannot be empty when trying to release devices.
Cause: The device list has been released or has not been initialized.
Solutions: Ignore it.
DeviceInnerError → const int: Description: Internal error of the device.
Solutions: Contact ZEGO technical support.
DeviceSouldLevelIntervalInvalid → const int: Description: The set sound level monitoring interval is out of range.
Cause: The set sound level monitoring interval is less than 100 milliseconds, or greater than 3000 milliseconds.
Solutions: Reset the effective sound level monitoring interval, the effective sound level monitoring interval is 100, 3000, in milliseconds.
DeviceZoomFactorInvalid → const int: Description: Failed to set the camera zoom.
Cause: The set camera zoom factor is out of range.
Solutions: The set camera zoom factor cannot exceed the maximum range obtained, the maximum range can be obtained through getCameraMaxZoomFactor.
EngineAppidIncorrectOrNotOnline → const int: Description: Authentication failed.
Cause: Incorrect AppID; using AppID in wrong environment.
Solutions: Please check AppID is correct or not on ZEGO manage console, or check whether the environment configured by AppID is consistent with the environment set by SDK.
EngineAppidZero → const int: AppID cannot be 0. Please check if the AppID is correct.
EngineAppsignIncorrect → const int: Description: Authentication failed.
Cause: Incorrect AppSign.
Solutions: Please check AppSign is correct or not on ZEGO manage console.
EngineAppsignInvalidCharacter → const int: The input AppSign contains invalid characters. Only '0'-'9', 'a'-'f', 'A'-'F' are valid.
EngineAppsignInvalidLength → const int: The length of the input AppSign must be 64 bytes.
EngineAppsignNull → const int: The input AppSign is empty.
EngineExperimentalJsonStrInvalid → const int: Description: The experimental API json parameter parsing failed.
Cause: Invalid json format; wrong function name or parameter.
Solutions: Please check json format is valid or not; check function name or parameter is correct or not, contact ZEGO technical support for specific function name and parameters.
EngineLicenseNull → const int: The input License is empty.
EngineLogNoWritePermission → const int: Description: No write permission to the log file.
Cause: App has no write permission to log file folder.
Solutions: Please check has grant write permission to App or not; check log folder is protected or not.
EngineLogPathTooLong → const int: Description: The log file path is too long.
Cause: The length of log file path exceeds limit.
Solutions: Please check the length of log file path.
EngineSetGeoFenceErrorTime → const int: Description: Set geo fence failed.
Cause: Set geo fence after initialize the SDK.
Solutions: Please set geo fence before initialize the SDK.
EngineSetRoomModeErrorTime → const int: Description: Set room mode failed.
Cause: Set room mode after initialize the SDK.
Solutions: Please set room mode before initialize the SDK.
IMBroadcastMessageQpsOverload → const int: Description: Failed to send broadcast message,.
Cause: QPS exceeds the limit.
Solutions: Control the maximum QPS is 2 .
IMContentNull → const int: Description: the input message content is empty
Cause: imessage content is empty
Solutions: Input a non-empty message.
IMContentTooLong → const int: Description: The input message content is too long
Cause: message more than 1024 bytes.
Solutions: The maximum length should be less than 1024 byte
IMDataTooLong → const int: Description: The input real-time sequential data is too long.
Cause: The length of the input data is greater than 4096 bytes.
Solution: Check the length of the input data, consider splitting the large data packet into multiple small data and sending it multiple times.
IMInconsistentRoomId → const int: Description: The room where the message is sent is different from the room currently logged in.
Cause: The room where the message is sent is different from the room currently logged in.
Solutions: Send a message to the current logged-in room ID.
IMInputParamsLengthLimit → const int: Description: Failed to send message.
Cause: The message input length exceeds the limit.
Solutions: Check the input content length or contact ZEGO technical support to expand the message content length.
IMManagerCreationFailed → const int: Description: The real-time sequential data manager instance creation failed.
Cause: A manager instance with this room ID has already been created.
Solution: A maximum of 1 instance can be created for each room ID. If you need to create multiple instances, please use other room IDs.
IMNoAvailableBroadcastChannel → const int: Description: No publish channel available for broadcasting.
Cause: The developer has used all publish channels.
Solution: Do not use all the publish channels, check if there are any streams that can stop publsihing, or contact ZEGO technical support to increase the available publish channels.
IMNoAvailableStreamId → const int: Description: The stream ID to start broadcasting is not available.
Cause: The stream ID has been used in this device for RTC business (e.g. startPublishingStream / startPlayingStream).
Solution: Please use another stream ID for broadcasting.
IMNoBroadcatingStream → const int: Description: The stream to stop broadcasting does not exist.
Cause: The stream ID set stopBroadcasting function is not in broadcasting.
Solution: Check if the stream ID is correct, or if the stream ID is not in broadcasting.
IMNoManagerInstance → const int: Description: The specified real-time sequential data manager instance could not be found.
Cause: This manager instance has not been created yet.
Solution: Please call the createRealTimeSequentialDataManager function to create a manager instance first.
IMNoSubscribingStream → const int: Description: The stream to stop subscribing does not exist.
Cause: The stream ID set stopSubscribing function is not in subscribing.
Solution: Check if the stream ID is correct, or if the stream ID is not in subscribing.
IMRealTimeSequentialDataSendFailed → const int: Description: Failed to send real-time sequential data.
Cause: The broadcast has not started yet, or the broadcast has encountered network problems.
Solution: Check whether startBroadcasting has been called to start broadcasting, or check whether the network is normal.
IMRepeatBroadcast → const int: Description: Repeat broadcast.
Cause: The developer repeatedly calls the startBroadcasting function.
Solution: Please check the business logic to avoid repeating the broadcast for the stream which is broadcasting.
IMRepeatSubscribe → const int: Description: Repeat broadcast.
Cause: The developer repeatedly calls the startBroadcasting function.
Solution: Please check the business logic to avoid repeating the subscribe for the stream which is subscribing.
IMSendFailed → const int: Description: Failed to send the message.
Cause: network problems.
Solutions: Check the network.
IMUserIdEmpty → const int: Description: Failed to send custom command.
Cause: The entered user ID is empty.
Solutions: Please enter the correct user ID.
IMUserIdTooLong → const int: Description: Failed to send custom signaling.
Cause: The entered user ID is too long.
Solutions: Please enter the correct user ID, the maximum user ID cannot exceed 64 bytes.
MediaDataPublisherExceedMaxCount → const int: Description: The number of instances of the media data publisher created exceeds the maximum limit.
Cause: The number of instances of the media data publisher created exceeds the maximum limit.
Solutions: Please check if the number of instances of the media data publisher created exceeds the maximum limit, the maximum number of instances allowed to be created is 1.
MediaDataPublisherFileCodecError → const int: Description: File decoding exception.
Cause: Invalid media file format.
Solutions: Please check the file is a valid media file or not; check the file format is in the MediaPlayer support file format list or not.
MediaDataPublisherFileParseError → const int: Description: This error code is deprecated.
Cause: None.
Solutions: None.
MediaDataPublisherFilePathError → const int: Description: This error code is deprecated.
Cause: None.
Solutions: None.
MediaDataPublisherNoInstance → const int: Description: The MediaDataPublisher instance is not created.
Cause: The MediaDataPublisher instance is not created.
Solutions: Call createMediaDataPublisher to create a media pusher instance.
MediaDataPublisherTimestampGoBackError → const int: Description: Timestamp error.
Cause: the later frame timestamp is smaller than the previous frame timestamp.
Solutions: Please provide the media file, and contact ZEGO technical support.
MediaPlayerAlreadyStart → const int: Description: The MediaPlayer is already start.
Cause: Load has been called.
Solutions: Please call Stop first, then call Load.
MediaPlayerDemuxError → const int: Description: The MediaPlayer failed to load the file.
Cause: There was an error during file resolution.
Solutions: Try again or contact ZEGO technical support.
MediaPlayerExceedMaxCount → const int: Description: The number of MediaPlayer instances exceeds the maximum number allowed.
Cause: The number of MediaPlayer instances exceeds the maximum number allowed. Up to 4 instances can be created.
Solutions: Media players can create up to 4 instances, and make sure that the number of media player instances is not exceeded the maximum limit.
MediaPlayerFileDecodeError → const int: Description: The MediaPlayer failed to load the file.
Cause: The file decoding failed.
Solutions: Check that the media file is corrupted or contact ZEGO technical support.
MediaPlayerFileExpired → const int: Description: The copyrighted music resource file has expired.
Cause: The resource file has expired.
Solutions: Please request song or accompaniment again.
MediaPlayerFileFormatError → const int: Description: The MediaPlayer failed to load the file.
Cause: File formats are not supported.
Solutions: Files in this format are not supported, please use files in the supporting format.
MediaPlayerFileNoSupportedStream → const int: Description: The MediaPlayer failed to load the file.
Cause: No supported audio/video stream exists.
Solutions: Check that the media file data is empty.
MediaPlayerFilePathNotExists → const int: Description: The MediaPlayer failed to load the file.
Cause: The file path does not exist.
Solutions: Check the validity of the media file path.
MediaPlayerFilePathTooLong → const int: Description: The specified media file path is too long.
Cause: The specified media file path is too long. The maximum length should be less than 1024 bytes.
Solutions: Please specify media file path less than 1024 bytes.
MediaPlayerInnerError → const int: Description: MediaPlayer internal error.
Cause: internal error.
Solutions: Contact Technical support.
MediaPlayerLocalCacheFailed → const int: Description: Failed to cache network resource file.
Cause: During playback, seekTo operation will cause cache failure, and network reasons or incomplete playback caused by active stop will also cause cache failure.
Solutions: Check whether there is a seekTo operation, whether the playback failed due to network reasons, or whether the playback stopped actively.
MediaPlayerNoFilePath → const int: Description: The MediaPlayer failed to play the media.
Cause: The resource file is not loaded.
Solutions: The media player loads the media resource loadResource before starting.
MediaPlayerNoInstance → const int: Description: The MediaPlayer failed to play the media.
Cause: The resource file is not loaded.
Solutions: Create a media player instance before using media players createMediaPlayer.
MediaPlayerParamValueRangeIllegal → const int: Description: the passed parameter is not in the valid value range.
Cause: error setting parameters.
Solutions: Review the interface comment and pass in a value within the legal range.
MediaPlayerPlatformFormatNotSupported → const int: Description: The MediaPlayer is configured with a video data format not supported by the platform.
Cause: The MediaPlayer is configured with a video data format not supported by the platform (e.g., CVPixelBuffer on iOS does not support NV21).
Solutions: Check the data format setVideoHandler supported by the current media player platform and set the correct data format.
MediaPlayerResourceExpired → const int: Description: The copyrighted music resource has expired.
Cause: The copyrighted music resource has expired.
Solutions: Please request the copyrighted music resource again.
MediaPlayerResourceIdTooLong → const int: Description: The copyrighted music resource ID is too long.
Cause: The copyrighted music resource ID is too long. The maximum length should be less than 512 bytes.
Solutions: Please copyrighted music resource ID less than 1024 bytes.
MediaPlayerSeekError → const int: Description: The MediaPlayer failed to seek.
Cause: The file hasn't been loaded yet.
Solutions: The media player loads the media resource loadResource before seeking seekTo.
MediaPlayerSetAudioTrackIndexError → const int: Description: The media player failed to specify the audio track index.
Cause: The audio track index not exist.
Solutions: Check file audio track index call getAudioTrackCount can get.
MediaPlayerSetVoiceChangerParamInvalid → const int: Description: Media player setting sound change parameter invalid.
Cause: Error setting parameters.
Solutions: Checking setting parameters control during -12.0 to 12.0
MediaPlayerTakeSnapshotTimingError → const int: Description: takeSnapshot screenshot failed
Cause: The video is not playing or 'setPlayerCanvas' is not called to display the video to the control.
Solutions: Check whether the video plays normally(check onPlayStart callback) and the screen is displayed normally.
MediaPlayerUserCancel → const int: Description: User cancel.
Cause: After calling Load to load the resource, call Stop to stop the player.
Solutions: Expected behavior when calling Stop while loading a resource.
MixerAdvancedConfigTooLongError → const int: Description: The mixed-flow advanced configuration is too long.
Cause: The length of the mixed stream advanced configuration parameter exceeds the limit.
Solutions: Please make sure that the advanced configuration length does not exceed 512 bytes.
MixerAudioConfigInvalid → const int: Description: The video configuration of the stream mixing task is invalid.
Cause: 1. An unsupported audio codec format is used. 2. The audio bit rate exceeds 192 kbps.
Solutions: Please check the audio configuration of the stream mixing task.
MixerAuthenticationFailed → const int: Description: Failed to start mixed stream.
Cause: Mixed-stream authentication failed.
Solutions: Contact ZEGO technical support.
MixerAutoMixStreamServerNotFound → const int: Description: Failed to start mixed stream.
Cause: The auto-mixing server was not found.
Solutions: Please contact ZEGO technical support.
MixerBackgroundImageUrlInvalid → const int: Description: Failed to start mixed stream.
Cause: The URL of the background image entered is illegal.
Solutions: The URL of the background image must start with preset-id:// and end with .jpg or .png.
MixerBackgroundImageUrlTooLong → const int: Description: The mixed stream background image url is too long.
Cause: The length of the mixed stream background url parameter exceeds the limit.
Solution: Please make sure the background image url length does not exceed 1024 bytes.
MixerExceedMaxAudioFocusStreamCount → const int: Description: Failed to start mixed stream.
Cause: The maximum number of focus voice input streams is exceeded.
Solutions: Support up to 4 input streams to set the focus voice.
MixerExceedMaxInputCount → const int: Description: The number of input streams exceeds the maximum number allowed.
Cause: Supports up to 9 input streams, and may pass more than 9 input streams.
Solutions: Please check the input stream configuration of the mixing task.
MixerExceedMaxOutputCount → const int: Description: Failed to start mixed stream.
Cause: Exceeding the maximum number of output streams.
Solutions: Support up to 3 output streams.
MixerInnerError → const int: Description: Stream mixing internal error.
Cause: Unknown error occured in stream mixing internal.
Solutions: Please contact ZEGO technical support.
MixerInputImageUrlFormatError → const int: Description: Failed to mix stream input image.
Cause: The image format of the mixed stream input parameter is incorrect.
Solution: Use JPG and PNG formats. There are 2 ways to use it: 1. URI: Provide the picture to ZEGO technical support for configuration. After the configuration is complete, the picture URI will be provided, for example: preset-id://xxx.jpg. 2. URL: Only HTTP protocol is supported.
MixerInputImageUrlSizeError → const int: Description: Failed to mux input image.
Cause: The image size of the mixed stream input parameter exceeds the limit.
Solution: Image size is limited to 1M.
MixerInputImageUrlTooLong → const int: Description: The link to the muxed input image is too long.
Cause: The length of the image link of the mixed stream input parameter exceeds the limit.
Solution: Please make sure that the length of the input image link does not exceed 1024 bytes.
MixerInputLabelTextTooLong → const int: Description: Mixed input text watermark is too long.
Cause: The length of the text watermark of the mixed stream input parameter exceeds the limit.
Solutions: Please make sure the input text watermark length does not exceed 512 bytes.
MixerInputListInvalid → const int: Description: The input stream list of the stream mixing task is empty.
Cause: The input stream list of the stream mixing task is empty.
Solutions: Please check the input stream list of the mixing task.
MixerInputParametersError → const int: Description: Failed to start mixed stream.
Cause: The mixed stream input parameter is wrong, it may be that the layout of the input stream exceeds the canvas range.
Solutions: Please enter the correct mixed stream parameters. ZegoMixerTask
MixerInputStreamNotExists → const int: Description: Failed to start mixed stream.
Cause: The input stream does not exist.
Solutions: Please make sure that the stream corresponding to the entered streamID is being pushed.
MixerNoOutputTarget → const int: Description: Illegal parameters exist in mixing task configuration.
Cause: 1. The mixing task ID is empty; 2. The mixing room ID is empty; 3. The mixing custom data length exceeds 1000 bytes; 4. The mixing output target stream is empty.
Solutions: Please check the configuration parameters of the mixing task.
MixerNoServices → const int: Description: Does not support the use of stream mixing service.
Cause: No stream mixing service configured.
Solutions: Please open the service on the console or contact ZEGO business staff.
MixerNotOwnerStopMixer → const int: The stream mixing task must be stopped by the user who started the task. This error code is deprecated.
MixerOutputListInvalid → const int: Description: The output stream list of the stream mixing task is empty.
Cause: The output stream list of the stream mixing task is empty.
Solutions: Please check the output stream list of the mixing task.
MixerOutputTargetInvalid → const int: Description: Illegal format of mixed stream output target parameter.
Cause: When the target of the mixed stream output target is streamID, an illegal character is passed in.
Solutions: Please check whether the target of the mixed stream output target is of streamID type, if so, target only support numbers, English characters and '-', '_'.
MixerOutputTargetRoomError → const int: Description: The mixed output stream target room is misconfigured.
Cause: The room doesn't exist when the mixing starts.
Solution: Please make sure that the room corresponding to the configured targetRoom exists.
MixerOutputTargetTooLongError → const int: Description: Mixed stream output target is too long.
Cause: The length of the target parameter of the mixed stream output exceeds the limit.
Solutions: Please make sure that the output destination length does less than 1024 bytes.
MixerStartQpsOverload → const int: Description: Starts stream mixing tasks too frequently.
Cause: Requests are too frequent, exceeding the qps limit of the service.
Solutions: Please ensure that the qps of the mixing request is less than 100.
MixerStartRequestError → const int: Description: Failed to start the stream mixing task.
Cause: Requests are too frequent, exceeding the qps limit of the service. Network exceptions. An illegal mixed stream output URL was passed in.
Solutions: Please ensure that the qps of the mixing request is less than 100. Check the network. Pass in a valid mixed stream output URL.
MixerStopQpsOverload → const int: Description: Stop stream mixing tasks too frequently.
Cause: Requests are too frequent, exceeding the qps limit of the service.
Solutions: Please ensure that the qps of the stop mixing request is less than 100.
MixerStopRequestError → const int: Description: Failed to stop the stream mixing task.
Cause: May be the cause of the network error.
Solutions: Please check the network ring.
MixerTaskIdInvalidCharacter → const int: Description: Invalid mixed flow task ID.
Cause: Illegal characters in the stream mixing task ID.
Solutions: Stream mixing task ID only supports numbers, English characters and'~','!','@','$','%','^','&','*','(',')', '_','+','=','-','`',';',''',',','.','<','>','/','', please enter the stream mixing task ID in the correct format.
MixerTaskIdNull → const int: Description: The mixing task ID is null.
Cause: The mixing task ID input when starting mixing task is empty.
Solutions: Please enter the correct mixing task ID.
MixerTaskIdTooLong → const int: Description: The stream mixing task ID is too long.
Cause: The stream mixing task ID is greater than 256 bytes.
Solutions: Please enter a mixing task ID less than 256 bytes.
MixerUserDataTooLong → const int: Description: Failed to start mixed stream.
Cause: The user-defined data is too long.
Solutions: The maximum length of the custom input should not exceed 1000 bytes.
MixerVideoConfigInvalid → const int: Description: The video configuration of the stream mixing task is invalid.
Cause: The video configuration of the stream mixing task is invalid.
Solutions: Please check the video configuration of the stream mixing task.
MixerWatermarkNull → const int: Description: Failed to start mixed stream.
Cause: The input image watermark is empty.
Solutions: Please enter the correct watermark parameters ZegoWatermark.
MixerWatermarkParametersError → const int: Description: Failed to start mixed stream.
Cause: The input image watermark parameter is wrong, it may be that the layout exceeds the canvas range.
Solutions: Please enter the correct watermark parameters ZegoWatermark.
MixerWatermarkTooLong → const int: Description: The mixed stream watermark path is too long.
Cause: The length of the mixed stream watermark path parameter exceeds the limit.
Solution: Please make sure the watermark path length does not exceed 512 bytes.
MixerWatermarkUrlInvalid → const int: Description: Failed to start mixed stream.
Cause: The input watermark URL is illegal.
Solutions: The watermark URL must start with preset-id:// and end with .jpg or .png.
PlayerCountExceed → const int: Description: Stream playing error.
Caution: The number of streams the user attempted to play simultaneously exceeds the maximum number allowed.
Solutions: Currently, up to 12 steams can be played at the same time. Please contact ZEGO technical support to increase the capacity if necessary.
PlayerDecryptionFailed → const int: Description: Pull stream decryption failed, please check whether the decryption key is correct.
Cause: Incorrect decryption key entered.
Solutions: Enter the correct decryption key.
PlayerDecryptionKeyInvalid → const int: Description: The play stream decryption key is invalid, the key length only supports 16/24/32 bytes.
Cause: The input key length is not 16/24/32 bytes.
Solutions: Adjust the input key length to 16/24/32 bytes.
PlayerErrorDispatchAuthError → const int: Description: Play stream authentication is incorrect.
Caution: The Token error or timeout required to playing stream across APP.
Solutions: Playing the stream to pass the correct Token, or update the Token in time.
PlayerErrorNetworkInterrupt → const int: Description: Stream playing is temporarily interrupted.
Caution: Network exception.
Solutions: Please wait or check whether the network is normal.
PlayerErrorPlayStreamWhenUsingMultiRoom → const int: Description: Calling the wrong function after enabling the multi-room function causes playing stream fail.
Cause: Called the playing stream function that only works for joining a single room mode.
Solutions: Please use the function of the same name with ZegoPlayerConfig and specify the room ID to play the stream.
PlayerErrorPlayStreamWithRoomIdIsNullWhenUsingMultiRoom → const int: Description: In the multi-room mode, the roomID parameter of the play stream cannot be empty.
Cause: The roomID parameter of the pull stream is empty.
Solutions: Please enter the correct roomID.
PlayerErrorServerForbid → const int: Description: Failed to play the stream.
Caution: Publishing of this stream is prohibited by backend configuration.
Solutions: Please contact ZEGO technical support to solve the problem.
PlayerInnerError → const int: Description: An internal system exception causes a failure to pull the stream.
Cause: SDK internal error.
Solutions: Please contact ZEGO technical support.
PlayerNotConfigL3 → const int: Description: When using the SDK to play the latency of live streaming, this error code will be returned if you have not subscribed to the low latency live streaming service.
Cause: Low-latency live broadcast service is not activated.
Solutions: Please contact ZEGO technical support staff to open the low-latency live broadcast service.
PlayerPlayStreamFailed → const int: Description: Stream playing failed.
Caution: Possibly due to no data in the stream.
Solutions: Check to see if the publish-stream is working or try to play stream again, and if the problem is still not resolved, please contact ZEGO technical support to solve the problem.
PlayerPlayStreamNotExist → const int: Description: Stream playing failed.
Caution: The stream does not exist.
Solutions: Please check whether the remote end publish is indeed successful, or whether the publish and play environment are inconsistent.
PlayerStreamWasNotPlayed → const int: Description: The stream was not played.
Caution: The stream was not played.
Solutions: Please confirm that the stream has been played through the onPlayerStateUpdate or onUserStreamStateUpdate callback.
PlayerSuperResolutionDeviceNotSupport → const int: Description: This device does not support super resolution.
Caution: The device configured on the server does not support super resolution, or the configuration on the server failed to pull.
Solutions: replace the device and try again or contact ZEGO technical support.
PlayerSuperResolutionDevicePerformanceError → const int: Description: The performance of super resolution device is not enough.
Caution: The performance of device is not enough.
Solutions: Please replace the device.
PlayerSuperResolutionMaxCountExceed → const int: Description: The number of super resolution streams exceeds the limit.
Caution: The number of super resolution streams exceeds the limit.
Solutions: Currently, super resolution support up to 1 playing steam at the same time.
PlayerSuperResolutionNotInitError → const int: Description: Super resolution uninitialized.
Caution: Super resolution uninitialized.
Solutions: Please initialize super resolution.
PlayerSuperResolutionVideoSizeNotSupport → const int: Description: The number of super resolution streams exceeds the limit.
Caution: The number of super resolution streams exceeds the limit.
Solutions: contact ZEGO technical support.
PlayerTakePlayStreamSnapshotFailed → const int: Description: Failed to capture the screenshot of the streaming screen, please check whether the stream to be captured is normal.
Cause: The stream is not pulled.
Solutions: Check whether it starts to play the stream, and whether there is an abnormality in the process of playing the stream.
PlayerVideoDecoderFail → const int: Description: Video decoder fail.
Caution: Video decoder fail.
Solutions: Please contact ZEGO technical support.
PlayerVideoDecoderNoSupportted → const int: Description: Unsupported video decoder.
Caution: There is no selected video decoder in the current SDK.
Solutions: Please contact ZEGO technical support.
PreprocessBeautifyOptionInvalid → const int: Description: Failed to set the beauty configuration.
Cause: The incoming beauty parameters are incorrect.
Solutions: Please check the passed in ZegoBeautifyOption type parameter.
PreprocessElectronicEffectsTonalInvalid → const int: Description: Failed to turn on or turn off the electronic sound effect.
Cause: the initial pitch parameter tonal of the electronic tone is invalid.
Solutions: The normal range of the starting pitch parameter of the electronic tone is 0 ~ 11.
PreprocessEnableEffectsBeautyFailed → const int: Description: Failed to turn on or turn off the beauty effect.
Cause: The beauty environment is not activated.
Solutions: Please call startEffectsEnv to start the beauty environment first.
PreprocessEnableEffectsEnvFailed → const int: Description: Failed to open or close the beauty environment.
Cause: The beauty environment was not turned on or off before the engine started.
Solutions: Please make sure to turn on or turn off the beauty environment before the engine starts, for example: before calling (startPreview), (startPublishingStream), (startPlayingStream), (createMediaPlayer) or (createAudioEffectPlayer).
PreprocessEnableSpeechEnhanceParamInvalid → const int: Description: Failed to enable speech enhancement.
Cause: speech enhancement level parameter is invalid.
Solutions: speech enhancement level ranges from 0 to 10. Use the correct parameter value.
PreprocessNotSupportEffectsBufferType → const int: Description: Effects Beauty does not support the currently set video data type.
Cause: enableCustomVideoProcessing interface, Windows platform only supports raw_data, Apple device only supports cv_pixel_buffer, Android platform supports gl_texture_2d.
Solutions: select the correct video data type.
PreprocessPreprocessUnknownError → const int: Description: Unknown error of the pre-processing module.
Solutions: Please contact ZEGO technical support.
PreprocessReverbEchoParamInvalid → const int: Description: Set reverberation echo parameters failed .
Cause: The reverberation echo parameters is invalid.
Solutions: Input the correct reverb echo parameters setReverbEchoParam.
PreprocessReverbEchoParamNull → const int: The reverberation echo parameters is null. Please check the input parameter.
PreprocessReverbParamDampingInvalid → const int: Description: Failed to set the reverberation parameters.
Cause: the reverberation damping parameter is invalid.
Solutions: The normal range of the reverberation damping parameter is 0.0 ~ 2.0
PreprocessReverbParamDryWetRatioInvalid → const int: Description: Failed to set the reverberation parameters.
Cause: The dry_wet_ratio parameter of the reverberation is invalid.
Solutions: The normal range of the dry_wet_ratio parameter of reverberation is greater than 0.0
PreprocessReverbParamNull → const int: The reverberation parameter is null. Please check the input parameter. This error code is deprecated.
PreprocessReverbParamReverberanceInvalid → const int: Description: Failed to set the reverberation parameters.
Cause: The reverberance parameter is invalid.
Solutions: The normal range of the reverberance parameter is 0.0 ~ 0.5
PreprocessReverbParamRoomSizeInvalid → const int: Description: Failed to set the reverberation parameters.
Cause: the reverberation room size parameter is invalid.
Solutions: The normal range of the reverberation room size parameter is 0.0 ~ 1.0
PreprocessSetEffectsParamFailed → const int: Description: Failed to set beauty parameters.
Cause: The beauty environment is not activated.
Solutions: Please call startEffectsEnv to start the beauty environment first.
PreprocessVirtualStereoAngleInvalid → const int: Description: Failed to start virtual stereo.
Cause: The virtual stereo angle parameter is invalid.
Solutions: The normal range of angle parameter is -1 ~ 360.
PreprocessVoiceChangerParamInvalid → const int: Description: Failed to set the voice changing parameters.
Cause: The param setting of the voice changing parameter is invalid.
Solutions: The normal range of parameter param is -12.0 ~ 12.0
PreprocessVoiceChangerParamNull → const int: The voice changer parameter is null. Please check the input parameter. This error code is deprecated.
PublisherAudioSideDataNull → const int: Description: Failed to send audio side info.
Cause: data is empty.
Solutions: Incoming non-empty data.
PublisherAudioSideDataTooLong → const int: Description: Failed to send audio side info.
Cause: The input data exceeds the length limit.
Solutions: The length of the sent audio side data should be less than 1024 bytes.
PublisherBitrateInvalid → const int: Description: Publishing failed due to wrong bitrate setting.
Cause: The set video bitrate, audio bitrate, or minimum video bitrate threshold for traffic control exceeds the upper limit.
Solutions: Please check if the bitrate value is in the correct unit (kbps).Adjust the bitrate setting.
PublisherDummyCaptureImagePathError → const int: Description: The specified path for displaying static images when the camera is turned off is incorrect.
Caution: The path may be misspelled or there may be no read permission.
Solutions: Please check if the designated image path is correct and if there is read permission.
PublisherEncryptionKeyInvalid → const int: Description: The publish stream encryption key is invalid.
Caution: The set encryption key length is not supported.
Solutions: The Publish-stream encryption key length to be 16/24/32 bytes.
PublisherErrorAlreadyDoPublish → const int: Description: Failed to publish the stream. The publish channel is already publishing streams.
Cause: The publish channel is already publishing streams.
Solutions: Please check the business logic to avoid repeating the publish for publish channel which is publishing.
PublisherErrorDispatchAuthError → const int: Description: Push-pull flow authentication is incorrect.
Caution: An appSign error was passed when creating the engine, or a Token error or timeout was passed when logging into the room.
Solutions: Pass the correct Token upon login, or invoke renewToken when recive onRoomTokenWillExpire callback.
PublisherErrorH265EncoderNotSupported → const int: Description: Streaming failed, H.265 encoding is not supported.
Cause: The hardware device does not support H.265 encoding, or the SDK does not include H.265 encoding module.
Solutions: Contact ZEGO technical support to confirm whether the SDK contains the H.265 encoding module, if the hardware device does not support it, it is recommended to upgrade the hardware.
PublisherErrorNetworkInterrupt → const int: Description:Stream publishing is temporarily interrupted and is retrying.
Cause: The network fluctuates or the network signal is bad.
Solutions: Please wait or check whether the network is normal.
PublisherErrorPublishWhenUsingMultiRoom → const int: Description: StartPlayingStream failed.
Caution: In multi-room mode, the publish-stream function is called incorrectly.
Solutions: In multi-room mode, A publish-stream function with the parameter 'ZegoPublisherConfig' needs to be called.
PublisherErrorPublishWithRoomIdIsNullWhenUsingMultiRoom → const int: Description: StartPlayingStream failed.
Caution: In multi-room mode, the publish-stream function is called incorrectly.
Solutions: In multi-room mode, A publish-stream function parameter 'roomID' cannot be empty.
PublisherErrorRepetitivePublishStream → const int: Description: Failed to publish the stream. The same stream already exists in the room.
Cause: The same stream already exists in the room.
Solutions: Replace with a new stream ID. Adjust the stream ID generation strategy to ensure uniqueness.
PublisherErrorRetryTimeout → const int: Description: Stream publish retry has exceeds the maximum retry time.
Cause: The the network signal is bad, and the maximum retry time is exceeded.
Solutions: Check the network status or switch to another network.
PublisherErrorServerForbid → const int: Description: Failed to publish the stream. Publishing of this stream is prohibited by backend configuration.
Cause: Publishing of this stream is prohibited by backend configuration.
Solutions: Contact ZEGO technical support to deal with it.
PublisherExtraInfoNull → const int: The extra info of the stream is null.
PublisherExtraInfoTooLong → const int: The extra info of the stream is too long. The maximum length should be less than 1024 bytes.
PublisherInnerError → const int: Description: Stream publishing failed due to system internal exceptions.
Caution: Stream publishing failed due to system internal exceptions.
Solutions: Please contact ZEGO technical support to solve the problem.
PublisherObjectSegmentationDeviceNotSupport → const int: Description: This device does not support object segmentation.
Caution: The device is not supported, or the object segmentation of multiple channels is enabled.
Solutions: Please change the device or only open the object segmentation of one channel.
PublisherObjectSegmentationImageLoadError → const int: Description: Object segmentation background loading error.
Caution: The background video or image path is incorrect, or the content is incorrect..
Solutions: Please set the correct background image or video.
PublisherObjectSegmentationNoAuth → const int: Description: Object segmentation unauthorized.
Caution: The appid is not configured with object segmentation.
Solutions: Please contact ZEGO technical support to configure the object segmentation function.
PublisherObjectSegmentationParamError → const int: Description: Object segmentation parameter error.
Caution: Object segmentation is set to green screen type, background blur is not allowed.
Solutions: Please use the correct parameters to enable object segmentation.
PublisherObjectSegmentationPerformanceWarning → const int: Description: The performance of object segmentation device is not enough.
Caution: The performance of device is not enough.
Solutions: Please replace the device.
PublisherPublishStreamFailed → const int: Description: Publishing failed due to no data in the stream.
Cause: No data in the stream.
Solutions: Check whether the video, audio capture module is working properly.
PublisherRtmpServerDisconnect → const int: Description: Failed to publish the stream. The connection to the RTMP server is interrupted.
Cause: The publish address is wrong, or the network signal is bad.
Solutions: Please check whether there is any problem with the network connection or the stream publishing URL.
PublisherSeiDataNull → const int: Description: Failed to send SEI.
Cause: data is empty.
Solutions: Incoming non-empty data.
PublisherSeiDataTooLong → const int: Description: Failed to send SEI.
Cause: The input data exceeds the length limit.
Solutions: The length of the sent SEI data should be less than 4096 bytes.
PublisherTakePublishStreamSnapshotFailed → const int: Description: Failed to take a screenshot of the publis stream screen.
Cause: The preview is stopped and the push is abnormal.
Solutions: Turn on preview or re-publish.
PublisherTrafficModeInvalid → const int: Description: The property param of the traffic control is set incorrectly.
Cause: The property param of the traffic control is less than 0 or exceeds all combinations.
Solutions: Check the settings of the property param of the traffic control.
PublisherUpdateCdnTargetError → const int: Description: Failed to update the relay CDN status.
Cause: The URL of the relay address is incorrect.
Solutions: Check whether the input URL is valid.
PublisherUpdateExtraInfoFailed → const int: Failed to update the extra info of the stream. Please check the network connection.
PublisherVideoEncoderFail → const int: Description: Video encoder error.
Caution: Video encoder error.
Solutions: Please contact ZEGO technical support.
PublisherVideoEncoderNoSupportted → const int: Description: Unsupported video encoder.
Caution: There is no selected video encoder in the current SDK.
Solutions: Please contact ZEGO technical support.
PublisherWatermarkLayoutInvalid → const int: Description: Incorrect watermark layout.
Caution: The layout area exceed the encoding resolution.
Solutions: Make sure the layout area cannot exceed the encoding resolution and call current interface.
PublisherWatermarkUrlInvalid → const int: Description: Failed to set publish watermark.
Cause: The incoming watermark path was entered incorrectly or the image format is not supported.
Solutions: Incoming the correct watermark path, only jpg and png image formats are supported.
PublisherWatermarkUrlNull → const int: Description: Failed to set publish watermark.
Cause: The incoming watermark path is empty.
Solutions: Incoming non-empty path.
PublisherWatermarkUrlTooLong → const int: Description: Failed to set publish watermark.
Cause: The incoming watermark path exceeds the byte size limit.
Solutions: The incoming watermark path should be less than 512 bytes.
RangeAudioExceedMaxCount → const int: Description: Failed to create range audio.
Cause: The instance exceeds the maximum limit.
Solutions: Use the used range audio example.
RangeAudioNoInstance → const int: Description: The function call failed.
Cause: No range auido instance has been created.
Solutions: Create a range audio instance.
RangeAudioNotSupportMultiRoom → const int: Description: Failed to create range voice.
Cause: Range voice cannot be used in multi-room mode.
Solutions: Set the single-party mode.
RangeAudioTeamIdInvalidCharacter → const int: Description: Failed to set the team ID.
Cause: The input user ID contains invalid characters.
Solutions: User ID can only contains numbers, English characters and '~', '!', '@', '#', '$', '%', '^', '&', '*', '(', ')', '_', '+', '=', '-', '`', ';', ',', '.', '<', '>', '/', ''.
RangeAudioTeamIdTooLong → const int: Description: Failed to set the team ID.
Cause: The input team ID exceeds the maximum limit.
Solutions: The input string is less than 64 bytes.
RangeSceneCallFunctionFailed → const int: Description: Calling function failed.
Cause: Illegal parameter or SDK does not contain RangeScene module.
Solutions: Please confirm whether the SDK contains the RangeScene module and check the parameters.
RangeSceneCoordinateOutOfRange → const int: Description: Coordinates out of range.
Cause: Coordinates out of scene range.
Solutions: Please pass in the correct coordinates.
RangeSceneExceedMaxCount → const int: Description: The number of RangeScene instances exceeds the maximum number allowed.
Cause: The number of RangeScene instances exceeds the maximum number allowed. Up to 1 instances can be created.
Solutions: RangeScene can create up to 1 instances, and make sure that the number of RangeScene instances is not exceeded the maximum limit.
RangeSceneInnerError → const int: Description: Failed due to internal system exceptions.
Cause: Unknown internal error.
Solutions: Contact ZEGO technical support to deal with it.
RangeSceneItemBindExceedLimit → const int: Description: The item binding user exceeds the maximum limit.
Cause: The item binding user exceeds the maximum limit.
Solutions: The item binding user exceeds the maximum limit. Please try again later.
RangeSceneItemCapacityExceedLimit → const int: Description: The binding capacity of the item exceeds the maximum limit.
Cause: The binding capacity of the item exceeds the maximum limit.
Solutions: Please use a capacity that does not exceed the maximum binding capacity to create an item.
RangeSceneItemCasFailed → const int: Description: The item has been operated by others.
Cause: The item has been operated by others.
Solutions: Please try again later.
RangeSceneItemHasBeenCreated → const int: Description: The item has been created.
Cause: The item has been created.
Solutions: The item has been created. You don't need to create it again.
RangeSceneItemNotBind → const int: Description: The item is not bound.
Cause: The item is not bound.
Solutions: Please bind the item first.
RangeSceneItemNotExist → const int: Description: The item does not exist.
Cause: The item does not exist.
Solutions: Please create an item first.
RangeSceneItemOutOfUserView → const int: Description: The item is beyond the user's view.
Cause: The item is beyond the user's view.
Solutions: Please operate the item within the user's view.
RangeSceneNetworkInterrupt → const int: Description: Scene connection is temporarily interrupted.
Cause: Possibly due to network problems.
Solutions: Please wait or check whether the network is normal.
RangeSceneNoInstance → const int: Description: The RangeScene instance not created.
Cause: The RangeScene instance not created.
Solutions: Create a RangeScene instance before using RangeScene createRangeScene.
RangeSceneNotLoginScene → const int: Description: Not login scene.
Cause: Not login scene.
Solutions: Please call loginScene to login scene.
RangeSceneNotSupport → const int: Description: Use not support feature.
Cause: Use the status synchronization interface when the status synchronization function is not enabled.
Solutions: To use the status synchronization interface, please enable the status synchronization function.
RangeSceneRetryTimeout → const int: Description: Scene login retry has exceeded the maximum retry time.
Cause: Possibly due to network problems.
Solutions: Please check whether the network is working or switch the network environment.
RangeSceneTeamExceedMaxCount → const int: Description: The number of joined RangeScene teams exceeds the maximum number allowed.
Cause: The number of joined RangeScene teams exceeds the maximum number allowed. Up to 5 are allowed by default.
Solutions: RangeScene teams can joined are up to 5, and make sure that the number of RangeScene teams joned is not exceeded the maximum limit.
RangeSceneTeamIdIncorrect → const int: Description: Team id not exist.
Cause: Use incorrect team id when leave team.
Solutions: Use correct team id when leave team.
RangeSceneTeamIdOccupied → const int: Description: Team id already been used.
Cause: The team id already been used when join team.
Solutions: Use a new team id to join team.
RangeSceneTokenExpire → const int: Description: Token expire.
Cause: Token expire or the generated Token validity period parameter type is incorrect.
Solutions: Regenerate the Token.
RangeSceneTokenIllegal → const int: Description: Token verification failed.
Cause: The parameters passed in during token generation are inconsistent with the SDK.
Solutions: Please use the correct token regenerated.
RangeSceneUserBindItemExceedLimit → const int: Description: The user has bound the item to the maximum limit.
Cause: The user has bound the item to the maximum limit.
Solutions: Please unbind some items that do not need to be operated temporarily.
RecorderCommonLiveroomApiError → const int: Description: Generic recording API error.
Cause: Invalid input parameter.
Solutions: Please check the record file path parameter or the record file format parameter is valid or not.
RecorderFileHandleExceptions → const int: Description: File handle exception.
Cause: File handle exception.
Solutions: Please contact ZEGO technical support.
RecorderFilePathTooLong → const int: Description: The specified recorded file path is too long.
Cause: The specified recorded file path is too long. The maximum length should be less than 1024 bytes.
Solutions: Please specify recorded file path less than 1024 bytes.
RecorderFileSuffixNameFormatNotSupport → const int: Description: the file name suffix is not supported.
Cause: the file name suffix is not supported.
Solutions: only support .mp4/.aac/.flv.
RecorderInnerVeError → const int: Description: SDK internal error.
Cause: Internal error.
Solutions: Please contact ZEGO technical support.
RecorderIoExceptions → const int: Description: I/O exception.
Cause: I/O exception.
Solutions: Please contact ZEGO technical support.
RecorderNoEnoughSpareCapacity → const int: Description: Insufficient disk space.
Cause: Insufficient disk space.
Solutions: Please ensure sufficient disk space.
RecorderOpenFileFailed → const int: Description: Open file failed.
Cause: Invalid file path or no permissions to read/write file.
Solutions: Please specify a valid file path and has proper permissions to read/write.
RecorderWriteFileError → const int: Description: Write file failed.
Cause: No permissions to write file.
Solutions: Please specify a valid file path and has proper permissions to write.
RoomAppCallApiTooFrequent → const int: Description: The interface is called more frequently than the upper limit.
Cause: This application calls this interface too often.
Solutions: Please control the frequency of calls to this interface. Please refer to https://docs.zegocloud.com/article/7612 for details.
RoomAppCallTooFrequent → const int: Description: Room signalling type interfaces are called more frequently than the upper limit.
Cause: This application calls the room signalling type interface too often. (e.g., sendCustomCommand sendBroadcastMessage)
Solutions: Please control the frequency of application calls to the room signalling type interface. Please refer to https://docs.zegocloud.com/article/7612 for details.
RoomConnectTemporaryBroken → const int: Description: Room connection is temporarily interrupted and is retrying.
Cause: Possibly due to network problems.
Solutions: Please wait or check whether the network is normal.
RoomCountExceed → const int: Description: The number of rooms the user attempted to log into simultaneously exceeds the maximum number allowed. Currently, a user can only be logged in to one main room.
Cause: In single-room mode, log in to multiple main rooms at the same time (including repeated calls to log in to the same room A without exiting room A).
Solutions: Please check is login multiple rooms simultaneously or not under single room mode.
RoomDisconnect → const int: Description: Room connection disconnected.
Cause: Possibly due to network problems.
Solutions: Please check whether the network is working or switch the network environment.
RoomErrorAuthenticationFailed → const int: Description: Room login authentication failed.
Cause: login set token error or token expired.
Solutions: set new token.
RoomErrorConnectFailed → const int: Description: Login failed, possibly due to network problems.
Cause: The current network is abnormal.
Solutions: It is recommended to switch the network to try.
RoomErrorExceedMaximumMember → const int: Description: The number of users logging into the room exceeds the maximum number of concurrent users configured for the room. (In the test environment, the default maximum number of users in the room is 50).
Cause: too much user in room.
Solutions: contact ZEGO technical support.
RoomErrorExceedMaximumRoomCount → const int: Description: in test environment The total number of rooms logged in at the same time exceeds the limit. (In the test environment, the maximum number of concurrent rooms is 10).
Cause: Too many rooms logged in at the same time.
Solutions: logout some room, login room.
RoomErrorLoginMultiRoomNotOpen → const int: Description: login failed, multi-room mode is not activate.
Cause: multi-room mode is not activate.
Solutions: please contact ZEGO technical support.
RoomErrorLoginTimeout → const int: Description: Login timed out, possibly due to network problems.
Cause: The current network delay is large.
Solutions: It is recommended to switch the network to try.
RoomErrorMultiRoomExceedMaximumRoomCount → const int: The total number of rooms logged in at the same time exceeds the limit, Please contact ZEGO technical support.
RoomInnerError → const int: Description: Room login failed due to internal system exceptions.
Cause: Unknown internal error.
Solutions: Contact ZEGO technical support to deal with it.
RoomKickedOut → const int: Description: The user was kicked out of the room.
Cause: Possibly because the same user ID is logged in on another device.
Solutions: Use a unique user ID.
RoomManualKickedOut → const int: Description: The business server has sent a signal to kick the user out of the room.
Cause: The business server has sent a signal to kick the user out of the room.
Solutions: Contact the business server for processing.
RoomMultiRoomDeprecated → const int: Description: This method has been deprecated after version 2.9.0.
Cause: This method has been deprecated after version 2.9.0.
Solutions: Please set setRoomMode to select multi-room mode before the engine started, and then call loginRoom to use multi-room.
RoomMultiRoomLoginUserNotSame → const int: Description: set multi room mode, userID or user name is different.
Cause: set multi room mode, login multi room use different user id or user name.
Solutions: Currently supports at most one key, if you need to support multiple, contact ZEGO technical support.
RoomMultiRoomRequired → const int: Description: Multi-room mode required.
Cause: Wrong room mode been used, e.g. single-room.
Solutions: Please use setRoomMode to select multi-room mode before the engine started.
RoomMultiRoomSwtichRoomInvalid → const int: Description: The switchRoom function cannot be used in multi-room mode.
Cause: multi room mode SDK not support.
Solutions: first call logoutRoom then call loginRoom.
RoomNoMultiRoomPermission → const int: Description: No multi-room permission.
Cause: No multi-room permission.
Solutions: Please contact ZEGO technical support to enable it.
RoomNoToken → const int: Description: This error code is returned if the user does not pass AppSign when creating the engine or Token when logging in to the room.
Cause: The Token is not transmitted in the login room.
Solutions: Set the Token when you login to the room.
RoomRenewTokenNoPublishAuthError → const int: Description: Update room Token has no push permission.
Cause: Token Does not have the push permission.
Solutions: Pass in the Token with the push permission.
RoomRetryTimeout → const int: Description: Room login retry has exceeded the maximum retry time.
Cause: Possibly due to network problems.
Solutions: Please check whether the network is working or switch the network environment.
RoomRoomCallApiTooFrequent → const int: Description: The frequency of calls to the interface by users in the room exceeds the upper limit.
Cause: The interface is called too often by users in the room.
Solutions: Please control the frequency of calls to this interface by users in the room. Please refer to https://docs.zegocloud.com/article/7612 for details.
RoomRoomExtraInfoExceedKeys → const int: Description: The number of keys set in the room additional message exceeds the maximum number of supported limits.
Cause: called setRoomExtraInfo Different keys have been passed in multiple times.
Solutions: please contact ZEGO technical support.
RoomRoomExtraInfoKeyEmpty → const int: The key for room extra info is empty.
The key for room extra info entered by the setRoomExtraInfo function is empty.
Please check the key for room extra info entered when calling the setRoomExtraInfo function to make sure it is not empty.
RoomRoomExtraInfoKeyTooLong → const int: The key for room extra info is too long.
The length of the key for room extra info input by the setRoomExtraInfo function is greater than or equal to 128 bytes.
Please check the key for room extra info entered when calling the setRoomExtraInfo function to ensure that its length is less than 128 bytes.
RoomRoomExtraInfoValueTooLong → const int: The value for room extra info is too long.
The length of the value for room extra info input by the setRoomExtraInfo function is greater than or equal to 128 bytes.
Please check the value for room extra info entered when calling the setRoomExtraInfo function to ensure that its length is less than 128 bytes.
RoomRoomIdHasBeenUsed → const int: Description: The room ID has been used by other login room interface. Current user can not login room with the room ID before release the room ID.
Cause: The room ID has been used by other login room interface.
Solutions: Logout the room with the same room ID first.
RoomRoomidIncorrect → const int: Description: Haven't login with the input room ID.
Cause: Haven't login with the input room ID before call logoutRoom or switchRoom or renewToken or setRoomExtraInfo.
Solutions: Please check has login with the room ID or not.
RoomRoomidInvalidCharacter → const int: The input room ID contains invalid characters.
The room ID entered by the loginRoom function contains illegal characters.
Please check the room ID entered when calling the loginRoom function to ensure that it is only contain numbers, English characters and '~', '!', '@', '#', '$', '%', '^', '&', '*', '(', ')', '_', '+', '=', '-', '`', ';', ',', '.', '<', '>', ''.
RoomRoomidNull → const int: The input room ID is empty.
The room ID entered by the loginRoom function is empty.
Please check the room ID entered when calling the loginRoom function to make sure it is not empty.
RoomRoomidTooLong → const int: The input room ID is too long.
The length of the room ID input by the loginRoom function is greater than or equal to 128 bytes.
Please check the room ID entered when calling the loginRoom function to ensure that its length is less than 128 bytes.
RoomRoomLicenseFeatureLimit → const int: Description: License authentication is used, and when using the relevant function, the license is configured with a functional limitation that does not allow the use of the function.
Solutions: Proofread the license's functionality limitations and use the functionality appropriately.
RoomRoomLoginCustomDataLengthError → const int: Description: The length of the custom data attached during login exceeded the limit. Procedure.
Cause: The login custom callback data is too long.
Solutions: The length of user-defined login data cannot exceed 128 bytes.
RoomRoomLoginLicenseExpired → const int: Description: login room used license auth, but the license is expired.
Solutions: Contact ZEGO technical support to deal with it.
RoomRoomLoginLicenseNotFound → const int: Description: login room used license auth, but can't find the license on zego server.
Cause: input wrong license.
Solutions: used the right license.
RoomRoomLoginOther → const int: Description: The user has logged in elsewhere.
Solutions: Check whether the user has logged in elsewhere.
RoomSessionExceptionKickedOut → const int: Description: The business server has sent a signal to kick the user out of the room.
Cause: The business server has sent a signal to kick the user out of the room because the internal session was abnormal.
Solutions: Contact the business server for processing.
RoomTokenAppidError → const int: Description: Token Appid error.
Cause: The generated Token Appid is inconsistent with the SDK used Appid, Or the appID type is incorrect.
Solutions: Use the Appid of the generated Token.
RoomTokenExpiredKickedOut → const int: Description: The business server has sent a signal to kick the user out of the room.
Cause: The business server has sent a signal to kick the user out of the room because the token expired.
Solutions: Please update the token in time after receiving the callback notification that the token is about to expire.
RoomTokenExpireError → const int: Description: Token expire.
Cause: Token expire Or the generated Token validity period parameter type is incorrect.
Solutions: Regenerate the Token.
RoomTokenFormatError → const int: Description: Token Format error.
Cause: The generated Token transmission parameter payload is in non-JSON format.
Solutions: The payload is correctly transmitted in json format when the Token is generated.
RoomTokenInnerError → const int: Description: Token inner error.
Cause: Unknown internal error.
Solutions: Contact ZEGO technical support to deal with it..
RoomTokenNoncetypeError → const int: Description: The Token Nonce parameter type is incorrect.
Cause: The nonce parameter type of the generated Token is incorrect.
Solutions: Ensure that nonce is int64 data.
RoomTokenUseridError → const int: Description: Token userID error.
Cause: The generated Token userID is inconsistent with the login used userID Or the userID type is incorrect.
Solutions: Login using the userID that generates the Token.
RoomTokenVersionError → const int: Description: Token version error.
Cause: Description The Token Version was generated incorrectly.
Solutions: Generate the Token with the correct version.
RoomUserIdInvalidCharacter → const int: Description: The input user ID contains invalid characters.
Cause: The input user ID contains invalid characters.
Solutions: User ID can only contains numbers, English characters and '~', '!', '@', '#', '$', '%', '^', '&', '*', '(', ')', '_', '+', '=', '-', '`', ';', ',', '.', '<', '>', ''.
RoomUserIdNull → const int: Description: The input user ID is empty.
Cause: The input user ID is empty.
Solutions: Please check the input user ID is empty or not.
RoomUserIdTooLong → const int: The input user ID is too long.
The length of the user ID input by the loginRoom function is greater than or equal to 64 bytes.
Please check the user ID entered when calling the loginRoom function to ensure that its length is less than 64 bytes.
RoomUserInBlacklist → const int: Description: If the user is in the server blacklist when logging in to the room, this error code will be returned, indicating that it is forbidden to log in to the room.
Cause: The user is currently in the server blacklist.
Solutions: Please contact ZEGO technical support.
RoomUserNameInvalidCharacter → const int: The input user name contains invalid characters.
The user name entered by the loginRoom function contains illegal characters.
Please check the user name entered when calling the loginRoom function to ensure that it is only contain numbers, English characters and '~', '!', '@', '#', '$', '%', '^', '&', '*', '(', ')', '_', '+', '=', '-', '`', ';', ',', '.', '<', '>', '/', ''.
RoomUserNameNull → const int: The input user name is empty.
The user name entered by the loginRoom function is empty.
Please check the user name entered when calling the loginRoom function to make sure it is not empty.
RoomUserNameTooLong → const int: The input user name is too long.
The length of the user name input by the loginRoom function is greater than or equal to 256 bytes.
Please check the user name entered when calling the loginRoom function to ensure that its length is less than 256 bytes.
RoomWrongLoginSequence → const int: Description: Wrong order of login rooms.
Cause: Log in multi room without log in the main room.
Solutions: Please log in to the main room with loginRoom before logging in to multi room.
RoomWrongLogoutSequence → const int: Description: Wrong order of logout rooms.
Cause: Log out the main room without log out multi room.
Solutions: Please log out of the multi room before logging out of the main room.
ScreenCaptureExceedMaxCount → const int: Description: Failed to create screen capture source.
Cause: The instance exceeds the maximum limit.
Solutions: Use an existing screen capture instance or destroy the previous instance.
ScreenCaptureInnerError → const int: Description: Failed due to internal system exceptions.
Cause: Unknown internal error.
Solutions: Contact ZEGO technical support to deal with it.
ScreenCaptureNoInstance → const int: Description: The function call failed.
Cause: No screen capture source instance has been created.
Solutions: Create a screen capture source instance.
ScreenCaptureNotSupport → const int: Description: Startup screen capture failed.
Cause: The current system version does not support screen capture.
Solutions: Use system version above Android 5 (API level 21).
ScreenCapturePermissionDenied → const int: Description: Startup screen capture failed.
Cause: The user refused to grant the app screen capture permission.
Solutions: Allow the app to capture screen permissions.
ScreenCaptureSdkNoModule → const int: Description: Startup screen capture failed.
Cause: Unable to share the screen module.
Solutions: Please introduce screen sharing module resources, or contact technical support.
UtilitiesAlreadyStartDumpDataError → const int: Description: Already start dumping data.
Cause: Call startDumpData repeatedly.
Solutions: Stop or cancel the previous dump data task.
UtilitiesCreateDumpDataFolderError → const int: Description: Failed to create dump data folder.
Cause: No read and write permission or the disk is full.
Solutions: Check to see if there is still space on the disk.
UtilitiesDumpDataExceedMaxSizeError → const int: Description: The dump data exceeding the maximum upload limit error.
Cause: The dump data is too large to exceed the limit of the upload module.
Solutions: Please contact ZEGO technical support and report to ZEGO manually.
UtilitiesNetworkConnectivityTestFailed → const int: Description: Network connectivity test failed.
Cause: Not connected to the network.
Solutions: Please check if you can access the Internet properly.
UtilitiesNetworkToolConnectServerFailed → const int: Description: Network speed test connection failure.
Cause: Not connected to the network.
Solutions: Please check if you can access the Internet properly.
UtilitiesNetworkToolEngineDenied → const int: Description: The server side ends the network speed test.
Cause: Network speed test time is too long.
Solutions: Please stop network speed test in 30 seconds.
UtilitiesNetworkToolInnerError → const int: Description: Network speed test internal error.
Cause: Internal error.
Solutions: Please contact ZEGO technical support.
UtilitiesNetworkToolRtpTimeoutError → const int: Description: RTP timeout.
Cause: Not connected to the network.
Solutions: Please check if you can access the Internet properly.
UtilitiesNetworkToolStoppedByPlayingStream → const int: Description: Network speed test stopped.
Cause: Network speed test not stopped before playing stream.
Solutions: Please stop network speed test(stopNetworkSpeedTest) before playing stream.
UtilitiesNetworkToolStoppedByPublishingStream → const int: Description: Network speed test stopped.
Cause: Network speed test not stopped before publishing stream.
Solutions: Please stop network speed test(stopNetworkSpeedTest) before publishing stream.
UtilitiesNoDumpDataError → const int: Description: No dump data.
Cause: Error occurred in AV engine.
Solutions: Please contact ZEGO technical support.
UtilitiesPerformanceMonitorIntervalInvalid → const int: Description: Invalid system performance monitoring interval.
Cause: The set system performance monitoring interval is out of range.
Solutions: Please check if the system performance monitoring interval is out of range or not, valid range is 1000, 10000.
UtilitiesStartDumpAudioDataFailed → const int: Description: Fail to dump data.
Cause: Error occurred in AV engine.
Solutions: Please contact ZEGO technical support.
UtilitiesStopByLoginRoom → const int: Description: Login to the room causes the network test to stop.
Cause: Already logged in to the room.
Solutions: Since the network test will take up bandwidth, please do it before logging in to the room.
UtilitiesUploadModuleInnerError → const int: Description: Internal error of upload module.
Cause: Error occurred in upload module.
Solutions: Please contact ZEGO technical support.

ZegoErrorCode class

Constructors

Properties

Methods

Operators

Constants

zego_express_engine library