zego-express-engine-reactnative
Version:
React Native Zego Express Video for Android & iOS
376 lines • 105 kB
TypeScript
export declare enum ZegoErrorCode {
/** Execution successful. */
CommonSuccess = 0,
/** Description: The engine is not initialized and cannot call non-static functions. <br>Cause: Engine not created.<br>Solutions: Please call the [createEngine] function to create the engine first, and then call the current function. */
CommonEngineNotCreate = 1000001,
/** Description: Not logged in to the room, unable to support function implementation. <br>Cause: Not logged in to the room.<br>Solutions: Please call [loginRoom] to log in to the room first, and use related functions during the online period after entering the room. */
CommonNotLoginRoom = 1000002,
/** Description: The audio and video module of the engine is not started and cannot support function realization. <br>Cause: Audio and video modules with no engine started.<br>Solutions: Please call [startPreviewView] [startPublishingStream] [startPlayingStream] to start the audio and video module first. */
CommonEngineNotStarted = 1000003,
/** Description: Call functions that are not supported on the current system/platform. <br>Cause: For example, calling the function of setting the Android context environment on a non-Android system.<br>Solutions: Check if the system environment matches. */
CommonUnsupportedPlatform = 1000006,
/** Description: Invalid Android context. <br>Cause: Not set or set the wrong Android context environment.<br>Solutions: Set the correct Android context. */
CommonInvalidAndroidEnvironment = 1000007,
/** Description: `setEventHandler` has been called to set the handler, please do not set it repeatedly. <br>Cause: Call `setEventHandler` repeatedly to set the handler.<br>Solutions: If you need to repeat the settings, please call `setEventHandler` first to empty the previous handler. */
CommonEventHandlerExists = 1000008,
/** Description: The current SDK does not support this feature. <br>Cause: The SDK version used does not include this feature.<br>Solutions: Please contact ZEGO technical support. */
CommonSdkNoModule = 1000010,
/** Description: The input streamID is too long. <br>Cause: The length of the streamID parameter passed in when calling [startPublishingStream] or [startPlayingStream] exceeds the limit. <br>Solutions: The streamID should be less than 256 bytes. */
CommonStreamIdTooLong = 1000014,
/** Description: The input StreamID is null. <br>Cause: The streamID parameter passed in when calling [startPublishingStream] or [startPlayingStream] is null or empty string. <br>Solutions: Check whether the streamID parameter passed in when calling the function is normal. */
CommonStreamIdNull = 1000015,
/** Description: The input streamID contains invalid characters. <br>Cause: The streamID parameter passed in when calling [startPublishingStream] or [startPlayingStream] contains invalid characters. <br>Solutions: Check whether the streamID parameter passed in when calling the function is normal, only support numbers, English characters and '-', '_'. */
CommonStreamIdInvalidCharacter = 1000016,
/** Description: Illegal param.<br>Cause: The parameter is empty, or the parameter is an illegal value. <br>Solutions: Please check param when entered function to make sure it is correct. */
CommonIllegalParam = 1000017,
/** Description: The Input CDN URL is too long. <br>Cause: The length of URL parameter passed in when calling [enablePublishDirectToCDN] or [startPlayingStream] exceeds the limit. <br>Solutions: URL length should be less than 1024 bytes. */
CommonCdnUrlTooLong = 1000018,
/** Description: The Input CDN auth param is too long. <br>Cause: The length of auth parameter passed in when calling [enablePublishDirectToCDN] or [startPlayingStream] exceeds the limit. <br>Solutions: Auth param length should be less than 1024 bytes. */
CommonCdnAuthParamTooLong = 1000019,
/** Description: When login room or login scene, userID or user name is different. <br>Cause: Login room, login scene use different user id or user name. <br> Solutions: Use same user id and user name when login room, login scene. */
CommonUserNotSame = 1000020,
/** Description: This AppID has been removed from production. <br>Solutions: Please check the status of the AppID on the ZEGO official website console or contact ZEGO technical support. */
CommonAppOfflineError = 1000037,
/** Description: The backend configuration of the server is incorrect. <br>Cause: 1. The domain name configuration is incorrect; 2. The media network is abnormal; 3. The media network link is empty. <br>Solutions: Please contact ZEGO technical support. */
CommonAppFlexiableConfigError = 1000038,
/** Description: Server access denied. <br>Cause: 1.The APP has enabled the restriction of access from foreign IP addresses, and the current client is outside of the domain. <br>Solutions: Please contact ZEGO technical support. */
CommonAppAccessDeniedError = 1000039,
/** Description: Incorrect CDN address. <br>Cause: The set CDN URL is not a standard RTMP or FLV protocol. <br>Solutions: Please check the supported protocol and format. */
CommonCdnUrlInvalid = 1000055,
/** DNS resolution failed. Please check network configurations. This error code is deprecated. */
CommonDnsResolveError = 1000060,
/** Server dispatching exception. Please contact ZEGO technical support to solve the problem. This error code is deprecated. */
CommonDispatchError = 1000065,
/** Description: The engine audio and video module has been activated, and this setting is not supported. <br>Cause: Only supports setting before starting the audio and video module of the engine. <br>Solutions: Please set it before calling [startPreviewView] [startPublishingStream] [startPlayingStream] to start the audio and video module. */
CommonConfigAfterEngineStarted = 1000066,
/** Description: The room is logged in, this setting is not supported. <br>Cause: Only supports setting before logging into the room. <br>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. */
CommonConfigAfterRoomLoggedIn = 1000067,
/** Description: Failed to load SDK dynamic library. <br>Cause: Incorrect SDK dynamic path passed in. <br>Solutions: Please pass in the correct SDK dynamic library path. */
CommonLoadLibraryFailed = 1000070,
/** Description: Failed to obtain SDK export function when loading SDK dynamic library. <br>Cause: SDK dynamic library version does not match. <br>Solutions: Please load the matching version of the SDK dynamic library. */
CommonLoadLibraryFuncNotFound = 1000071,
/** Description: This call is not supported. <br>Cause: ZEGOEXP_EXPLICIT macro is not enabled. <br>Solutions: Please add the ZEGOEXP_EXPLICIT macro to the preprocessor. */
CommonLoadLibraryNotSupport = 1000072,
/** Description: SDK internal null pointer error. <br>Cause: The Android JVM environment is abnormal. <br>Solutions: Please check whether the Android JVM environment is normal or contact ZEGO technical support. */
CommonInnerNullptr = 1000090,
/** AppID cannot be 0. Please check if the AppID is correct. */
EngineAppidZero = 1001000,
/** The length of the input AppSign must be 64 bytes. */
EngineAppsignInvalidLength = 1001001,
/** The input AppSign contains invalid characters. Only '0'-'9', 'a'-'f', 'A'-'F' are valid. */
EngineAppsignInvalidCharacter = 1001002,
/** The input AppSign is empty. */
EngineAppsignNull = 1001003,
/** Description: Authentication failed. <br>Cause: Incorrect AppID; using AppID in wrong environment. <br>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. */
EngineAppidIncorrectOrNotOnline = 1001004,
/** Description: Authentication failed. <br>Cause: Incorrect AppSign. <br>Solutions: Please check AppSign is correct or not on ZEGO manage console. */
EngineAppsignIncorrect = 1001005,
/** The input License is empty. */
EngineLicenseNull = 1001006,
/** Description: No write permission to the log file. <br>Cause: App has no write permission to log file folder. <br>Solutions: Please check has grant write permission to App or not; check log folder is protected or not. */
EngineLogNoWritePermission = 1001014,
/** Description: The log file path is too long. <br>Cause: The length of log file path exceeds limit. <br>Solutions: Please check the length of log file path. */
EngineLogPathTooLong = 1001015,
/** Description: Set room mode failed. <br>Cause: Set room mode after initialize the SDK. <br>Solutions: Please set room mode before initialize the SDK. */
EngineSetRoomModeErrorTime = 1001020,
/** Description: Set geo fence failed. <br>Cause: Set geo fence after initialize the SDK. <br>Solutions: Please set geo fence before initialize the SDK. */
EngineSetGeoFenceErrorTime = 1001021,
/** Description: The experimental API json parameter parsing failed. <br>Cause: Invalid json format; wrong function name or parameter. <br>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. */
EngineExperimentalJsonStrInvalid = 1001091,
/** 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.<br>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). <br>Solutions: Please check is login multiple rooms simultaneously or not under single room mode. */
RoomCountExceed = 1002001,
/** Description: Haven't login with the input room ID.<br>Cause: Haven't login with the input room ID before call [logoutRoom] or [switchRoom] or [renewToken] or [setRoomExtraInfo]. <br>Solutions: Please check has login with the room ID or not. */
RoomRoomidIncorrect = 1002002,
/** Description: The input user ID is empty.<br>Cause: The input user ID is empty. <br>Solutions: Please check the input user ID is empty or not. */
RoomUserIdNull = 1002005,
/** Description: The input user ID contains invalid characters.<br>Cause: The input user ID contains invalid characters. <br>Solutions: User ID can only contains numbers, English characters and '~', '!', '@', '#', '$', '%', '^', '&', '*', '(', ')', '_', '+', '=', '-', '`', ';', ',', '.', '<', '>', '\'. */
RoomUserIdInvalidCharacter = 1002006,
/** The input user ID is too long. <br>The length of the user ID input by the [loginRoom] function is greater than or equal to 64 bytes. <br>Please check the user ID entered when calling the [loginRoom] function to ensure that its length is less than 64 bytes. */
RoomUserIdTooLong = 1002007,
/** The input user name is empty. <br>The user name entered by the [loginRoom] function is empty. <br>Please check the user name entered when calling the [loginRoom] function to make sure it is not empty. */
RoomUserNameNull = 1002008,
/** The input user name contains invalid characters. <br>The user name entered by the [loginRoom] function contains illegal characters.<br>Please check the user name entered when calling the [loginRoom] function to ensure that it is only contain numbers, English characters and '~', '!', '@', '#', '$', '%', '^', '&', '*', '(', ')', '_', '+', '=', '-', '`', ';', ',', '.', '<', '>', '/', '\'. */
RoomUserNameInvalidCharacter = 1002009,
/** The input user name is too long. <br>The length of the user name input by the [loginRoom] function is greater than or equal to 256 bytes. <br>Please check the user name entered when calling the [loginRoom] function to ensure that its length is less than 256 bytes. */
RoomUserNameTooLong = 1002010,
/** The input room ID is empty. <br>The room ID entered by the [loginRoom] function is empty. <br>Please check the room ID entered when calling the [loginRoom] function to make sure it is not empty. */
RoomRoomidNull = 1002011,
/** The input room ID contains invalid characters. <br>The room ID entered by the [loginRoom] function contains illegal characters.<br>Please check the room ID entered when calling the [loginRoom] function to ensure that it is only contain numbers, English characters and '~', '!', '@', '#', '$', '%', '^', '&', '*', '(', ')', '_', '+', '=', '-', '`', ';', ',', '.', '<', '>', '\'. */
RoomRoomidInvalidCharacter = 1002012,
/** The input room ID is too long. <br>The length of the room ID input by the [loginRoom] function is greater than or equal to 128 bytes. <br>Please check the room ID entered when calling the [loginRoom] function to ensure that its length is less than 128 bytes. */
RoomRoomidTooLong = 1002013,
/** The key for room extra info is empty. <br>The key for room extra info entered by the [setRoomExtraInfo] function is empty. <br>Please check the key for room extra info entered when calling the [setRoomExtraInfo] function to make sure it is not empty. */
RoomRoomExtraInfoKeyEmpty = 1002014,
/** The key for room extra info is too long. <br>The length of the key for room extra info input by the [setRoomExtraInfo] function is greater than or equal to 128 bytes. <br>Please check the key for room extra info entered when calling the [setRoomExtraInfo] function to ensure that its length is less than 128 bytes. */
RoomRoomExtraInfoKeyTooLong = 1002015,
/** The value for room extra info is too long. <br>The length of the value for room extra info input by the [setRoomExtraInfo] function is greater than or equal to 128 bytes. <br>Please check the value for room extra info entered when calling the [setRoomExtraInfo] function to ensure that its length is less than 128 bytes. */
RoomRoomExtraInfoValueTooLong = 1002016,
/** Description: The number of keys set in the room additional message exceeds the maximum number of supported limits. <br>Cause: called setRoomExtraInfo Different keys have been passed in multiple times. <br> Solutions: please contact ZEGO technical support. */
RoomRoomExtraInfoExceedKeys = 1002017,
/** Description: set multi room mode, userID or user name is different. <br>Cause: set multi room mode, login multi room use different user id or user name. <br> Solutions: Currently supports at most one key, if you need to support multiple, contact ZEGO technical support. */
RoomMultiRoomLoginUserNotSame = 1002018,
/** Description: The [switchRoom] function cannot be used in multi-room mode. <br>Cause: multi room mode SDK not support. <br> Solutions: first call [logoutRoom] then call [loginRoom]. */
RoomMultiRoomSwtichRoomInvalid = 1002019,
/** Description: Login failed, possibly due to network problems. <br>Cause: The current network is abnormal. <br> Solutions: It is recommended to switch the network to try. */
RoomErrorConnectFailed = 1002030,
/** Description: Login timed out, possibly due to network problems. <br>Cause: The current network delay is large. <br> Solutions: It is recommended to switch the network to try. */
RoomErrorLoginTimeout = 1002031,
/** Description: Room login authentication failed. <br>Cause: login set token error or token expired. <br> Solutions: set new token. */
RoomErrorAuthenticationFailed = 1002033,
/** 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). <br>Cause: too much user in room. <br> Solutions: contact ZEGO technical support. */
RoomErrorExceedMaximumMember = 1002034,
/** 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). <br>Cause: Too many rooms logged in at the same time. <br> Solutions: logout some room, login room. */
RoomErrorExceedMaximumRoomCount = 1002035,
/** Description: login failed, multi-room mode is not activate. <br>Cause: multi-room mode is not activate. <br> Solutions: please contact ZEGO technical support. */
RoomErrorLoginMultiRoomNotOpen = 1002036,
/** The total number of rooms logged in at the same time exceeds the limit, Please contact ZEGO technical support. */
RoomErrorMultiRoomExceedMaximumRoomCount = 1002037,
/** Description: The user was kicked out of the room. <br>Cause: Possibly because the same user ID is logged in on another device. <br>Solutions: Use a unique user ID. */
RoomKickedOut = 1002050,
/** Description: Room connection is temporarily interrupted and is retrying. <br>Cause: Possibly due to network problems. <br>Solutions: Please wait or check whether the network is normal. */
RoomConnectTemporaryBroken = 1002051,
/** Description: Room connection disconnected. <br>Cause: Possibly due to network problems. <br>Solutions: Please check whether the network is working or switch the network environment. */
RoomDisconnect = 1002052,
/** Description: Room login retry has exceeded the maximum retry time. <br>Cause: Possibly due to network problems. <br>Solutions: Please check whether the network is working or switch the network environment. */
RoomRetryTimeout = 1002053,
/** Description: The business server has sent a signal to kick the user out of the room. <br>Cause: The business server has sent a signal to kick the user out of the room. <br>Solutions: Contact the business server for processing. */
RoomManualKickedOut = 1002055,
/** Description: The business server has sent a signal to kick the user out of the room. <br>Cause: The business server has sent a signal to kick the user out of the room because the token expired. <br>Solutions: Please update the token in time after receiving the callback notification that the token is about to expire. */
RoomTokenExpiredKickedOut = 1002056,
/** Description: The business server has sent a signal to kick the user out of the room. <br>Cause: The business server has sent a signal to kick the user out of the room because the internal session was abnormal. <br>Solutions: Contact the business server for processing. */
RoomSessionExceptionKickedOut = 1002057,
/** Description: Wrong order of login rooms. <br>Cause: Log in multi room without log in the main room. <br>Solutions: Please log in to the main room with `loginRoom` before logging in to multi room. */
RoomWrongLoginSequence = 1002061,
/** Description: Wrong order of logout rooms. <br>Cause: Log out the main room without log out multi room. <br>Solutions: Please log out of the multi room before logging out of the main room. */
RoomWrongLogoutSequence = 1002062,
/** Description: No multi-room permission. <br>Cause: No multi-room permission. <br>Solutions: Please contact ZEGO technical support to enable it. */
RoomNoMultiRoomPermission = 1002063,
/** 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. <br>Cause: The room ID has been used by other login room interface. <br>Solutions: Logout the room with the same room ID first. */
RoomRoomIdHasBeenUsed = 1002064,
/** Description: This method has been deprecated after version 2.9.0. <br>Cause: This method has been deprecated after version 2.9.0. <br>Solutions: Please set [setRoomMode] to select multi-room mode before the engine started, and then call [loginRoom] to use multi-room. */
RoomMultiRoomDeprecated = 1002065,
/** 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. <br>Cause: The user is currently in the server blacklist. <br>Solutions: Please contact ZEGO technical support. */
RoomUserInBlacklist = 1002066,
/** 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. <br>Cause: The Token is not transmitted in the login room. <br>Solutions: Set the [Token] when you login to the room. */
RoomNoToken = 1002067,
/** Description: The interface is called more frequently than the upper limit. <br>Cause: This application calls this interface too often. <br>Solutions: Please control the frequency of calls to this interface. Please refer to https://docs.zegocloud.com/article/7612 for details. */
RoomAppCallApiTooFrequent = 1002071,
/** Description: The frequency of calls to the interface by users in the room exceeds the upper limit. <br>Cause: The interface is called too often by users in the room. <br>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. */
RoomRoomCallApiTooFrequent = 1002072,
/** Description: Room signalling type interfaces are called more frequently than the upper limit. <br>Cause: This application calls the room signalling type interface too often. (e.g., [sendCustomCommand] [sendBroadcastMessage]) <br>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. */
RoomAppCallTooFrequent = 1002073,
/** Description: Token inner error. <br>Cause: Unknown internal error. <br>Solutions: Contact ZEGO technical support to deal with it.. */
RoomTokenInnerError = 1002074,
/** Description: Token Format error. <br>Cause: The generated Token transmission parameter payload is in non-JSON format. <br>Solutions: The payload is correctly transmitted in json format when the Token is generated. */
RoomTokenFormatError = 1002075,
/** Description: Token Appid error. <br>Cause: The generated Token Appid is inconsistent with the SDK used Appid, Or the appID type is incorrect. <br>Solutions: Use the Appid of the generated Token. */
RoomTokenAppidError = 1002076,
/** Description: Token userID error. <br>Cause: The generated Token userID is inconsistent with the login used userID Or the userID type is incorrect. <br>Solutions: Login using the userID that generates the Token. */
RoomTokenUseridError = 1002077,
/** Description: Token expire. <br>Cause: Token expire Or the generated Token validity period parameter type is incorrect. <br>Solutions: Regenerate the Token. */
RoomTokenExpireError = 1002078,
/** Description: Token version error. <br>Cause: Description The Token Version was generated incorrectly. <br>Solutions: Generate the Token with the correct version. */
RoomTokenVersionError = 1002079,
/** Description: The Token Nonce parameter type is incorrect. <br>Cause: The nonce parameter type of the generated Token is incorrect. <br>Solutions: Ensure that nonce is int64 data. */
RoomTokenNoncetypeError = 1002080,
/** Description: Multi-room mode required. <br>Cause: Wrong room mode been used, e.g. single-room. <br>Solutions: Please use [setRoomMode] to select multi-room mode before the engine started. */
RoomMultiRoomRequired = 1002081,
/** Description: Update room Token has no push permission. <br>Cause: Token Does not have the push permission. <br>Solutions: Pass in the Token with the push permission. */
RoomRenewTokenNoPublishAuthError = 1002082,
/** Description: The length of the custom data attached during login exceeded the limit. Procedure. <br>Cause: The login custom callback data is too long. <br>Solutions: The length of user-defined login data cannot exceed 128 bytes. */
RoomRoomLoginCustomDataLengthError = 1002083,
/** Description: login room used license auth, but can't find the license on zego server. <br>Cause: input wrong license. <br>Solutions: used the right license. */
RoomRoomLoginLicenseNotFound = 1002084,
/** Description: login room used license auth, but the license is expired. <br>Solutions: Contact ZEGO technical support to deal with it. */
RoomRoomLoginLicenseExpired = 1002085,
/** Description: The user has logged in elsewhere. <br>Solutions: Check whether the user has logged in elsewhere. */
RoomRoomLoginOther = 1002086,
/** 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. <br>Solutions: Proofread the license's functionality limitations and use the functionality appropriately. */
RoomRoomLicenseFeatureLimit = 1002087,
/** Description: Room login failed due to internal system exceptions.<br>Cause: Unknown internal error.<br>Solutions: Contact ZEGO technical support to deal with it. */
RoomInnerError = 1002099,
/** Description: Publishing failed due to no data in the stream.<br>Cause: No data in the stream.<br>Solutions: Check whether the video, audio capture module is working properly. */
PublisherPublishStreamFailed = 1003001,
/** Description: Publishing failed due to wrong bitrate setting.<br>Cause: The set video bitrate, audio bitrate, or minimum video bitrate threshold for traffic control exceeds the upper limit.<br>Solutions: Please check if the bitrate value is in the correct unit (kbps).Adjust the bitrate setting. */
PublisherBitrateInvalid = 1003002,
/** Description: The property param of the traffic control is set incorrectly.<br>Cause: The property param of the traffic control is less than 0 or exceeds all combinations.<br>Solutions: Check the settings of the property param of the traffic control. */
PublisherTrafficModeInvalid = 1003005,
/** Description: Streaming failed, H.265 encoding is not supported.<br>Cause: The hardware device does not support H.265 encoding, or the SDK does not include H.265 encoding module.<br>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. */
PublisherErrorH265EncoderNotSupported = 1003010,
/** Description: The performance of object segmentation device is not enough.<br>Caution: The performance of device is not enough.<br>Solutions: Please replace the device. */
PublisherObjectSegmentationPerformanceWarning = 1003011,
/** Description: This device does not support object segmentation.<br>Caution: The device is not supported, or the object segmentation of multiple channels is enabled.<br>Solutions: Please change the device or only open the object segmentation of one channel. */
PublisherObjectSegmentationDeviceNotSupport = 1003012,
/** Description: Object segmentation unauthorized.<br>Caution: The appid is not configured with object segmentation.<br>Solutions: Please contact ZEGO technical support to configure the object segmentation function. */
PublisherObjectSegmentationNoAuth = 1003013,
/** Description: Object segmentation parameter error.<br>Caution: Object segmentation is set to green screen type, background blur is not allowed.<br>Solutions: Please use the correct parameters to enable object segmentation. */
PublisherObjectSegmentationParamError = 1003014,
/** Description: Object segmentation background loading error.<br>Caution: The background video or image path is incorrect, or the content is incorrect..<br>Solutions: Please set the correct background image or video. */
PublisherObjectSegmentationImageLoadError = 1003015,
/** Description:Stream publishing is temporarily interrupted and is retrying. <br>Cause: The network fluctuates or the network signal is bad.<br>Solutions: Please wait or check whether the network is normal. */
PublisherErrorNetworkInterrupt = 1003020,
/** Description: Stream publish retry has exceeds the maximum retry time.<br>Cause: The the network signal is bad, and the maximum retry time is exceeded.<br>Solutions: Check the network status or switch to another network. */
PublisherErrorRetryTimeout = 1003021,
/** Description: Failed to publish the stream. The publish channel is already publishing streams.<br>Cause: The publish channel is already publishing streams.<br>Solutions: Please check the business logic to avoid repeating the publish for publish channel which is publishing. */
PublisherErrorAlreadyDoPublish = 1003023,
/** Description: Failed to publish the stream. Publishing of this stream is prohibited by backend configuration.<br>Cause: Publishing of this stream is prohibited by backend configuration.<br>Solutions: Contact ZEGO technical support to deal with it. */
PublisherErrorServerForbid = 1003025,
/** Description: Failed to publish the stream. The same stream already exists in the room.<br>Cause: The same stream already exists in the room.<br>Solutions: Replace with a new stream ID. Adjust the stream ID generation strategy to ensure uniqueness. */
PublisherErrorRepetitivePublishStream = 1003028,
/** Description: Failed to publish the stream. The connection to the RTMP server is interrupted.<br>Cause: The publish address is wrong, or the network signal is bad.<br>Solutions: Please check whether there is any problem with the network connection or the stream publishing URL. */
PublisherRtmpServerDisconnect = 1003029,
/** Description: Failed to take a screenshot of the publis stream screen. <br>Cause: The preview is stopped and the push is abnormal. <br>Solutions: Turn on preview or re-publish. */
PublisherTakePublishStreamSnapshotFailed = 1003030,
/** Description: Failed to update the relay CDN status. <br>Cause: The URL of the relay address is incorrect. <br>Solutions: Check whether the input URL is valid. */
PublisherUpdateCdnTargetError = 1003040,
/** Description: Failed to send SEI. <br>Cause: data is empty. <br>Solutions: Incoming non-empty data. */
PublisherSeiDataNull = 1003043,
/** Description: Failed to send SEI. <br>Cause: The input data exceeds the length limit. <br>Solutions: The length of the sent SEI data should be less than 4096 bytes. */
PublisherSeiDataTooLong = 1003044,
/** Description: Failed to send audio side info. <br>Cause: data is empty. <br>Solutions: Incoming non-empty data. */
PublisherAudioSideDataNull = 1003045,
/** Description: Failed to send audio side info. <br>Cause: The input data exceeds the length limit. <br>Solutions: The length of the sent audio side data should be less than 1024 bytes. */
PublisherAudioSideDataTooLong = 1003046,
/** The extra info of the stream is null. */
PublisherExtraInfoNull = 1003050,
/** The extra info of the stream is too long. The maximum length should be less than 1024 bytes. */
PublisherExtraInfoTooLong = 1003051,
/** Failed to update the extra info of the stream. Please check the network connection. */
PublisherUpdateExtraInfoFailed = 1003053,
/** Description: Failed to set publish watermark. <br>Cause: The incoming watermark path is empty. <br>Solutions: Incoming non-empty path. */
PublisherWatermarkUrlNull = 1003055,
/** Description: Failed to set publish watermark. <br>Cause: The incoming watermark path exceeds the byte size limit. <br>Solutions: The incoming watermark path should be less than 512 bytes. */
PublisherWatermarkUrlTooLong = 1003056,
/** Description: Failed to set publish watermark. <br>Cause: The incoming watermark path was entered incorrectly or the image format is not supported. <br>Solutions: Incoming the correct watermark path, only `jpg` and `png` image formats are supported. */
PublisherWatermarkUrlInvalid = 1003057,
/** Description: Incorrect watermark layout.<br>Caution: The layout area exceed the encoding resolution.<br>Solutions: Make sure the layout area cannot exceed the encoding resolution and call current interface. */
PublisherWatermarkLayoutInvalid = 1003058,
/** Description: The publish stream encryption key is invalid.<br>Caution: The set encryption key length is not supported.<br>Solutions: The Publish-stream encryption key length to be 16/24/32 bytes. */
PublisherEncryptionKeyInvalid = 1003060,
/** Description: StartPlayingStream failed.<br>Caution: In multi-room mode, the publish-stream function is called incorrectly.<br>Solutions: In multi-room mode, A publish-stream function with the parameter 'ZegoPublisherConfig' needs to be called. */
PublisherErrorPublishWhenUsingMultiRoom = 1003070,
/** Description: StartPlayingStream failed.<br>Caution: In multi-room mode, the publish-stream function is called incorrectly.<br>Solutions: In multi-room mode, A publish-stream function parameter 'roomID' cannot be empty. */
PublisherErrorPublishWithRoomIdIsNullWhenUsingMultiRoom = 1003071,
/** Description: Push-pull flow authentication is incorrect. <br>Caution: An [appSign] error was passed when creating the engine, or a Token error or timeout was passed when logging into the room. <br>Solutions: Pass the correct [Token] upon login, or invoke [renewToken] when recive [onRoomTokenWillExpire] callback. */
PublisherErrorDispatchAuthError = 1003072,
/** Description: The specified path for displaying static images when the camera is turned off is incorrect. <br>Caution: The path may be misspelled or there may be no read permission.<br>Solutions: Please check if the designated image path is correct and if there is read permission. */
PublisherDummyCaptureImagePathError = 1003073,
/** Description: Unsupported video encoder.<br>Caution: There is no selected video encoder in the current SDK.<br>Solutions: Please contact ZEGO technical support. */
PublisherVideoEncoderNoSupportted = 1003080,
/** Description: Video encoder error.<br>Caution: Video encoder error.<br>Solutions: Please contact ZEGO technical support. */
PublisherVideoEncoderFail = 1003081,
/** Description: Stream publishing failed due to system internal exceptions.<br>Caution: Stream publishing failed due to system internal exceptions.<br>Solutions: Please contact ZEGO technical support to solve the problem. */
PublisherInnerError = 1003099,
/** Description: Stream playing failed.<br>Caution: Possibly due to no data in the stream.<br>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. */
PlayerPlayStreamFailed = 1004001,
/** Description: Stream playing failed.<br>Caution: The stream does not exist.<br>Solutions: Please check whether the remote end publish is indeed successful, or whether the publish and play environment are inconsistent. */
PlayerPlayStreamNotExist = 1004002,
/** Description: Play stream authentication is incorrect. <br>Caution: The [Token] error or timeout required to playing stream across APP. <br>Solutions: Playing the stream to pass the correct [Token], or update the [Token] in time. */
PlayerErrorDispatchAuthError = 1004003,
/** Description: This device does not support super resolution. <br>Caution: The device configured on the server does not support super resolution, or the configuration on the server failed to pull. <br>Solutions: replace the device and try again or contact ZEGO technical support. */
PlayerSuperResolutionDeviceNotSupport = 1004004,
/** Description: The number of super resolution streams exceeds the limit.<br>Caution: The number of super resolution streams exceeds the limit.<br>Solutions: Currently, super resolution support up to 1 playing steam at the same time. */
PlayerSuperResolutionMaxCountExceed = 1004005,
/** Description: The number of super resolution streams exceeds the limit.<br>Caution: The number of super resolution streams exceeds the limit.<br>Solutions: contact ZEGO technical support. */
PlayerSuperResolutionVideoSizeNotSupport = 1004006,
/** Description: The performance of super resolution device is not enough.<br>Caution: The performance of device is not enough.<br>Solutions: Please replace the device. */
PlayerSuperResolutionDevicePerformanceError = 1004007,
/** Description: Super resolution uninitialized.<br>Caution: Super resolution uninitialized.<br>Solutions: Please initialize super resolution. */
PlayerSuperResolutionNotInitError = 1004008,
/** Description: Stream playing error.<br>Caution: The number of streams the user attempted to play simultaneously exceeds the maximum number allowed.<br>Solutions: Currently, up to 12 steams can be played at the same time. Please contact ZEGO technical support to increase the capacity if necessary. */
PlayerCountExceed = 1004010,
/** Description: The stream was not played.<br>Caution: The stream was not played.<br>Solutions: Please confirm that the stream has been played through the [onPlayerStateUpdate] or [onUserStreamStateUpdate] callback. */
PlayerStreamWasNotPlayed = 1004011,
/** Description: Stream playing is temporarily interrupted.<br>Caution: Network exception.<br>Solutions: Please wait or check whether the network is normal. */
PlayerErrorNetworkInterrupt = 1004020,
/** Description: Failed to play the stream.<br>Caution: Publishing of this stream is prohibited by backend configuration.<br>Solutions: Please contact ZEGO technical support to solve the problem. */
PlayerErrorServerForbid = 1004025,
/** Description: Failed to capture the screenshot of the streaming screen, please check whether the stream to be captured is normal. <br>Cause: The stream is not pulled. <br>Solutions: Check whether it starts to play the stream, and whether there is an abnormality in the process of playing the stream. */
PlayerTakePlayStreamSnapshotFailed = 1004030,
/** Description: The play stream decryption key is invalid, the key length only supports 16/24/32 bytes. <br>Cause: The input key length is not 16/24/32 bytes. <br>Solutions: Adjust the input key length to 16/24/32 bytes. */
PlayerDecryptionKeyInvalid = 1004060,
/** Description: Pull stream decryption failed, please check whether the decryption key is correct. <br>Cause: Incorrect decryption key entered. <br>Solutions: Enter the correct decryption key. */
PlayerDecryptionFailed = 1004061,
/** Description: Calling the wrong function after enabling the multi-room function causes playing stream fail. <br>Cause: Called the playing stream function that only works for joining a single room mode. <br>Solutions: Please use the function of the same name with ZegoPlayerConfig and specify the room ID to play the stream. */
PlayerErrorPlayStreamWhenUsingMultiRoom = 1004070,
/** Description: In the multi-room mode, the roomID parameter of the play stream cannot be empty. <br>Cause: The roomID parameter of the pull stream is empty. <br>Solutions: Please enter the correct roomID. */
PlayerErrorPlayStreamWithRoomIdIsNullWhenUsingMultiRoom = 1004071,
/** 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. <br>Cause: Low-latency live broadcast service is not activated. <br>Solutions: Please contact ZEGO technical support staff to open the low-latency live broadcast service. */
PlayerNotConfigL3 = 1004072,
/** Description: Unsupported video decoder.<br>Caution: There is no selected video decoder in the current SDK.<br>Solutions: Please contact ZEGO technical support. */
PlayerVideoDecoderNoSupportted = 1004080,
/** Description: Video decoder fail.<br>Caution: Video decoder fail.<br>Solutions: Please contact ZEGO technical support. */
PlayerVideoDecoderFail = 1004081,
/** Description: An internal system exception causes a failure to pull the stream. <br>Cause: SDK internal error. <br>Solutions: Please contact ZEGO technical support. */
PlayerInnerError = 1004099,
/** Description: Does not support the use of stream mixing service. <br>Cause: No stream mixing service configured. <br>Solutions: Please open the service on the console or contact ZEGO business staff. */
MixerNoServices = 1005000,
/** Description: The mixing task ID is null. <br>Cause: The mixing task ID input when starting mixing task is empty. <br>Solutions: Please enter the correct mixing task ID. */
MixerTaskIdNull = 1005001,
/** Description: The stream mixing task ID is too long. <br>Cause: The stream mixing task ID is greater than 256 bytes. <br>Solutions: Please enter a mixing task ID less than 256 bytes. */
MixerTaskIdTooLong = 1005002,
/** Description: Invalid mixed flow task ID. <br>Cause: Illegal characters in the stream mixing task ID. <br>Solutions: Stream mixing task ID only supports numbers, English characters and'~','!','@','$','%','^','&','*','(',')', '_','+','=','-','`',';',''',',','.','<','>','/','\', please enter the stream mixing task ID in the correct format. */
MixerTaskIdInvalidCharacter = 1005003,
/** Description: Illegal parameters exist in mixing task configuration. <br>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. <br>Solutions: Please check the configuration parameters of the mixing task. */
MixerNoOutputTarget = 1005005,
/** Description: Illegal format of mixed stream output target parameter. <br>Cause: When the target of the mixed stream output target is streamID, an illegal character is passed in. <br>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 '-', '_'. */
MixerOutputTargetInvalid = 1005006,
/** Description: Failed to start the stream mixing task. <br>Cause: Requests are too frequent, exceeding the qps limit of the service. Network exceptions. An illegal mixed stream output URL was passed in. <br>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. */
MixerStartRequestError = 1005010,
/** Description: Failed to stop the stream mixing task. <br>Cause: May be the cause of the network error. <br>Solutions: Please check the network ring. */
MixerStopRequestError = 1005011,
/** The stream mixing task must be stopped by the user who started the task. This error code is deprecated. */
MixerNotOwnerStopMixer = 1005012,
/** Description: Starts stream mixing tasks too frequently. <br>Cause: Requests are too frequent, exceeding the qps limit of the service. <br>Solutions: Please ensure that the qps of the mixing request is less than 100. */
MixerStartQpsOverload = 1005015,
/** Description: Stop stream mixing tasks too frequently. <br>Cause: Requests are too frequent, exceeding the qps limit of the service. <br>Solutions: Please ensure that the qps of the stop mixing request is less than 100. */
MixerStopQpsOverload = 1005016,
/** Description: The input stream list of the stream mixing task is empty. <br>Cause: The input stream list of the stream mixing task is empty. <br>Solutions: Please check the input stream list of the mixing task. */
MixerInputListInvalid = 1005020,
/** Description: The output stream list of the stream mixing task is empty. <br>Cause: The output stream list of the stream mixing task is empty. <br>Solutions: Please check the output stream list of the mixing task. */
MixerOutputListInvalid = 1005021,
/** Description: The video configuration of the stream mixing task is invalid. <br>Cause: The video configuration of the stream mixing task is invalid. <br>Solutions: Please check the video configuration of the stream mixing task. */
MixerVideoConfigInvalid = 1005023,
/** Description: The video configuration of the stream mixing task is invalid. <br>Cause: 1. An unsupported audio codec format is used. 2. The audio bit rate exceeds 192 kbps. <br>Solutions: Please check the audio configuration of the stream mixing task. */
MixerAudioConfigInvalid = 1005024,
/** Description: The number of input streams exceeds the maximum number allowed. <br>Cause: Supports up to 9 input streams, and may pass more than 9 input streams. <br>Solutions: Please check the input stream configuration of the mixing task. */
MixerExceedMaxInputCount = 1005025,
/** Description: Failed to start mixed stream. <br>Cause: The input stream does not exist. <br>Solutions: Please make sure that the stream corresponding to the entered streamID is being pushed. */
MixerInputStreamNotExists = 1005026,
/** Description: Failed to start mixed stream. <br>Cause: The mixed stream input parameter is wrong, it may be that the layout of the input stream exceeds the canvas range. <br>Solutions: Please enter the correct mixed stream parameters. [ZegoMixerTask] */
MixerInputParametersError = 1005027,
/** Description: Mixed input text watermark is too long. <br>Cause: The length of the text watermark of the mixed stream input parameter exceeds the limit. <br>Solutions: Please make sure the input text watermark length does not exceed 512 bytes. */
MixerInputLabelTextTooLong = 1005028,
/** Description: Mixed stream output target is too long. <br>Cause: The length of the target parameter of the mixed stream output exceeds the limit. <br>Solutions: Please make sure that the output destination length does less than 1024 bytes. */
MixerOutputTargetTooLongError = 1005029,
/** Description: Failed to start mixed stream. <br>Cause: Exceeding the maximum number of output streams. <br>Solutions: Support up to 3 output streams. */
MixerExceedMaxOutputCount = 1005030,
/** Description: Failed to start mixed stream. <br>Cause: The maximum number of focus voice input streams is exceeded. <br>Solutions: Support up to 4 input streams to set the focus voice. */
MixerExceedMaxAudioFocusStreamCount = 1005031,
/** Description: The mixed-flow advanced configuration is too long. <br>Cause: The length of the mixed stream advanced configuration parameter exceeds the limit. <br>Solutions: Please make sure that the advanced configuration length does not exceed 512 bytes. */
MixerAdvancedConfigTooLongError = 1005032,
/** Description: The mixed stream watermark path is too long. <br>Cause: The length of the mixed stream watermark path parameter exceeds the limit. <br>Solution: Please make sure the watermark path length does not exceed 512 bytes. */
MixerWatermarkTooLong = 1005033,
/** Description: The link to the muxed input image is too long. <br>Cause: The length of the image link of the mixed stream input parameter exceeds the limit. <br>Solution: Please make sure that the length of the input image link does not exceed 1024 bytes. */
MixerInputImageUrlTooLong = 1005034,
/** Description: Failed to mix stream input image. <br>Cause: The image format of the mixed stream input parameter is incorrect. <br>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. */
MixerInputImageUrlFormatError = 1005035,
/** Description: Failed to mux input image. <br>Cause: The image size of the mixed stream input parameter exceeds the limit. <br>Solution: Image size is limited to 1M. */
MixerInputImageUrlSizeError = 1005036,
/** Description: The mixed output stream target room is misconfigured. <br>Cause: The room doesn't exist when the mixing starts. <br>Solution: Please make sure that the room corresponding to the configured targetRoom exists. */
MixerOutputTargetRoomError = 1005037,
/** Description: Failed to start mixed stream. <br>Cause: Mixed-stream authentication failed. <br>Solutions: Contact ZEGO technical support. */
MixerAuthenticationFailed = 1005050,
/** Description: Failed to start mixed stream. <br>Cause: The input image watermark is empty. <br>Solutions: Please enter the correct watermark parameters [ZegoWatermark]. */
MixerWatermarkNull = 1005061,
/** Description: Failed to start mixed stream. <br>Cause: The input image watermark parameter is wrong, it may be that the layout exceeds the canvas range. <br>Solutions: Please enter the correct watermark parameters [ZegoWatermark]. */
MixerWatermarkParametersError = 1005062,
/** Description: Failed to start mixed stream. <br>Cause: The input watermark URL is illegal. <br>Solutions: The watermark URL must start with `preset-id://` and end with `.jpg` or `.png`. */
MixerWatermarkUrlInvalid = 1005063,
/** Description: The mixed stream background image url is too long. <br>Cause: The length of the mixed stream background url parameter exceeds the limit. <br>Solution: Please make sure the background image url length does not exceed 1024 bytes. */
MixerBackgroundImageUrlTooLong = 1005066,
/** Description: Failed to start mixed stream. <br>Cause: The URL of the background image entered is illegal. <br>Solutions: The URL of the background image must start with preset-id:// and end with `.jpg` or `.png`. */
MixerBackgroundImageUrlInvalid = 1005067,
/** Description: Failed to start mixed stream. <br>Cause: The user-defined data is too long. <br>Solutions: The maximum length of the custom input should not exceed 1000 bytes. */
MixerUserDataTooLong = 1005068,
/** Description: Failed to start mixed stream. <br>Cause: The auto-mixing server was not found. <br>S