Class ZegoExpressErrorCode


  • public final class ZegoExpressErrorCode
    extends java.lang.Object
    • Field Detail

      • CommonSuccess

        public static final int CommonSuccess
        Execution successful.
        See Also:
        Constant Field Values
      • CommonEngineNotCreate

        public static final int CommonEngineNotCreate
        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.
        See Also:
        Constant Field Values
      • CommonNotLoginRoom

        public static final int CommonNotLoginRoom
        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.
        See Also:
        Constant Field Values
      • CommonEngineNotStarted

        public static final int CommonEngineNotStarted
        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.
        See Also:
        Constant Field Values
      • CommonUnsupportedPlatform

        public static final int CommonUnsupportedPlatform
        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.
        See Also:
        Constant Field Values
      • CommonInvalidAndroidEnvironment

        public static final int CommonInvalidAndroidEnvironment
        Description: Invalid Android context.
        Cause: Not set or set the wrong Android context environment.
        Solutions: Set the correct Android context.
        See Also:
        Constant Field Values
      • CommonEventHandlerExists

        public static final int CommonEventHandlerExists
        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.
        See Also:
        Constant Field Values
      • CommonSdkNoModule

        public static final int CommonSdkNoModule
        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.
        See Also:
        Constant Field Values
      • CommonStreamIdTooLong

        public static final int CommonStreamIdTooLong
        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.
        See Also:
        Constant Field Values
      • CommonStreamIdNull

        public static final int CommonStreamIdNull
        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.
        See Also:
        Constant Field Values
      • CommonStreamIdInvalidCharacter

        public static final int CommonStreamIdInvalidCharacter
        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 '-', '_'.
        See Also:
        Constant Field Values
      • CommonIllegalParam

        public static final int CommonIllegalParam
        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.
        See Also:
        Constant Field Values
      • CommonCdnUrlTooLong

        public static final int CommonCdnUrlTooLong
        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.
        See Also:
        Constant Field Values
      • CommonCdnAuthParamTooLong

        public static final int CommonCdnAuthParamTooLong
        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.
        See Also:
        Constant Field Values
      • CommonUserNotSame

        public static final int CommonUserNotSame
        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.
        See Also:
        Constant Field Values
      • CommonAppOfflineError

        public static final int CommonAppOfflineError
        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.
        See Also:
        Constant Field Values
      • CommonAppFlexiableConfigError

        public static final int CommonAppFlexiableConfigError
        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.
        See Also:
        Constant Field Values
      • CommonAppAccessDeniedError

        public static final int CommonAppAccessDeniedError
        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.
        See Also:
        Constant Field Values
      • CommonCdnUrlInvalid

        public static final int CommonCdnUrlInvalid
        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.
        See Also:
        Constant Field Values
      • CommonDnsResolveError

        public static final int CommonDnsResolveError
        DNS resolution failed. Please check network configurations. This error code is deprecated.
        See Also:
        Constant Field Values
      • CommonDispatchError

        public static final int CommonDispatchError
        Server dispatching exception. Please contact ZEGO technical support to solve the problem. This error code is deprecated.
        See Also:
        Constant Field Values
      • CommonConfigAfterEngineStarted

        public static final int CommonConfigAfterEngineStarted
        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.
        See Also:
        Constant Field Values
      • CommonConfigAfterRoomLoggedIn

        public static final int CommonConfigAfterRoomLoggedIn
        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.
        See Also:
        Constant Field Values
      • CommonLoadLibraryFailed

        public static final int CommonLoadLibraryFailed
        Description: Failed to load SDK dynamic library.
        Cause: Incorrect SDK dynamic path passed in.
        Solutions: Please pass in the correct SDK dynamic library path.
        See Also:
        Constant Field Values
      • CommonLoadLibraryFuncNotFound

        public static final int CommonLoadLibraryFuncNotFound
        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.
        See Also:
        Constant Field Values
      • CommonLoadLibraryNotSupport

        public static final int CommonLoadLibraryNotSupport
        Description: This call is not supported.
        Cause: ZEGOEXP_EXPLICIT macro is not enabled.
        Solutions: Please add the ZEGOEXP_EXPLICIT macro to the preprocessor.
        See Also:
        Constant Field Values
      • CommonInnerNullptr

        public static final int CommonInnerNullptr
        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.
        See Also:
        Constant Field Values
      • EngineAppidZero

        public static final int EngineAppidZero
        AppID cannot be 0. Please check if the AppID is correct.
        See Also:
        Constant Field Values
      • EngineAppsignInvalidLength

        public static final int EngineAppsignInvalidLength
        The length of the input AppSign must be 64 bytes.
        See Also:
        Constant Field Values
      • EngineAppsignInvalidCharacter

        public static final int EngineAppsignInvalidCharacter
        The input AppSign contains invalid characters. Only '0'-'9', 'a'-'f', 'A'-'F' are valid.
        See Also:
        Constant Field Values
      • EngineAppsignNull

        public static final int EngineAppsignNull
        The input AppSign is empty.
        See Also:
        Constant Field Values
      • EngineAppidIncorrectOrNotOnline

        public static final int EngineAppidIncorrectOrNotOnline
        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.
        See Also:
        Constant Field Values
      • EngineAppsignIncorrect

        public static final int EngineAppsignIncorrect
        Description: Authentication failed.
        Cause: Incorrect AppSign.
        Solutions: Please check AppSign is correct or not on ZEGO manage console.
        See Also:
        Constant Field Values
      • EngineLicenseNull

        public static final int EngineLicenseNull
        The input License is empty.
        See Also:
        Constant Field Values
      • EngineLogNoWritePermission

        public static final int EngineLogNoWritePermission
        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.
        See Also:
        Constant Field Values
      • EngineLogPathTooLong

        public static final int EngineLogPathTooLong
        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.
        See Also:
        Constant Field Values
      • EngineSetRoomModeErrorTime

        public static final int EngineSetRoomModeErrorTime
        Description: Set room mode failed.
        Cause: Set room mode after initialize the SDK.
        Solutions: Please set room mode before initialize the SDK.
        See Also:
        Constant Field Values
      • EngineSetGeoFenceErrorTime

        public static final int EngineSetGeoFenceErrorTime
        Description: Set geo fence failed.
        Cause: Set geo fence after initialize the SDK.
        Solutions: Please set geo fence before initialize the SDK.
        See Also:
        Constant Field Values
      • EngineExperimentalJsonStrInvalid

        public static final int EngineExperimentalJsonStrInvalid
        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.
        See Also:
        Constant Field Values
      • RoomCountExceed

        public static final int RoomCountExceed
        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.
        See Also:
        Constant Field Values
      • RoomRoomidIncorrect

        public static final int RoomRoomidIncorrect
        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.
        See Also:
        Constant Field Values
      • RoomUserIdNull

        public static final int RoomUserIdNull
        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.
        See Also:
        Constant Field Values
      • RoomUserIdInvalidCharacter

        public static final int RoomUserIdInvalidCharacter
        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 '~', '!', '@', '#', '$', '%', '^', '&', '*', '(', ')', '_', '+', '=', '-', '`', ';', ',', '.', '<', '>', '\'.
        See Also:
        Constant Field Values
      • RoomUserIdTooLong

        public static final int RoomUserIdTooLong
        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.
        See Also:
        Constant Field Values
      • RoomUserNameNull

        public static final int RoomUserNameNull
        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.
        See Also:
        Constant Field Values
      • RoomUserNameInvalidCharacter

        public static final int RoomUserNameInvalidCharacter
        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 '~', '!', '@', '#', '$', '%', '^', '&', '*', '(', ')', '_', '+', '=', '-', '`', ';', ',', '.', '<', '>', '/', '\'.
        See Also:
        Constant Field Values
      • RoomUserNameTooLong

        public static final int RoomUserNameTooLong
        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.
        See Also:
        Constant Field Values
      • RoomRoomidNull

        public static final int RoomRoomidNull
        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.
        See Also:
        Constant Field Values
      • RoomRoomidInvalidCharacter

        public static final int RoomRoomidInvalidCharacter
        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 '~', '!', '@', '#', '$', '%', '^', '&', '*', '(', ')', '_', '+', '=', '-', '`', ';', ',', '.', '<', '>', '\'.
        See Also:
        Constant Field Values
      • RoomRoomidTooLong

        public static final int RoomRoomidTooLong
        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.
        See Also:
        Constant Field Values
      • RoomRoomExtraInfoKeyEmpty

        public static final int RoomRoomExtraInfoKeyEmpty
        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.
        See Also:
        Constant Field Values
      • RoomRoomExtraInfoKeyTooLong

        public static final int RoomRoomExtraInfoKeyTooLong
        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.
        See Also:
        Constant Field Values
      • RoomRoomExtraInfoValueTooLong

        public static final int RoomRoomExtraInfoValueTooLong
        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.
        See Also:
        Constant Field Values
      • RoomRoomExtraInfoExceedKeys

        public static final int RoomRoomExtraInfoExceedKeys
        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.
        See Also:
        Constant Field Values
      • RoomMultiRoomLoginUserNotSame

        public static final int RoomMultiRoomLoginUserNotSame
        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.
        See Also:
        Constant Field Values
      • RoomMultiRoomSwtichRoomInvalid

        public static final int RoomMultiRoomSwtichRoomInvalid
        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].
        See Also:
        Constant Field Values
      • RoomErrorConnectFailed

        public static final int RoomErrorConnectFailed
        Description: Login failed, possibly due to network problems.
        Cause: The current network is abnormal.
        Solutions: It is recommended to switch the network to try.
        See Also:
        Constant Field Values
      • RoomErrorLoginTimeout

        public static final int RoomErrorLoginTimeout
        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.
        See Also:
        Constant Field Values
      • RoomErrorAuthenticationFailed

        public static final int RoomErrorAuthenticationFailed
        Description: Room login authentication failed.
        Cause: login set token error or token expired.
        Solutions: set new token.
        See Also:
        Constant Field Values
      • RoomErrorExceedMaximumMember

        public static final int RoomErrorExceedMaximumMember
        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.
        See Also:
        Constant Field Values
      • RoomErrorExceedMaximumRoomCount

        public static final int RoomErrorExceedMaximumRoomCount
        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.
        See Also:
        Constant Field Values
      • RoomErrorLoginMultiRoomNotOpen

        public static final int RoomErrorLoginMultiRoomNotOpen
        Description: login failed, multi-room mode is not activate.
        Cause: multi-room mode is not activate.
        Solutions: please contact ZEGO technical support.
        See Also:
        Constant Field Values
      • RoomErrorMultiRoomExceedMaximumRoomCount

        public static final int RoomErrorMultiRoomExceedMaximumRoomCount
        The total number of rooms logged in at the same time exceeds the limit, Please contact ZEGO technical support.
        See Also:
        Constant Field Values
      • RoomKickedOut

        public static final int RoomKickedOut
        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.
        See Also:
        Constant Field Values
      • RoomConnectTemporaryBroken

        public static final int RoomConnectTemporaryBroken
        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.
        See Also:
        Constant Field Values
      • RoomDisconnect

        public static final int RoomDisconnect
        Description: Room connection disconnected.
        Cause: Possibly due to network problems.
        Solutions: Please check whether the network is working or switch the network environment.
        See Also:
        Constant Field Values
      • RoomRetryTimeout

        public static final int RoomRetryTimeout
        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.
        See Also:
        Constant Field Values
      • RoomManualKickedOut

        public static final int RoomManualKickedOut
        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.
        See Also:
        Constant Field Values
      • RoomTokenExpiredKickedOut

        public static final int RoomTokenExpiredKickedOut
        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.
        See Also:
        Constant Field Values
      • RoomSessionExceptionKickedOut

        public static final int RoomSessionExceptionKickedOut
        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.
        See Also:
        Constant Field Values
      • RoomWrongLoginSequence

        public static final int RoomWrongLoginSequence
        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.
        See Also:
        Constant Field Values
      • RoomWrongLogoutSequence

        public static final int RoomWrongLogoutSequence
        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.
        See Also:
        Constant Field Values
      • RoomNoMultiRoomPermission

        public static final int RoomNoMultiRoomPermission
        Description: No multi-room permission.
        Cause: No multi-room permission.
        Solutions: Please contact ZEGO technical support to enable it.
        See Also:
        Constant Field Values
      • RoomRoomIdHasBeenUsed

        public static final int RoomRoomIdHasBeenUsed
        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.
        See Also:
        Constant Field Values
      • RoomMultiRoomDeprecated

        public static final int RoomMultiRoomDeprecated
        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.
        See Also:
        Constant Field Values
      • RoomUserInBlacklist

        public static final int RoomUserInBlacklist
        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.
        See Also:
        Constant Field Values
      • RoomNoToken

        public static final int RoomNoToken
        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.
        See Also:
        Constant Field Values
      • RoomAppCallApiTooFrequent

        public static final int RoomAppCallApiTooFrequent
        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.
        See Also:
        Constant Field Values
      • RoomRoomCallApiTooFrequent

        public static final int RoomRoomCallApiTooFrequent
        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.
        See Also:
        Constant Field Values
      • RoomAppCallTooFrequent

        public static final int RoomAppCallTooFrequent
        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.
        See Also:
        Constant Field Values
      • RoomTokenInnerError

        public static final int RoomTokenInnerError
        Description: Token inner error.
        Cause: Unknown internal error.
        Solutions: Contact ZEGO technical support to deal with it..
        See Also:
        Constant Field Values
      • RoomTokenFormatError

        public static final int RoomTokenFormatError
        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.
        See Also:
        Constant Field Values
      • RoomTokenAppidError

        public static final int RoomTokenAppidError
        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.
        See Also:
        Constant Field Values
      • RoomTokenUseridError

        public static final int RoomTokenUseridError
        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.
        See Also:
        Constant Field Values
      • RoomTokenExpireError

        public static final int RoomTokenExpireError
        Description: Token expire.
        Cause: Token expire Or the generated Token validity period parameter type is incorrect.
        Solutions: Regenerate the Token.
        See Also:
        Constant Field Values
      • RoomTokenVersionError

        public static final int RoomTokenVersionError
        Description: Token version error.
        Cause: Description The Token Version was generated incorrectly.
        Solutions: Generate the Token with the correct version.
        See Also:
        Constant Field Values
      • RoomTokenNoncetypeError

        public static final int RoomTokenNoncetypeError
        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.
        See Also:
        Constant Field Values
      • RoomMultiRoomRequired

        public static final int RoomMultiRoomRequired
        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.
        See Also:
        Constant Field Values
      • RoomRenewTokenNoPublishAuthError

        public static final int RoomRenewTokenNoPublishAuthError
        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.
        See Also:
        Constant Field Values
      • RoomRoomLoginCustomDataLengthError

        public static final int RoomRoomLoginCustomDataLengthError
        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.
        See Also:
        Constant Field Values
      • RoomRoomLoginLicenseNotFound

        public static final int RoomRoomLoginLicenseNotFound
        Description: login room used license auth, but can't find the license on zego server.
        Cause: input wrong license.
        Solutions: used the right license.
        See Also:
        Constant Field Values
      • RoomRoomLoginLicenseExpired

        public static final int RoomRoomLoginLicenseExpired
        Description: login room used license auth, but the license is expired.
        Solutions: Contact ZEGO technical support to deal with it.
        See Also:
        Constant Field Values
      • RoomRoomLoginOther

        public static final int RoomRoomLoginOther
        Description: The user has logged in elsewhere.
        Solutions: Check whether the user has logged in elsewhere.
        See Also:
        Constant Field Values
      • RoomRoomLicenseFeatureLimit

        public static final int RoomRoomLicenseFeatureLimit
        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.
        See Also:
        Constant Field Values
      • RoomInnerError

        public static final int RoomInnerError
        Description: Room login failed due to internal system exceptions.
        Cause: Unknown internal error.
        Solutions: Contact ZEGO technical support to deal with it.
        See Also:
        Constant Field Values
      • PublisherPublishStreamFailed

        public static final int PublisherPublishStreamFailed
        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.
        See Also:
        Constant Field Values
      • PublisherBitrateInvalid

        public static final int PublisherBitrateInvalid
        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.
        See Also:
        Constant Field Values
      • PublisherTrafficModeInvalid

        public static final int PublisherTrafficModeInvalid
        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.
        See Also:
        Constant Field Values
      • PublisherErrorH265EncoderNotSupported

        public static final int PublisherErrorH265EncoderNotSupported
        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.
        See Also:
        Constant Field Values
      • PublisherObjectSegmentationPerformanceWarning

        public static final int PublisherObjectSegmentationPerformanceWarning
        Description: The performance of object segmentation device is not enough.
        Caution: The performance of device is not enough.
        Solutions: Please replace the device.
        See Also:
        Constant Field Values
      • PublisherObjectSegmentationDeviceNotSupport

        public static final int PublisherObjectSegmentationDeviceNotSupport
        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.
        See Also:
        Constant Field Values
      • PublisherObjectSegmentationNoAuth

        public static final int PublisherObjectSegmentationNoAuth
        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.
        See Also:
        Constant Field Values
      • PublisherObjectSegmentationParamError

        public static final int PublisherObjectSegmentationParamError
        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.
        See Also:
        Constant Field Values
      • PublisherObjectSegmentationImageLoadError

        public static final int PublisherObjectSegmentationImageLoadError
        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.
        See Also:
        Constant Field Values
      • PublisherErrorNetworkInterrupt

        public static final int PublisherErrorNetworkInterrupt
        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.
        See Also:
        Constant Field Values
      • PublisherErrorRetryTimeout

        public static final int PublisherErrorRetryTimeout
        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.
        See Also:
        Constant Field Values
      • PublisherErrorAlreadyDoPublish

        public static final int PublisherErrorAlreadyDoPublish
        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.
        See Also:
        Constant Field Values
      • PublisherErrorServerForbid

        public static final int PublisherErrorServerForbid
        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.
        See Also:
        Constant Field Values
      • PublisherErrorRepetitivePublishStream

        public static final int PublisherErrorRepetitivePublishStream
        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.
        See Also:
        Constant Field Values
      • PublisherRtmpServerDisconnect

        public static final int PublisherRtmpServerDisconnect
        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.
        See Also:
        Constant Field Values
      • PublisherTakePublishStreamSnapshotFailed

        public static final int PublisherTakePublishStreamSnapshotFailed
        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.
        See Also:
        Constant Field Values
      • PublisherUpdateCdnTargetError

        public static final int PublisherUpdateCdnTargetError
        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.
        See Also:
        Constant Field Values
      • PublisherSeiDataNull

        public static final int PublisherSeiDataNull
        Description: Failed to send SEI.
        Cause: data is empty.
        Solutions: Incoming non-empty data.
        See Also:
        Constant Field Values
      • PublisherSeiDataTooLong

        public static final int PublisherSeiDataTooLong
        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.
        See Also:
        Constant Field Values
      • PublisherAudioSideDataNull

        public static final int PublisherAudioSideDataNull
        Description: Failed to send audio side info.
        Cause: data is empty.
        Solutions: Incoming non-empty data.
        See Also:
        Constant Field Values
      • PublisherAudioSideDataTooLong

        public static final int PublisherAudioSideDataTooLong
        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.
        See Also:
        Constant Field Values
      • PublisherExtraInfoNull

        public static final int PublisherExtraInfoNull
        The extra info of the stream is null.
        See Also:
        Constant Field Values
      • PublisherExtraInfoTooLong

        public static final int PublisherExtraInfoTooLong
        The extra info of the stream is too long. The maximum length should be less than 1024 bytes.
        See Also:
        Constant Field Values
      • PublisherUpdateExtraInfoFailed

        public static final int PublisherUpdateExtraInfoFailed
        Failed to update the extra info of the stream. Please check the network connection.
        See Also:
        Constant Field Values
      • PublisherWatermarkUrlNull

        public static final int PublisherWatermarkUrlNull
        Description: Failed to set publish watermark.
        Cause: The incoming watermark path is empty.
        Solutions: Incoming non-empty path.
        See Also:
        Constant Field Values
      • PublisherWatermarkUrlTooLong

        public static final int PublisherWatermarkUrlTooLong
        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.
        See Also:
        Constant Field Values
      • PublisherWatermarkUrlInvalid

        public static final int PublisherWatermarkUrlInvalid
        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.
        See Also:
        Constant Field Values
      • PublisherWatermarkLayoutInvalid

        public static final int PublisherWatermarkLayoutInvalid
        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.
        See Also:
        Constant Field Values
      • PublisherEncryptionKeyInvalid

        public static final int PublisherEncryptionKeyInvalid
        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.
        See Also:
        Constant Field Values
      • PublisherErrorPublishWhenUsingMultiRoom

        public static final int PublisherErrorPublishWhenUsingMultiRoom
        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.
        See Also:
        Constant Field Values
      • PublisherErrorPublishWithRoomIdIsNullWhenUsingMultiRoom

        public static final int PublisherErrorPublishWithRoomIdIsNullWhenUsingMultiRoom
        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.
        See Also:
        Constant Field Values
      • PublisherErrorDispatchAuthError

        public static final int PublisherErrorDispatchAuthError
        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.
        See Also:
        Constant Field Values
      • PublisherDummyCaptureImagePathError

        public static final int PublisherDummyCaptureImagePathError
        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.
        See Also:
        Constant Field Values
      • PublisherVideoEncoderNoSupportted

        public static final int PublisherVideoEncoderNoSupportted
        Description: Unsupported video encoder.
        Caution: There is no selected video encoder in the current SDK.
        Solutions: Please contact ZEGO technical support.
        See Also:
        Constant Field Values
      • PublisherVideoEncoderFail

        public static final int PublisherVideoEncoderFail
        Description: Video encoder error.
        Caution: Video encoder error.
        Solutions: Please contact ZEGO technical support.
        See Also:
        Constant Field Values
      • PublisherInnerError

        public static final int PublisherInnerError
        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.
        See Also:
        Constant Field Values
      • PlayerPlayStreamFailed

        public static final int PlayerPlayStreamFailed
        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.
        See Also:
        Constant Field Values
      • PlayerPlayStreamNotExist

        public static final int PlayerPlayStreamNotExist
        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.
        See Also:
        Constant Field Values
      • PlayerErrorDispatchAuthError

        public static final int PlayerErrorDispatchAuthError
        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.
        See Also:
        Constant Field Values
      • PlayerSuperResolutionDeviceNotSupport

        public static final int PlayerSuperResolutionDeviceNotSupport
        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.
        See Also:
        Constant Field Values
      • PlayerSuperResolutionMaxCountExceed

        public static final int PlayerSuperResolutionMaxCountExceed
        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.
        See Also:
        Constant Field Values
      • PlayerSuperResolutionVideoSizeNotSupport

        public static final int PlayerSuperResolutionVideoSizeNotSupport
        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.
        See Also:
        Constant Field Values
      • PlayerSuperResolutionDevicePerformanceError

        public static final int PlayerSuperResolutionDevicePerformanceError
        Description: The performance of super resolution device is not enough.
        Caution: The performance of device is not enough.
        Solutions: Please replace the device.
        See Also:
        Constant Field Values
      • PlayerSuperResolutionNotInitError

        public static final int PlayerSuperResolutionNotInitError
        Description: Super resolution uninitialized.
        Caution: Super resolution uninitialized.
        Solutions: Please initialize super resolution.
        See Also:
        Constant Field Values
      • PlayerCountExceed

        public static final int PlayerCountExceed
        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.
        See Also:
        Constant Field Values
      • PlayerStreamWasNotPlayed

        public static final int PlayerStreamWasNotPlayed
        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.
        See Also:
        Constant Field Values
      • PlayerErrorNetworkInterrupt

        public static final int PlayerErrorNetworkInterrupt
        Description: Stream playing is temporarily interrupted.
        Caution: Network exception.
        Solutions: Please wait or check whether the network is normal.
        See Also:
        Constant Field Values
      • PlayerErrorServerForbid

        public static final int PlayerErrorServerForbid
        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.
        See Also:
        Constant Field Values
      • PlayerTakePlayStreamSnapshotFailed

        public static final int PlayerTakePlayStreamSnapshotFailed
        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.
        See Also:
        Constant Field Values
      • PlayerDecryptionKeyInvalid

        public static final int PlayerDecryptionKeyInvalid
        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.
        See Also:
        Constant Field Values
      • PlayerDecryptionFailed

        public static final int PlayerDecryptionFailed
        Description: Pull stream decryption failed, please check whether the decryption key is correct.
        Cause: Incorrect decryption key entered.
        Solutions: Enter the correct decryption key.
        See Also:
        Constant Field Values
      • PlayerErrorPlayStreamWhenUsingMultiRoom

        public static final int PlayerErrorPlayStreamWhenUsingMultiRoom
        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.
        See Also:
        Constant Field Values
      • PlayerErrorPlayStreamWithRoomIdIsNullWhenUsingMultiRoom

        public static final int PlayerErrorPlayStreamWithRoomIdIsNullWhenUsingMultiRoom
        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.
        See Also:
        Constant Field Values
      • PlayerNotConfigL3

        public static final int PlayerNotConfigL3
        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.
        See Also:
        Constant Field Values
      • PlayerVideoDecoderNoSupportted

        public static final int PlayerVideoDecoderNoSupportted
        Description: Unsupported video decoder.
        Caution: There is no selected video decoder in the current SDK.
        Solutions: Please contact ZEGO technical support.
        See Also:
        Constant Field Values
      • PlayerVideoDecoderFail

        public static final int PlayerVideoDecoderFail
        Description: Video decoder fail.
        Caution: Video decoder fail.
        Solutions: Please contact ZEGO technical support.
        See Also:
        Constant Field Values
      • PlayerInnerError

        public static final int PlayerInnerError
        Description: An internal system exception causes a failure to pull the stream.
        Cause: SDK internal error.
        Solutions: Please contact ZEGO technical support.
        See Also:
        Constant Field Values
      • MixerNoServices

        public static final int MixerNoServices
        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.
        See Also:
        Constant Field Values
      • MixerTaskIdNull

        public static final int MixerTaskIdNull
        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.
        See Also:
        Constant Field Values
      • MixerTaskIdTooLong

        public static final int MixerTaskIdTooLong
        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.
        See Also:
        Constant Field Values
      • MixerTaskIdInvalidCharacter

        public static final int MixerTaskIdInvalidCharacter
        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.
        See Also:
        Constant Field Values
      • MixerNoOutputTarget

        public static final int MixerNoOutputTarget
        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.
        See Also:
        Constant Field Values
      • MixerOutputTargetInvalid

        public static final int MixerOutputTargetInvalid
        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 '-', '_'.
        See Also:
        Constant Field Values
      • MixerStartRequestError

        public static final int MixerStartRequestError
        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.
        See Also:
        Constant Field Values
      • MixerStopRequestError

        public static final int MixerStopRequestError
        Description: Failed to stop the stream mixing task.
        Cause: May be the cause of the network error.
        Solutions: Please check the network ring.
        See Also:
        Constant Field Values
      • MixerNotOwnerStopMixer

        public static final int MixerNotOwnerStopMixer
        The stream mixing task must be stopped by the user who started the task. This error code is deprecated.
        See Also:
        Constant Field Values
      • MixerStartQpsOverload

        public static final int MixerStartQpsOverload
        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.
        See Also:
        Constant Field Values
      • MixerStopQpsOverload

        public static final int MixerStopQpsOverload
        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.
        See Also:
        Constant Field Values
      • MixerInputListInvalid

        public static final int MixerInputListInvalid
        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.
        See Also:
        Constant Field Values
      • MixerOutputListInvalid

        public static final int MixerOutputListInvalid
        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.
        See Also:
        Constant Field Values
      • MixerVideoConfigInvalid

        public static final int MixerVideoConfigInvalid
        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.
        See Also:
        Constant Field Values
      • MixerAudioConfigInvalid

        public static final int MixerAudioConfigInvalid
        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.
        See Also:
        Constant Field Values
      • MixerExceedMaxInputCount

        public static final int MixerExceedMaxInputCount
        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.
        See Also:
        Constant Field Values
      • MixerInputStreamNotExists

        public static final int MixerInputStreamNotExists
        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.
        See Also:
        Constant Field Values
      • MixerInputParametersError

        public static final int MixerInputParametersError
        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]
        See Also:
        Constant Field Values
      • MixerInputLabelTextTooLong

        public static final int MixerInputLabelTextTooLong
        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.
        See Also:
        Constant Field Values
      • MixerOutputTargetTooLongError

        public static final int MixerOutputTargetTooLongError
        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.
        See Also:
        Constant Field Values
      • MixerExceedMaxOutputCount

        public static final int MixerExceedMaxOutputCount
        Description: Failed to start mixed stream.
        Cause: Exceeding the maximum number of output streams.
        Solutions: Support up to 3 output streams.
        See Also:
        Constant Field Values
      • MixerExceedMaxAudioFocusStreamCount

        public static final int MixerExceedMaxAudioFocusStreamCount
        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.
        See Also:
        Constant Field Values
      • MixerAdvancedConfigTooLongError

        public static final int MixerAdvancedConfigTooLongError
        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.
        See Also:
        Constant Field Values
      • MixerWatermarkTooLong

        public static final int MixerWatermarkTooLong
        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.
        See Also:
        Constant Field Values
      • MixerInputImageUrlTooLong

        public static final int MixerInputImageUrlTooLong
        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.
        See Also:
        Constant Field Values
      • MixerInputImageUrlFormatError

        public static final int MixerInputImageUrlFormatError
        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.
        See Also:
        Constant Field Values
      • MixerInputImageUrlSizeError

        public static final int MixerInputImageUrlSizeError
        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.
        See Also:
        Constant Field Values
      • MixerAuthenticationFailed

        public static final int MixerAuthenticationFailed
        Description: Failed to start mixed stream.
        Cause: Mixed-stream authentication failed.
        Solutions: Contact ZEGO technical support.
        See Also:
        Constant Field Values
      • MixerWatermarkNull

        public static final int MixerWatermarkNull
        Description: Failed to start mixed stream.
        Cause: The input image watermark is empty.
        Solutions: Please enter the correct watermark parameters [ZegoWatermark].
        See Also:
        Constant Field Values
      • MixerWatermarkParametersError

        public static final int MixerWatermarkParametersError
        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].
        See Also:
        Constant Field Values
      • MixerWatermarkUrlInvalid

        public static final int MixerWatermarkUrlInvalid
        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`.
        See Also:
        Constant Field Values
      • MixerBackgroundImageUrlTooLong

        public static final int MixerBackgroundImageUrlTooLong
        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.
        See Also:
        Constant Field Values
      • MixerBackgroundImageUrlInvalid

        public static final int MixerBackgroundImageUrlInvalid
        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`.
        See Also:
        Constant Field Values
      • MixerUserDataTooLong

        public static final int MixerUserDataTooLong
        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.
        See Also:
        Constant Field Values
      • MixerAutoMixStreamServerNotFound

        public static final int MixerAutoMixStreamServerNotFound
        Description: Failed to start mixed stream.
        Cause: The auto-mixing server was not found.
        Solutions: Please contact ZEGO technical support.
        See Also:
        Constant Field Values
      • MixerInnerError

        public static final int MixerInnerError
        Description: Stream mixing internal error.
        Cause: Unknown error occured in stream mixing internal.
        Solutions: Please contact ZEGO technical support.
        See Also:
        Constant Field Values
      • DeviceErrorTypeGeneric

        public static final int DeviceErrorTypeGeneric
        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.
        See Also:
        Constant Field Values
      • DeviceErrorTypeInvalidId

        public static final int DeviceErrorTypeInvalidId
        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.
        See Also:
        Constant Field Values
      • DeviceErrorTypeNoAuthorization

        public static final int DeviceErrorTypeNoAuthorization
        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.
        See Also:
        Constant Field Values
      • DeviceErrorTypeZeroFps

        public static final int DeviceErrorTypeZeroFps
        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.
        See Also:
        Constant Field Values
      • DeviceErrorTypeInUseByOther

        public static final int DeviceErrorTypeInUseByOther
        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.
        See Also:
        Constant Field Values
      • DeviceErrorTypeUnplugged

        public static final int DeviceErrorTypeUnplugged
        Description: The device is unplugged.
        Cause: The device is unplugged or not properly connected.
        Solutions: Check the device wiring and reconnect the device.
        See Also:
        Constant Field Values
      • DeviceErrorTypeRebootRequired

        public static final int DeviceErrorTypeRebootRequired
        Description: The device needs to be restarted.
        Cause: Device driver update, or device error requires restart.
        Solutions: Restart device.
        See Also:
        Constant Field Values
      • DeviceErrorMediaServicesLost

        public static final int DeviceErrorMediaServicesLost
        Description: The device media is lost.
        Cause: Media service cannot be restored.
        Solutions: Restart device.
        See Also:
        Constant Field Values
      • DeviceFreeDeviceListNull

        public static final int DeviceFreeDeviceListNull
        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.
        See Also:
        Constant Field Values
      • DeviceSouldLevelIntervalInvalid

        public static final int DeviceSouldLevelIntervalInvalid
        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.
        See Also:
        Constant Field Values
      • DeviceAudioSpectrumIntervalInvalid

        public static final int DeviceAudioSpectrumIntervalInvalid
        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.
        See Also:
        Constant Field Values
      • DeviceZoomFactorInvalid

        public static final int DeviceZoomFactorInvalid
        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].
        See Also:
        Constant Field Values
      • DeviceExposureCompensationValueInvalid

        public static final int DeviceExposureCompensationValueInvalid
        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].
        See Also:
        Constant Field Values
      • DeviceAudioVadStableStateMonitorTypeInvalid

        public static final int DeviceAudioVadStableStateMonitorTypeInvalid
        invalid audio VAD monitor type
        See Also:
        Constant Field Values
      • DeviceInnerError

        public static final int DeviceInnerError
        Description: Internal error of the device.
        Solutions: Contact ZEGO technical support.
        See Also:
        Constant Field Values
      • PreprocessPreprocessUnknownError

        public static final int PreprocessPreprocessUnknownError
        Description: Unknown error of the pre-processing module.
        Solutions: Please contact ZEGO technical support.
        See Also:
        Constant Field Values
      • PreprocessBeautifyOptionInvalid

        public static final int PreprocessBeautifyOptionInvalid
        Description: Failed to set the beauty configuration.
        Cause: The incoming beauty parameters are incorrect.
        Solutions: Please check the passed in [ZegoBeautifyOption] type parameter.
        See Also:
        Constant Field Values
      • PreprocessReverbParamNull

        public static final int PreprocessReverbParamNull
        The reverberation parameter is null. Please check the input parameter. This error code is deprecated.
        See Also:
        Constant Field Values
      • PreprocessVoiceChangerParamNull

        public static final int PreprocessVoiceChangerParamNull
        The voice changer parameter is null. Please check the input parameter. This error code is deprecated.
        See Also:
        Constant Field Values
      • PreprocessReverbParamRoomSizeInvalid

        public static final int PreprocessReverbParamRoomSizeInvalid
        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
        See Also:
        Constant Field Values
      • PreprocessReverbParamReverberanceInvalid

        public static final int PreprocessReverbParamReverberanceInvalid
        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
        See Also:
        Constant Field Values
      • PreprocessReverbParamDampingInvalid

        public static final int PreprocessReverbParamDampingInvalid
        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
        See Also:
        Constant Field Values
      • PreprocessReverbParamDryWetRatioInvalid

        public static final int PreprocessReverbParamDryWetRatioInvalid
        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
        See Also:
        Constant Field Values
      • PreprocessVirtualStereoAngleInvalid

        public static final int PreprocessVirtualStereoAngleInvalid
        Description: Failed to start virtual stereo.
        Cause: The virtual stereo angle parameter is invalid.
        Solutions: The normal range of angle parameter is -1 ~ 360.
        See Also:
        Constant Field Values
      • PreprocessVoiceChangerParamInvalid

        public static final int PreprocessVoiceChangerParamInvalid
        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
        See Also:
        Constant Field Values
      • PreprocessReverbEchoParamNull

        public static final int PreprocessReverbEchoParamNull
        The reverberation echo parameters is null. Please check the input parameter.
        See Also:
        Constant Field Values
      • PreprocessReverbEchoParamInvalid

        public static final int PreprocessReverbEchoParamInvalid
        Description: Set reverberation echo parameters failed .
        Cause: The reverberation echo parameters is invalid.
        Solutions: Input the correct reverb echo parameters [setReverbEchoParam].
        See Also:
        Constant Field Values
      • PreprocessElectronicEffectsTonalInvalid

        public static final int PreprocessElectronicEffectsTonalInvalid
        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.
        See Also:
        Constant Field Values
      • PreprocessEnableEffectsEnvFailed

        public static final int PreprocessEnableEffectsEnvFailed
        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).
        See Also:
        Constant Field Values
      • PreprocessEnableEffectsBeautyFailed

        public static final int PreprocessEnableEffectsBeautyFailed
        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.
        See Also:
        Constant Field Values
      • PreprocessSetEffectsParamFailed

        public static final int PreprocessSetEffectsParamFailed
        Description: Failed to set beauty parameters.
        Cause: The beauty environment is not activated.
        Solutions: Please call [startEffectsEnv] to start the beauty environment first.
        See Also:
        Constant Field Values
      • PreprocessNotSupportEffectsBufferType

        public static final int PreprocessNotSupportEffectsBufferType
        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.
        See Also:
        Constant Field Values
      • PreprocessEnableSpeechEnhanceParamInvalid

        public static final int PreprocessEnableSpeechEnhanceParamInvalid
        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.
        See Also:
        Constant Field Values
      • MediaPlayerNoInstance

        public static final int MediaPlayerNoInstance
        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].
        See Also:
        Constant Field Values
      • MediaPlayerNoFilePath

        public static final int MediaPlayerNoFilePath
        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.
        See Also:
        Constant Field Values
      • MediaPlayerFilePathTooLong

        public static final int MediaPlayerFilePathTooLong
        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.
        See Also:
        Constant Field Values
      • MediaPlayerFileFormatError

        public static final int MediaPlayerFileFormatError
        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.
        See Also:
        Constant Field Values
      • MediaPlayerFilePathNotExists

        public static final int MediaPlayerFilePathNotExists
        Description: The MediaPlayer failed to load the file.
        Cause: The file path does not exist.
        Solutions: Check the validity of the media file path.
        See Also:
        Constant Field Values
      • MediaPlayerFileDecodeError

        public static final int MediaPlayerFileDecodeError
        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.
        See Also:
        Constant Field Values
      • MediaPlayerFileNoSupportedStream

        public static final int MediaPlayerFileNoSupportedStream
        Description: The MediaPlayer failed to load the file.
        Cause: No supported audio/video stream exists.
        Solutions: Check that the media file data is empty.
        See Also:
        Constant Field Values
      • MediaPlayerFileExpired

        public static final int MediaPlayerFileExpired
        Description: The copyrighted music resource file has expired.
        Cause: The resource file has expired.
        Solutions: Please request song or accompaniment again.
        See Also:
        Constant Field Values
      • MediaPlayerDemuxError

        public static final int MediaPlayerDemuxError
        Description: The MediaPlayer failed to load the file.
        Cause: There was an error during file resolution.
        Solutions: Try again or contact ZEGO technical support.
        See Also:
        Constant Field Values
      • MediaPlayerResourceExpired

        public static final int MediaPlayerResourceExpired
        Description: The copyrighted music resource has expired.
        Cause: The copyrighted music resource has expired.
        Solutions: Please request the copyrighted music resource again.
        See Also:
        Constant Field Values
      • MediaPlayerResourceIdTooLong

        public static final int MediaPlayerResourceIdTooLong
        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.
        See Also:
        Constant Field Values
      • MediaPlayerUserCancel

        public static final int MediaPlayerUserCancel
        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.
        See Also:
        Constant Field Values
      • MediaPlayerAlreadyStart

        public static final int MediaPlayerAlreadyStart
        Description: The MediaPlayer is already start.
        Cause: [Load] has been called.
        Solutions: Please call [Stop] first, then call [Load].
        See Also:
        Constant Field Values
      • MediaPlayerSeekError

        public static final int MediaPlayerSeekError
        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].
        See Also:
        Constant Field Values
      • MediaPlayerPlatformFormatNotSupported

        public static final int MediaPlayerPlatformFormatNotSupported
        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.
        See Also:
        Constant Field Values
      • MediaPlayerExceedMaxCount

        public static final int MediaPlayerExceedMaxCount
        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.
        See Also:
        Constant Field Values
      • MediaPlayerSetAudioTrackIndexError

        public static final int MediaPlayerSetAudioTrackIndexError
        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.
        See Also:
        Constant Field Values
      • MediaPlayerSetVoiceChangerParamInvalid

        public static final int MediaPlayerSetVoiceChangerParamInvalid
        Description: Media player setting sound change parameter invalid.
        Cause: Error setting parameters.
        Solutions: Checking setting parameters control during -12.0 to 12.0
        See Also:
        Constant Field Values
      • MediaPlayerTakeSnapshotTimingError

        public static final int MediaPlayerTakeSnapshotTimingError
        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.
        See Also:
        Constant Field Values
      • MediaPlayerParamValueRangeIllegal

        public static final int MediaPlayerParamValueRangeIllegal
        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.
        See Also:
        Constant Field Values
      • MediaPlayerLocalCacheFailed

        public static final int MediaPlayerLocalCacheFailed
        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.
        See Also:
        Constant Field Values
      • MediaPlayerInnerError

        public static final int MediaPlayerInnerError
        Description: MediaPlayer internal error.
        Cause: internal error.
        Solutions: Contact Technical support.
        See Also:
        Constant Field Values
      • IMContentNull

        public static final int IMContentNull
        Description: the input message content is empty
        Cause: imessage content is empty
        Solutions: Input a non-empty message.
        See Also:
        Constant Field Values
      • IMContentTooLong

        public static final int IMContentTooLong
        Description: The input message content is too long
        Cause: message more than 1024 bytes.
        Solutions: The maximum length should be less than 1024 byte
        See Also:
        Constant Field Values
      • IMDataTooLong

        public static final int IMDataTooLong
        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.
        See Also:
        Constant Field Values
      • IMInconsistentRoomId

        public static final int IMInconsistentRoomId
        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.
        See Also:
        Constant Field Values
      • IMSendFailed

        public static final int IMSendFailed
        Description: Failed to send the message.
        Cause: network problems.
        Solutions: Check the network.
        See Also:
        Constant Field Values
      • IMUserIdEmpty

        public static final int IMUserIdEmpty
        Description: Failed to send custom command.
        Cause: The entered user ID is empty.
        Solutions: Please enter the correct user ID.
        See Also:
        Constant Field Values
      • IMUserIdTooLong

        public static final int IMUserIdTooLong
        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.
        See Also:
        Constant Field Values
      • IMInputParamsLengthLimit

        public static final int IMInputParamsLengthLimit
        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.
        See Also:
        Constant Field Values
      • IMBroadcastMessageQpsOverload

        public static final int IMBroadcastMessageQpsOverload
        Description: Failed to send broadcast message,.
        Cause: QPS exceeds the limit.
        Solutions: Control the maximum QPS is 2 .
        See Also:
        Constant Field Values
      • IMManagerCreationFailed

        public static final int IMManagerCreationFailed
        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.
        See Also:
        Constant Field Values
      • IMNoManagerInstance

        public static final int IMNoManagerInstance
        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.
        See Also:
        Constant Field Values
      • IMNoAvailableBroadcastChannel

        public static final int IMNoAvailableBroadcastChannel
        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.
        See Also:
        Constant Field Values
      • IMNoAvailableStreamId

        public static final int IMNoAvailableStreamId
        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.
        See Also:
        Constant Field Values
      • IMRepeatBroadcast

        public static final int IMRepeatBroadcast
        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.
        See Also:
        Constant Field Values
      • IMNoBroadcatingStream

        public static final int IMNoBroadcatingStream
        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.
        See Also:
        Constant Field Values
      • IMNoSubscribingStream

        public static final int IMNoSubscribingStream
        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.
        See Also:
        Constant Field Values
      • IMRepeatSubscribe

        public static final int IMRepeatSubscribe
        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.
        See Also:
        Constant Field Values
      • IMRealTimeSequentialDataSendFailed

        public static final int IMRealTimeSequentialDataSendFailed
        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.
        See Also:
        Constant Field Values
      • RecorderFileSuffixNameFormatNotSupport

        public static final int RecorderFileSuffixNameFormatNotSupport
        Description: the file name suffix is not supported.
        Cause: the file name suffix is not supported.
        Solutions: only support .mp4/.aac/.flv.
        See Also:
        Constant Field Values
      • RecorderCommonLiveroomApiError

        public static final int RecorderCommonLiveroomApiError
        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.
        See Also:
        Constant Field Values
      • RecorderFilePathTooLong

        public static final int RecorderFilePathTooLong
        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.
        See Also:
        Constant Field Values
      • RecorderInnerVeError

        public static final int RecorderInnerVeError
        Description: SDK internal error.
        Cause: Internal error.
        Solutions: Please contact ZEGO technical support.
        See Also:
        Constant Field Values
      • RecorderOpenFileFailed

        public static final int RecorderOpenFileFailed
        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.
        See Also:
        Constant Field Values
      • RecorderWriteFileError

        public static final int RecorderWriteFileError
        Description: Write file failed.
        Cause: No permissions to write file.
        Solutions: Please specify a valid file path and has proper permissions to write.
        See Also:
        Constant Field Values
      • RecorderNoEnoughSpareCapacity

        public static final int RecorderNoEnoughSpareCapacity
        Description: Insufficient disk space.
        Cause: Insufficient disk space.
        Solutions: Please ensure sufficient disk space.
        See Also:
        Constant Field Values
      • RecorderFileHandleExceptions

        public static final int RecorderFileHandleExceptions
        Description: File handle exception.
        Cause: File handle exception.
        Solutions: Please contact ZEGO technical support.
        See Also:
        Constant Field Values
      • RecorderIoExceptions

        public static final int RecorderIoExceptions
        Description: I/O exception.
        Cause: I/O exception.
        Solutions: Please contact ZEGO technical support.
        See Also:
        Constant Field Values
      • CustomVideoIOCapturerNotCreated

        public static final int CustomVideoIOCapturerNotCreated
        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.
        See Also:
        Constant Field Values
      • CustomVideoIONoCustomVideoCapture

        public static final int CustomVideoIONoCustomVideoCapture
        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.
        See Also:
        Constant Field Values
      • CustomVideoIOEnableCustomIoFailed

        public static final int CustomVideoIOEnableCustomIoFailed
        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).
        See Also:
        Constant Field Values
      • CustomVideoIOProcessModuleNotCreated

        public static final int CustomVideoIOProcessModuleNotCreated
        Description: The custom video capturer is not created.
        Cause: Internal video-related modules are not created.
        Solutions: Please call [startPreview] or [startPublishingStream] first.
        See Also:
        Constant Field Values
      • CustomVideoIONoCustomVideoProcessing

        public static final int CustomVideoIONoCustomVideoProcessing
        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.
        See Also:
        Constant Field Values
      • CustomVideoIONotSupportedFormat

        public static final int CustomVideoIONotSupportedFormat
        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.
        See Also:
        Constant Field Values
      • CustomVideoIONotSupportedBufferType

        public static final int CustomVideoIONotSupportedBufferType
        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.
        See Also:
        Constant Field Values
      • CustomAudioIOUnsupportedAudioSourceType

        public static final int CustomAudioIOUnsupportedAudioSourceType
        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.
        See Also:
        Constant Field Values
      • CustomAudioIOCapturerNotCreated

        public static final int CustomAudioIOCapturerNotCreated
        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.
        See Also:
        Constant Field Values
      • CustomAudioIORendererNotCreated

        public static final int CustomAudioIORendererNotCreated
        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.
        See Also:
        Constant Field Values
      • CustomAudioIOEnableCustomAudioIoFailed

        public static final int CustomAudioIOEnableCustomAudioIoFailed
        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`).
        See Also:
        Constant Field Values
      • CustomAudioIOAudioDataCallbackSampleRateNoSupport

        public static final int CustomAudioIOAudioDataCallbackSampleRateNoSupport
        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.
        See Also:
        Constant Field Values
      • MediaDataPublisherNoInstance

        public static final int MediaDataPublisherNoInstance
        Description: The MediaDataPublisher instance is not created.
        Cause: The MediaDataPublisher instance is not created.
        Solutions: Call [createMediaDataPublisher] to create a media pusher instance.
        See Also:
        Constant Field Values
      • MediaDataPublisherFileParseError

        public static final int MediaDataPublisherFileParseError
        Description: This error code is deprecated.
        Cause: None.
        Solutions: None.
        See Also:
        Constant Field Values
      • MediaDataPublisherFilePathError

        public static final int MediaDataPublisherFilePathError
        Description: This error code is deprecated.
        Cause: None.
        Solutions: None.
        See Also:
        Constant Field Values
      • MediaDataPublisherFileCodecError

        public static final int MediaDataPublisherFileCodecError
        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.
        See Also:
        Constant Field Values
      • MediaDataPublisherTimestampGoBackError

        public static final int MediaDataPublisherTimestampGoBackError
        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.
        See Also:
        Constant Field Values
      • MediaDataPublisherExceedMaxCount

        public static final int MediaDataPublisherExceedMaxCount
        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.
        See Also:
        Constant Field Values
      • AudioEffectPlayerNoInstance

        public static final int AudioEffectPlayerNoInstance
        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).
        See Also:
        Constant Field Values
      • AudioEffectPlayerLoadFailed

        public static final int AudioEffectPlayerLoadFailed
        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.
        See Also:
        Constant Field Values
      • AudioEffectPlayerPlayFailed

        public static final int AudioEffectPlayerPlayFailed
        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.
        See Also:
        Constant Field Values
      • AudioEffectPlayerSeekFailed

        public static final int AudioEffectPlayerSeekFailed
        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.
        See Also:
        Constant Field Values
      • AudioEffectPlayerExceedMaxCount

        public static final int AudioEffectPlayerExceedMaxCount
        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.
        See Also:
        Constant Field Values
      • UtilitiesNetworkConnectivityTestFailed

        public static final int UtilitiesNetworkConnectivityTestFailed
        Description: Network connectivity test failed.
        Cause: Not connected to the network.
        Solutions: Please check if you can access the Internet properly.
        See Also:
        Constant Field Values
      • UtilitiesNetworkToolConnectServerFailed

        public static final int UtilitiesNetworkToolConnectServerFailed
        Description: Network speed test connection failure.
        Cause: Not connected to the network.
        Solutions: Please check if you can access the Internet properly.
        See Also:
        Constant Field Values
      • UtilitiesNetworkToolRtpTimeoutError

        public static final int UtilitiesNetworkToolRtpTimeoutError
        Description: RTP timeout.
        Cause: Not connected to the network.
        Solutions: Please check if you can access the Internet properly.
        See Also:
        Constant Field Values
      • UtilitiesNetworkToolEngineDenied

        public static final int UtilitiesNetworkToolEngineDenied
        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.
        See Also:
        Constant Field Values
      • UtilitiesNetworkToolStoppedByPublishingStream

        public static final int UtilitiesNetworkToolStoppedByPublishingStream
        Description: Network speed test stopped.
        Cause: Network speed test not stopped before publishing stream.
        Solutions: Please stop network speed test(stopNetworkSpeedTest) before publishing stream.
        See Also:
        Constant Field Values
      • UtilitiesNetworkToolStoppedByPlayingStream

        public static final int UtilitiesNetworkToolStoppedByPlayingStream
        Description: Network speed test stopped.
        Cause: Network speed test not stopped before playing stream.
        Solutions: Please stop network speed test(stopNetworkSpeedTest) before playing stream.
        See Also:
        Constant Field Values
      • UtilitiesNetworkToolInnerError

        public static final int UtilitiesNetworkToolInnerError
        Description: Network speed test internal error.
        Cause: Internal error.
        Solutions: Please contact ZEGO technical support.
        See Also:
        Constant Field Values
      • UtilitiesPerformanceMonitorIntervalInvalid

        public static final int UtilitiesPerformanceMonitorIntervalInvalid
        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].
        See Also:
        Constant Field Values
      • UtilitiesStopByLoginRoom

        public static final int UtilitiesStopByLoginRoom
        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.
        See Also:
        Constant Field Values
      • UtilitiesStartDumpAudioDataFailed

        public static final int UtilitiesStartDumpAudioDataFailed
        Description: Fail to dump data.
        Cause: Error occurred in AV engine.
        Solutions: Please contact ZEGO technical support.
        See Also:
        Constant Field Values
      • UtilitiesAlreadyStartDumpDataError

        public static final int UtilitiesAlreadyStartDumpDataError
        Description: Already start dumping data.
        Cause: Call [startDumpData] repeatedly.
        Solutions: Stop or cancel the previous dump data task.
        See Also:
        Constant Field Values
      • UtilitiesNoDumpDataError

        public static final int UtilitiesNoDumpDataError
        Description: No dump data.
        Cause: Error occurred in AV engine.
        Solutions: Please contact ZEGO technical support.
        See Also:
        Constant Field Values
      • UtilitiesCreateDumpDataFolderError

        public static final int UtilitiesCreateDumpDataFolderError
        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.
        See Also:
        Constant Field Values
      • UtilitiesUploadModuleInnerError

        public static final int UtilitiesUploadModuleInnerError
        Description: Internal error of upload module.
        Cause: Error occurred in upload module.
        Solutions: Please contact ZEGO technical support.
        See Also:
        Constant Field Values
      • UtilitiesDumpDataExceedMaxSizeError

        public static final int UtilitiesDumpDataExceedMaxSizeError
        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.
        See Also:
        Constant Field Values
      • RangeAudioNoInstance

        public static final int RangeAudioNoInstance
        Description: The function call failed.
        Cause: No range auido instance has been created.
        Solutions: Create a range audio instance.
        See Also:
        Constant Field Values
      • RangeAudioExceedMaxCount

        public static final int RangeAudioExceedMaxCount
        Description: Failed to create range audio.
        Cause: The instance exceeds the maximum limit.
        Solutions: Use the used range audio example.
        See Also:
        Constant Field Values
      • RangeAudioNotSupportMultiRoom

        public static final int RangeAudioNotSupportMultiRoom
        Description: Failed to create range voice.
        Cause: Range voice cannot be used in multi-room mode.
        Solutions: Set the single-party mode.
        See Also:
        Constant Field Values
      • RangeAudioTeamIdTooLong

        public static final int RangeAudioTeamIdTooLong
        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.
        See Also:
        Constant Field Values
      • RangeAudioTeamIdInvalidCharacter

        public static final int RangeAudioTeamIdInvalidCharacter
        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 '~', '!', '@', '#', '$', '%', '^', '&', '*', '(', ')', '_', '+', '=', '-', '`', ';', ',', '.', '<', '>', '/', '\'.
        See Also:
        Constant Field Values
      • CopyrightedMusicCommandInvalid

        public static final int CopyrightedMusicCommandInvalid
        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.
        See Also:
        Constant Field Values
      • CopyrightedMusicParamsInvalid

        public static final int CopyrightedMusicParamsInvalid
        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.
        See Also:
        Constant Field Values
      • CopyrightedMusicSongIdInvalid

        public static final int CopyrightedMusicSongIdInvalid
        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.
        See Also:
        Constant Field Values
      • CopyrightedMusicShareTokenInvalid

        public static final int CopyrightedMusicShareTokenInvalid
        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]
        See Also:
        Constant Field Values
      • CopyrightedMusicResourceIdInvalid

        public static final int CopyrightedMusicResourceIdInvalid
        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]
        See Also:
        Constant Field Values
      • CopyrightedMusicStartPositionInvalid

        public static final int CopyrightedMusicStartPositionInvalid
        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.
        See Also:
        Constant Field Values
      • CopyrightedMusicPositionInvalid

        public static final int CopyrightedMusicPositionInvalid
        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.
        See Also:
        Constant Field Values
      • CopyrightedMusicVolumeInvalid

        public static final int CopyrightedMusicVolumeInvalid
        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.
        See Also:
        Constant Field Values
      • CopyrightedMusicKrcTokenInvalid

        public static final int CopyrightedMusicKrcTokenInvalid
        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]
        See Also:
        Constant Field Values
      • CopyrightedMusicCopyrightedMusicAuthParamInvalid

        public static final int CopyrightedMusicCopyrightedMusicAuthParamInvalid
        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.
        See Also:
        Constant Field Values
      • CopyrightedMusicCopyrightedServerFail

        public static final int CopyrightedMusicCopyrightedServerFail
        Description: Request copyrighted server fail.
        Cause: The params entered make mistake or some network reasons.
        Solutions: Please check the params entered and retry.
        See Also:
        Constant Field Values
      • CopyrightedMusicFreeSpaceLimit

        public static final int CopyrightedMusicFreeSpaceLimit
        Description: Free space limit.
        Cause: Free space limit.
        Solutions: Please clean up local files and make sure there is enough free disk space.
        See Also:
        Constant Field Values
      • CopyrightedMusicDownloading

        public static final int CopyrightedMusicDownloading
        Description: Downloading.
        Cause: Download same resource.
        Solutions: Please wait for the resource to download successfully.
        See Also:
        Constant Field Values
      • CopyrightedMusicResourceFileNotExist

        public static final int CopyrightedMusicResourceFileNotExist
        Description: Resource file not exist.
        Cause: Resource file has been deleted.
        Solutions: Please reload resource.
        See Also:
        Constant Field Values
      • CopyrightedMusicResourceFileExpired

        public static final int CopyrightedMusicResourceFileExpired
        Description: Resource file expired.
        Cause: The resource file has expired.
        Solutions: Please request song or accompaniment again.
        See Also:
        Constant Field Values
      • CopyrightedMusicResourceFileInvalid

        public static final int CopyrightedMusicResourceFileInvalid
        Description: Resource file invalid.
        Cause: File is corrupted
        Solutions: Please call [download] function to reload media resource.
        See Also:
        Constant Field Values
      • CopyrightedMusicDownloadCanceled

        public static final int CopyrightedMusicDownloadCanceled
        Description: Download canceled.
        Cause: Call [cancelDownload] to actively cancel the download.
        See Also:
        Constant Field Values
      • CopyrightedMusicResourceIdUnauthorized

        public static final int CopyrightedMusicResourceIdUnauthorized
        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.
        See Also:
        Constant Field Values
      • CopyrightedMusicResourceExpired

        public static final int CopyrightedMusicResourceExpired
        Description: The copyrighted resource has expired.
        Cause: The copyrighted resource has expired.
        Solutions: Please request the copyrighted resource again.
        See Also:
        Constant Field Values
      • CopyrightedMusicResourceNotSupportFunction

        public static final int CopyrightedMusicResourceNotSupportFunction
        Description: The resource does not support this method.
        Cause: Wrong resource ID selection.
        Solutions: Please pass in the correct resource ID.
        See Also:
        Constant Field Values
      • CopyrightedMusicNoCopyright

        public static final int CopyrightedMusicNoCopyright
        Description: No copyright, unable to listen to and sing songs.
        Cause: No copyright.
        Solutions: Please select another music.
        See Also:
        Constant Field Values
      • CopyrightedMusicNoPermissionsOfLyricsAndMusic

        public static final int CopyrightedMusicNoPermissionsOfLyricsAndMusic
        Description: No permissions of accompaniment, can only listen to songs, not sing.
        Cause: No permissions of accompaniment.
        Solutions: Please select another music.
        See Also:
        Constant Field Values
      • CopyrightedMusicNonMonthlyMembership

        public static final int CopyrightedMusicNonMonthlyMembership
        Description: Non monthly membership.
        Cause: Unopened monthly membership.
        Solutions: Open monthly membership or ues COUNT mode request music.
        See Also:
        Constant Field Values
      • CopyrightedMusicNoAccompany

        public static final int CopyrightedMusicNoAccompany
        Description: No accompany.
        Cause: Music don't have accompany.
        Solutions: Please choice music have accompany.
        See Also:
        Constant Field Values
      • CopyrightedMusicResourceNotExist

        public static final int CopyrightedMusicResourceNotExist
        Description: Resource not exist.
        Cause: Resource not exist.
        Solutions: Please select another music.
        See Also:
        Constant Field Values
      • CopyrightedMusicIllegalParam

        public static final int CopyrightedMusicIllegalParam
        Description: Illegal param.
        Cause: The entered param is incorrect.
        Solutions: Please check param when entered function to make sure it is correct.
        See Also:
        Constant Field Values
      • CopyrightedMusicAppidInvalid

        public static final int CopyrightedMusicAppidInvalid
        Description: AppID invalid.
        Cause: The appID is not support copyrighted music.
        Solutions: Please contact ZEGO technical support.
        See Also:
        Constant Field Values
      • CopyrightedMusicBillingModeInvalid

        public static final int CopyrightedMusicBillingModeInvalid
        Description: Billing mode invalid.
        Cause: Billing mode invalid.
        Solutions: Please select correct billing mode.
        See Also:
        Constant Field Values
      • CopyrightedMusicUnreasonableAccess

        public static final int CopyrightedMusicUnreasonableAccess
        Description: Unreasonable_access.
        Cause: Monthly membership request music by COUNT.
        Solutions: Please select correct billing mode.
        See Also:
        Constant Field Values
      • CopyrightedMusicShareTokenExpired

        public static final int CopyrightedMusicShareTokenExpired
        Description: Share token expired.
        Cause: Share token expired.
        Solutions: Please select an unexpired sharing token to get resources.
        See Also:
        Constant Field Values
      • CopyrightedMusicShareTokenIllegal

        public static final int CopyrightedMusicShareTokenIllegal
        Description: Share token illegal.
        Cause: Share token illegal.
        Solutions: Please check songToken when entered by calling [getMusicByToken] to make sure it is correct.
        See Also:
        Constant Field Values
      • CopyrightedMusicKrcTokenIllegal

        public static final int CopyrightedMusicKrcTokenIllegal
        Description: krcToken illegal.
        Cause: krcToken illegal.
        Solutions: Please check krcToken when entered by calling [getKrcLyricByKrcToken] to make sure it is correct.
        See Also:
        Constant Field Values
      • CopyrightedMusicKrcTokenExpired

        public static final int CopyrightedMusicKrcTokenExpired
        Description: krcToken expired.
        Cause: krcToken expired.
        Solutions: Please select an unexpired krcToken to get lyrics in KRC format.
        See Also:
        Constant Field Values
      • CopyrightedMusicGetLyricFail

        public static final int CopyrightedMusicGetLyricFail
        Description: Get lyric fail.
        Cause: Lyrics not found.
        Solutions: Please try again later.
        See Also:
        Constant Field Values
      • CopyrightedMusicGetPitchFail

        public static final int CopyrightedMusicGetPitchFail
        Description: Get pitch fail.
        Cause: Pitch not found.
        Solutions: Please try again later.
        See Also:
        Constant Field Values
      • CopyrightedMusicNotSharedResource

        public static final int CopyrightedMusicNotSharedResource
        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.
        See Also:
        Constant Field Values
      • CopyrightedMusicGetSharedResourceTimesOver

        public static final int CopyrightedMusicGetSharedResourceTimesOver
        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.
        See Also:
        Constant Field Values
      • CopyrightedMusicVendorIdNotAvaliable

        public static final int CopyrightedMusicVendorIdNotAvaliable
        Description: The vendor is unavailable.
        Cause: The corresponding copyright party has not been activated.
        Solutions: Please pass in the correct vendor ID.
        See Also:
        Constant Field Values
      • CopyrightedMusicVendorNotSupportFunction

        public static final int CopyrightedMusicVendorNotSupportFunction
        Description: This vendor does not support this function.
        Cause: Wrong vendor selection.
        Solutions: Please pass in the correct vendor ID.
        See Also:
        Constant Field Values
      • CopyrightedMusicRoomNoLogin

        public static final int CopyrightedMusicRoomNoLogin
        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.
        See Also:
        Constant Field Values
      • CopyrightedMusicVendorIdInvalid

        public static final int CopyrightedMusicVendorIdInvalid
        Description: Vendor ID invalid.
        Cause: Wrong vendor selection.
        Solutions: Please pass in the correct vendor ID.
        See Also:
        Constant Field Values
      • CopyrightedMusicSongIdNotSupport

        public static final int CopyrightedMusicSongIdNotSupport
        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.
        See Also:
        Constant Field Values
      • CopyrightedMusicMasterIdInvalid

        public static final int CopyrightedMusicMasterIdInvalid
        Description: master ID invalid.
        Cause: When billing by owner is selected, master ID is empty.
        Solutions: Please pass in the correct master ID.
        See Also:
        Constant Field Values
      • CopyrightedMusicPageInvalid

        public static final int CopyrightedMusicPageInvalid
        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.
        See Also:
        Constant Field Values
      • CopyrightedMusicNoPitch

        public static final int CopyrightedMusicNoPitch
        Description: resource has no pitch.
        Cause: resource has no pitch.
        Solutions: Please pass in the correct song ID.
        See Also:
        Constant Field Values
      • CopyrightedMusicSceneIdInvalid

        public static final int CopyrightedMusicSceneIdInvalid
        Description: scene ID invalid.
        Cause: scene ID invalid.
        Solutions: Please pass in the scene ID corresponding to the opened scene.
        See Also:
        Constant Field Values
      • CopyrightedMusicTopIdInvalid

        public static final int CopyrightedMusicTopIdInvalid
        Description: top ID invalid.
        Cause: An unsupported top ID was passed in when fetching chart songs.
        Solutions: Please pass in the correct top ID.
        See Also:
        Constant Field Values
      • CopyrightedMusicLoadPluginFail

        public static final int CopyrightedMusicLoadPluginFail
        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.
        See Also:
        Constant Field Values
      • CopyrightedMusicNotSupportMethod

        public static final int CopyrightedMusicNotSupportMethod
        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.
        See Also:
        Constant Field Values
      • CopyrightedMusicNoInit

        public static final int CopyrightedMusicNoInit
        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.
        See Also:
        Constant Field Values
      • CopyrightedMusicSystemBusy

        public static final int CopyrightedMusicSystemBusy
        Description: System is busy.
        Cause: System is busy.
        Solutions: Please try again.
        See Also:
        Constant Field Values
      • CopyrightedMusicNetworkError

        public static final int CopyrightedMusicNetworkError
        Description: Failed due to network exceptions.
        Cause: Unknown internal error.
        Solutions: Contact ZEGO technical support to deal with it.
        See Also:
        Constant Field Values
      • CopyrightedMusicInnerError

        public static final int CopyrightedMusicInnerError
        Description: Failed due to internal system exceptions.
        Cause: Unknown internal error.
        Solutions: Contact ZEGO technical support to deal with it.
        See Also:
        Constant Field Values
      • AudioVADClientInnerNullptr

        public static final int AudioVADClientInnerNullptr
        Description: SDK internal return null pointer.
        See Also:
        Constant Field Values
      • AudioVADClientNoInstance

        public static final int AudioVADClientNoInstance
        Description: The function call failed.
        Cause: No audio vad instance has been created.
        Solutions: Create a audio vad instance.
        See Also:
        Constant Field Values
      • RangeSceneCallFunctionFailed

        public static final int RangeSceneCallFunctionFailed
        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.
        See Also:
        Constant Field Values
      • RangeSceneNoInstance

        public static final int RangeSceneNoInstance
        Description: The RangeScene instance not created.
        Cause: The RangeScene instance not created.
        Solutions: Create a RangeScene instance before using RangeScene [createRangeScene].
        See Also:
        Constant Field Values
      • RangeSceneNotLoginScene

        public static final int RangeSceneNotLoginScene
        Description: Not login scene.
        Cause: Not login scene.
        Solutions: Please call [loginScene] to login scene.
        See Also:
        Constant Field Values
      • RangeSceneNotSupport

        public static final int RangeSceneNotSupport
        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.
        See Also:
        Constant Field Values
      • RangeSceneRetryTimeout

        public static final int RangeSceneRetryTimeout
        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.
        See Also:
        Constant Field Values
      • RangeSceneNetworkInterrupt

        public static final int RangeSceneNetworkInterrupt
        Description: Scene connection is temporarily interrupted.
        Cause: Possibly due to network problems.
        Solutions: Please wait or check whether the network is normal.
        See Also:
        Constant Field Values
      • RangeSceneTokenIllegal

        public static final int RangeSceneTokenIllegal
        Description: Token verification failed.
        Cause: The parameters passed in during token generation are inconsistent with the SDK.
        Solutions: Please use the correct token regenerated.
        See Also:
        Constant Field Values
      • RangeSceneTokenExpire

        public static final int RangeSceneTokenExpire
        Description: Token expire.
        Cause: Token expire or the generated Token validity period parameter type is incorrect.
        Solutions: Regenerate the Token.
        See Also:
        Constant Field Values
      • RangeSceneCoordinateOutOfRange

        public static final int RangeSceneCoordinateOutOfRange
        Description: Coordinates out of range.
        Cause: Coordinates out of scene range.
        Solutions: Please pass in the correct coordinates.
        See Also:
        Constant Field Values
      • RangeSceneItemHasBeenCreated

        public static final int RangeSceneItemHasBeenCreated
        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.
        See Also:
        Constant Field Values
      • RangeSceneItemBindExceedLimit

        public static final int RangeSceneItemBindExceedLimit
        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.
        See Also:
        Constant Field Values
      • RangeSceneItemNotExist

        public static final int RangeSceneItemNotExist
        Description: The item does not exist.
        Cause: The item does not exist.
        Solutions: Please create an item first.
        See Also:
        Constant Field Values
      • RangeSceneItemNotBind

        public static final int RangeSceneItemNotBind
        Description: The item is not bound.
        Cause: The item is not bound.
        Solutions: Please bind the item first.
        See Also:
        Constant Field Values
      • RangeSceneItemCasFailed

        public static final int RangeSceneItemCasFailed
        Description: The item has been operated by others.
        Cause: The item has been operated by others.
        Solutions: Please try again later.
        See Also:
        Constant Field Values
      • RangeSceneItemCapacityExceedLimit

        public static final int RangeSceneItemCapacityExceedLimit
        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.
        See Also:
        Constant Field Values
      • RangeSceneUserBindItemExceedLimit

        public static final int RangeSceneUserBindItemExceedLimit
        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.
        See Also:
        Constant Field Values
      • RangeSceneItemOutOfUserView

        public static final int RangeSceneItemOutOfUserView
        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.
        See Also:
        Constant Field Values
      • RangeSceneExceedMaxCount

        public static final int RangeSceneExceedMaxCount
        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.
        See Also:
        Constant Field Values
      • RangeSceneTeamExceedMaxCount

        public static final int RangeSceneTeamExceedMaxCount
        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.
        See Also:
        Constant Field Values
      • RangeSceneTeamIdOccupied

        public static final int RangeSceneTeamIdOccupied
        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.
        See Also:
        Constant Field Values
      • RangeSceneTeamIdIncorrect

        public static final int RangeSceneTeamIdIncorrect
        Description: Team id not exist.
        Cause: Use incorrect team id when leave team.
        Solutions: Use correct team id when leave team.
        See Also:
        Constant Field Values
      • RangeSceneInnerError

        public static final int RangeSceneInnerError
        Description: Failed due to internal system exceptions.
        Cause: Unknown internal error.
        Solutions: Contact ZEGO technical support to deal with it.
        See Also:
        Constant Field Values
      • ScreenCapturePermissionDenied

        public static final int ScreenCapturePermissionDenied
        Description: Startup screen capture failed.
        Cause: The user refused to grant the app screen capture permission.
        Solutions: Allow the app to capture screen permissions.
        See Also:
        Constant Field Values
      • ScreenCaptureNotSupport

        public static final int ScreenCaptureNotSupport
        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).
        See Also:
        Constant Field Values
      • ScreenCaptureSdkNoModule

        public static final int ScreenCaptureSdkNoModule
        Description: Startup screen capture failed.
        Cause: Unable to share the screen module.
        Solutions: Please introduce screen sharing module resources, or contact technical support.
        See Also:
        Constant Field Values
      • ScreenCaptureNoInstance

        public static final int ScreenCaptureNoInstance
        Description: The function call failed.
        Cause: No screen capture source instance has been created.
        Solutions: Create a screen capture source instance.
        See Also:
        Constant Field Values
      • ScreenCaptureExceedMaxCount

        public static final int ScreenCaptureExceedMaxCount
        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.
        See Also:
        Constant Field Values
      • ScreenCaptureInnerError

        public static final int ScreenCaptureInnerError
        Description: Failed due to internal system exceptions.
        Cause: Unknown internal error.
        Solutions: Contact ZEGO technical support to deal with it.
        See Also:
        Constant Field Values
      • AIVoiceChangerNoInstance

        public static final int AIVoiceChangerNoInstance
        Description: The function call failed.
        Cause: No AI voice changer instance has been created.
        Solutions: Create an AI voice changer instance.
        See Also:
        Constant Field Values
      • AIVoiceChangerExceedMaxCount

        public static final int AIVoiceChangerExceedMaxCount
        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.
        See Also:
        Constant Field Values
      • AIVoiceChangerInnerError

        public static final int AIVoiceChangerInnerError
        Description: Failed due to internal system exceptions.
        Cause: Unknown internal error.
        Solutions: Contact ZEGO technical support to deal with it.
        See Also:
        Constant Field Values
      • AIVoiceChangerNotInitError

        public static final int AIVoiceChangerNotInitError
        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.
        See Also:
        Constant Field Values
      • AIVoiceChangerInitFailedError

        public static final int AIVoiceChangerInitFailedError
        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.
        See Also:
        Constant Field Values
      • AIVoiceChangerNoModelError

        public static final int AIVoiceChangerNoModelError
        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.
        See Also:
        Constant Field Values
      • AIVoiceChangerModelDownloadFailedError

        public static final int AIVoiceChangerModelDownloadFailedError
        Description: Download AI voice changer resource files failed.
        Cause: Poor network connection.
        Solutions: Please check the network connection is ok.
        See Also:
        Constant Field Values
      • AIVoiceChangerDeviceNotSupportedError

        public static final int AIVoiceChangerDeviceNotSupportedError
        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.
        See Also:
        Constant Field Values
    • Constructor Detail

      • ZegoExpressErrorCode

        public ZegoExpressErrorCode()