Error codes and troubleshooting
See the following sections for common error codes, descriptions, and troubleshooting suggestions, grouped by category.
Common errors
| Name | Error Code | Description | Suggestion |
|---|---|---|---|
ZMVideoSDKErrors_Success | 0 | Request is successful. | None. |
ZMVideoSDKErrors_Wrong_Usage | 1 | Wrong usage of the interface. | Read the corresponding document to learn more about the interface. |
ZMVideoSDKErrors_Internal_Error | 2 | Internal error. Usually appears when you do not have the complete package or mix up libraries from different versions. | Download the latest version of the SDK library. |
ZMVideoSDKErrors_Uninitialize | 3 | The SDK has not been initialized. | Ensure you have initialized the SDK before you call any services. |
ZMVideoSDKErrors_Memory_Error | 4 | Insufficient memory to create a service. | Free up some memory used by other applications and try again. If this error appears too often, contact Developer Support or use the developer forum for assistance. |
ZMVideoSDKErrors_Load_Module_Error | 5 | Unable to load module from the library. Usually appears when you do not have the complete SDK library or mix up the libraries from different versions. | Download the latest version of the SDK library. |
ZMVideoSDKErrors_UnLoad_Module_Error | 6 | Unable to unload a module in the SDK library. | Wait for the module to complete an ongoing process. If the error persists, contact Developer Support. |
ZMVideoSDKErrors_Invalid_Parameter | 7 | Wrong usage of the parameters that pass to an interface. | Read the corresponding doc to learn about the interface. |
ZMVideoSDKErrors_Unknown | 11 | Unknown error. Usually appears when rare errors occur. | Check the log file and see if there are any related error messages. If it appears too often, contact Developer Support. |
Authentication errors
| Name | Error Code | Description | Suggestion |
|---|---|---|---|
ZMVideoSDKErrors_Auth_Error | 1001 | Authentication error. | Contact Developer Support if you are getting this error. |
ZMVideoSDKErrors_Auth_Empty_Key_or_Secret | 1002 | SDK key or secret is empty. | Pass the SDK key and secret. |
ZMVideoSDKErrors_Auth_Wrong_Key_or_Secret | 1003 | SDK key or secret is invalid. | Pass a valid SDK key and secret. |
ZMVideoSDKErrors_Auth_DoesNot_Support_SDK | 1004 | Your account does not support the SDK. | Check your Zoom account settings or contact Developer Support to enable it. |
ZMVideoSDKErrors_Auth_Disable_SDK | 1005 | Your account has disabled the SDK feature. | Check your Zoom account settings or contact Developer Support to enable it. |
Session errors
| Name | Error Code | Description | Suggestion |
|---|---|---|---|
ZMVideoSDKErrors_SessionModule_Not_Found | 2001 | Unable to find the module for the Session service. Usually appears when you do not have the complete SDK library or mix up the libraries from different versions. | Download the latest version of the SDK library. |
ZMVideoSDKErrors_SessionService_Invalid | 2002 | The Session service is invalid. | Ensure that the SDK has been initialized correctly. |
ZMVideoSDKErrors_Session_Join_Failed | 2003 | Unable to join the Session. | Check the information passed to join the session. |
ZMVideoSDKErrors_Session_No_Rights | 2004 | You do not have the permission to perform operation on this Session. | Ensure that you have the correct permissions. |
ZMVideoSDKErrors_Session_Already_In_Progress | 2005 | The request you are trying to do (join Session) is already in progress. | Do not send frequent requests. Wait for the request to complete and try again. |
ZMVideoSDKErrors_Session_Dont_Support_SessionType | 2006 | The Session type is not supported on the current system. | Contact Developer Support or use the developer forum for assistance. |
ZMVideoSDKErrors_Session_Reconnecting | 2007 | Trying to reconnect to the Session. | Check your network connection. |
ZMVideoSDKErrors_Session_Disconnecting | 2008 | Disconnecting from the session. | When disconnecting from the session, unsubscribe to free up resources. |
ZMVideoSDKErrors_Session_Not_Started | 2009 | The Session that you are trying to start did not start successfully. | Try again. |
ZMVideoSDKErrors_Session_Need_Password | 2010 | The Session you are trying to join needs password. | Pass the password to join the session. |
ZMVideoSDKErrors_Session_Password_Wrong | 2011 | The password entered is incorrect. | Provide the correct password. |
ZMVideoSDKErrors_Session_Remote_DB_Error | 2012 | The remote database has some errors. | Try again later. If the problem persists, contact Developer Support. |
ZMVideoSDKErrors_Session_Invalid_Param | 2013 | Received invalid parameters of join Session. | Check the parameters you passed to the method and try again. |
Media errors
| Name | Error Code | Description | Suggestion |
|---|---|---|---|
ZMVideoSDKErrors_Session_Audio_Error | 3000 | The SDK is having issues with audio. | Check your audio devices. |
ZMVideoSDKErrors_Session_Video_Error | 4000 | The SDK is having issues with video. | Check your video devices. |
ZMVideoSDKErrors_Session_Video_Device_Error | 4001 | The SDK is having issues with video devices. | Check your video devices. |
ZMVideoSDKErrors_Session_Live_Stream_Error | 5000 | The SDK is unable to start live streaming. | Ensure the parameters and information passed for live streaming are correct. |
Raw data errors
| Name | Error Code | Description | Suggestion |
|---|---|---|---|
ZMVideoSDKErrors_RAWDATA_MALLOC_FAILED | 6001 | Unable to allocate memory for raw data. | Free up memory in your device and try again. |
ZMVideoSDKErrors_RAWDATA_NOT_IN_Session | 6002 | Unable to retrieve raw data because it is not in a Session. | Start or join a session to start retrieving raw data. |
ZMVideoSDKErrors_RAWDATA_NO_LICENSE | 6003 | You do not have the correct license to use the raw data feature. | Contact Developer Support to purchase the correct license type. |
ZMVideoSDKErrors_RAWDATA_VIDEO_MODULE_NOT_READY | 6004 | The video module is not ready to retrieve raw data. | Initialize the video module. |
ZMVideoSDKErrors_RAWDATA_VIDEO_MODULE_ERROR | 6005 | Unable to use the video module. | Download the latest version of the SDK library. |
ZMVideoSDKErrors_RAWDATA_VIDEO_DEVICE_ERROR | 6006 | The video device has some errors. | Ensure your video device is connected and the SDK has the proper permission to access the device. |
ZMVideoSDKErrors_RAWDATA_NO_VIDEO_DATA | 6007 | Unable to retrieve video raw data. | Ensure the video module has been initialized. |
ZMVideoSDKErrors_RAWDATA_SHARE_MODULE_NOT_READY | 6008 | The share module is not ready to retrieve raw data. | Initialize the share module. |
ZMVideoSDKErrors_RAWDATA_SHARE_MODULE_ERROR | 6009 | Unable to use the share module. | Download the latest version of the SDK library. |
ZMVideoSDKErrors_RAWDATA_NO_SHARE_DATA | 6010 | Unable to retrieve share raw data. | Ensure your share module has been imported properly. |
ZMVideoSDKErrors_RAWDATA_AUDIO_MODULE_NOT_READY | 6011 | The audio module is not ready to retrieve raw data. | Initialize the audio module. |
ZMVideoSDKErrors_RAWDATA_AUDIO_MODULE_ERROR | 6012 | Unable to use the audio module. | Download the latest version of the SDK library. |
ZMVideoSDKErrors_RAWDATA_NO_AUDIO_DATA | 6013 | Unable to retrieve audio raw data. | Ensure the audio module has been initialized. |
ZMVideoSDKErrors_RAWDATA_PREPROCESS_RAWDATA_ERROR | 6014 | Internal error preprocessing raw data. | Contact Developer Support. |
ZMVideoSDKErrors_RAWDATA_NO_DEVICE_RUNNING | 6015 | No raw data device is running. | Ensure your device is connected and active. |
ZMVideoSDKErrors_RAWDATA_INIT_DEVICE | 6016 | Failed to initialize the raw data device. | Check that the device is available and try again. |
ZMVideoSDKErrors_RAWDATA_VIRTUAL_DEVICE | 6017 | Error occurred during use of a virtual audio device. | Make sure you have enabled virtual mic/speaker devices before calling these interfaces. |
ZMVideoSDKErrors_RAWDATA_CANNOT_CHANGE_VIRTUAL_DEVICE_IN_PREVIEW | 6018 | Attempted to change a virtual device during preview. | Retry the interface outside of preview. |
ZMVideoSDKErrors_RAWDATA_INTERNAL_ERROR | 6019 | Error occurred during use of a raw audio device. This typically occurs when a module failed or was not found. | Restart the application and check the project properties. |
ZMVideoSDKErrors_RAWDATA_SEND_TOO_MUCH_DATA_IN_SINGLE_TIME | 6020 | Too much raw data sent in a single call. | Reduce the amount of data sent per call. |
ZMVideoSDKErrors_RAWDATA_SEND_TOO_FREQUENTLY | 6021 | Raw data interfaces were called too frequently in a short amount of time. | Check that interfaces are not being called unnecessarily. |
ZMVideoSDKErrors_RAWDATA_VIRTUAL_MIC_IS_TERMINATE | 6022 | The virtual microphone was terminated. | Start the virtual mic again to continue using these interfaces. |
Share errors
| Name | Error Code | Description | Suggestion |
|---|---|---|---|
ZMVideoSDKErrors_Session_Share_Error | 7001 | Internal error. | Contact Developer Support. |
ZMVideoSDKErrors_Session_Share_Module_Not_Ready | 7002 | The share module was not initialized correctly. | Restart the application and check the project properties. |
ZMVideoSDKErrors_Session_Share_You_Are_Not_Sharing | 7003 | enableShareDeviceAudio or enableOptimizeForSharedVideo were called when the user was not sharing. | Only call enableShareDeviceAudio or enableOptimizeForSharedVideo when sharing. |
ZMVideoSDKErrors_Session_Share_Type_Is_Not_Support | 7004 | Used incorrect share type for the interface that was called. | Change to the correct share type. |
ZMVideoSDKErrors_Session_Share_Internal_Error | 7005 | Internal error. | Restart the application and check the project properties. |
Additional error codes
Find additional error codes in the ZMVideoSDKErrors enum in the SDK reference.
To determine the error numbers, find the previous numbered error in the header definition, and count sequentially. For example, ZMVideoSDKErrors_JoinSession_Token_MismatchedSessionName is error 1507.
ZMVideoSDKErrors_JoinSession_NoSessionName = 1500,
ZMVideoSDKErrors_JoinSession_NoSessionToken,
ZMVideoSDKErrors_JoinSession_NoUserName,
ZMVideoSDKErrors_JoinSession_Invalid_SessionName,
ZMVideoSDKErrors_JoinSession_Invalid_Password,
ZMVideoSDKErrors_JoinSession_Invalid_SessionToken,
ZMVideoSDKErrors_JoinSession_SessionName_TooLong,
ZMVideoSDKErrors_JoinSession_Token_MismatchedSessionName,
Some of the errors are no longer used, but they are not marked as deprecated.