ZoomVideoSDKConstants.h File Reference

Go to the source code of this file.

Enumerations
enum	ZoomVideoSDKError {   Errors_Success = 0 , Errors_Wrong_Usage , Errors_Internal_Error , Errors_Uninitialize ,   Errors_Memory_Error , Errors_Load_Module_Error , Errors_UnLoad_Module_Error , Errors_Invalid_Parameter ,   Errors_Call_Too_Frequently , Errors_No_Impl , Errors_Dont_Support_Feature , Errors_Unknown ,   Errors_Remove_Folder_Fail , Errors_Auth_Base = 1000 , Errors_Auth_Error , Errors_Auth_Empty_Key_or_Secret ,   Errors_Auth_Wrong_Key_or_Secret , Errors_Auth_DoesNot_Support_SDK , Errors_Auth_Disable_SDK , Errors_JoinSession_NoSessionName = 1500 ,   Errors_JoinSession_NoSessionToken , Errors_JoinSession_NoUserName , Errors_JoinSession_Invalid_SessionName , Errors_JoinSession_Invalid_Password ,   Errors_JoinSession_Invalid_SessionToken , Errors_JoinSession_SessionName_TooLong , Errors_JoinSession_Token_MismatchedSessionName , Errors_JoinSession_Token_NoSessionName ,   Errors_JoinSession_Token_RoleType_EmptyOrWrong , Errors_JoinSession_Token_UserIdentity_TooLong , Errors_Session_Base = 2000 , Errors_Session_Module_Not_Found ,   Errors_Session_Service_Invalid , Errors_Session_Join_Failed , Errors_Session_No_Rights , Errors_Session_Already_In_Progress ,   Errors_Session_Dont_Support_SessionType , Errors_Session_You_Have_No_Share , Errors_Session_Reconnecting , Errors_Session_Disconnecting ,   Errors_Session_Not_Started = 2010 , Errors_Session_Need_Password , Errors_Session_Password_Wrong , Errors_Session_Remote_DB_Error ,   Errors_Session_Invalid_Param , Errors_Session_Client_Incompatible , Errors_Session_Account_FreeMinutesExceeded , Errors_Session_Account_FreeCreditExceeded ,   Errors_Session_Audio_Error = 3000 , Errors_Session_Audio_No_Microphone , Errors_Session_Audio_No_Speaker , Errors_Session_Video_Error = 4000 ,   Errors_Session_Video_Device_Error , Errors_Session_Live_Stream_Error = 5000 , Errors_Session_Phone_Error = 5500 , Errors_Dont_Support_Multi_Stream_Video_User ,   Errors_Fail_Assign_User_Privilege , Errors_No_Recording_In_Process , Errors_Set_Virtual_Background_Fail , Errors_Malloc_Failed = 6001 ,   Errors_Not_In_Session , Errors_No_License , Errors_Video_Module_Not_Ready , Errors_Video_Module_Error ,   Errors_Video_device_error , Errors_No_Video_Data , Errors_Share_Module_Not_Ready , Errors_Share_Module_Error ,   Errors_No_Share_Data , Errors_Audio_Module_Not_Ready , Errors_Audio_Module_Error , Errors_No_Audio_Data ,   Errors_Preprocess_Rawdata_Error , Errors_Rawdata_No_Device_Running , Errors_Rawdata_Init_Device , Errors_Rawdata_Virtual_Device ,   Errors_Rawdata_Cannot_Change_Virtual_Device_In_Preview , Errors_Rawdata_Internal_Error , Errors_Rawdata_Send_Too_Much_Data_In_Single_Time , Errors_Rawdata_Send_Too_Frequently ,   Errors_Rawdata_Virtual_Mic_Is_Terminate , Errors_Rawdata_Invalid_Share_Preprocessing_Data_Object , Errors_Rawdata_Share_Preprocessing_Is_Stopped , Errors_Session_Share_Error = 7001 ,   Errors_Session_Share_Module_Not_Ready , Errors_Session_Share_You_Are_Not_Sharing , Errors_Session_Share_Type_Is_Not_Support , Errors_Session_Share_Internal_Error ,   Errors_Session_Share_Camera_Video_Not_Start , Errors_Session_Share_Camera_Conflict_With_Video_Effects , Errors_Session_Filetransfer_UnknownError = 7500 , Errors_Session_Filetransfer_FileTypeBlocked ,   Errors_Session_Filetransfer_FileSizelimited , Errors_Spotlight_NotEnoughUsers = 7600 , Errors_Spotlight_ToMuchSpotlightedUsers , Errors_Spotlight_UserCannotBeSpotlighted ,   Errors_Spotlight_UserWithoutVideo , Errors_Spotlight_UserNotSpotlighted }
	Enumerates all errors in the VideoSDK. More...
enum	ZoomVideoSDKSessionType { ZoomVideoSDKSessionType_MainSession = 0 , ZoomVideoSDKSessionType_SubSession }
	Enumeration of session type. More...
enum	ZoomVideoSDKAudioType { ZoomVideoSDKAudioType_None = 0 , ZoomVideoSDKAudioType_VOIP , ZoomVideoSDKAudioType_TELEPHONY , ZoomVideoSDKAudioType_Unknown }
	Enumerates the types of audio. More...
enum	ZoomVideoSDKVideoAspect { ZoomVideoSDKVideoAspect_Original = 0 , ZoomVideoSDKVideoAspect_Full_Filled , ZoomVideoSDKVideoAspect_LetterBox , ZoomVideoSDKVideoAspect_PanAndScan }
	Enumeration of the video aspect ratio. More...
enum	ZoomVideoSDKVideoType { ZoomVideoSDKVideoType_VideoData = 1 , ZoomVideoSDKVideoType_ShareData }
	Enumeration of video type. More...
enum	ZoomVideoSDKReceiveSharingStatus {   ZoomVideoSDKReceiveSharingStatus_None = 0 , ZoomVideoSDKReceiveSharingStatus_Start , ZoomVideoSDKReceiveSharingStatus_Pause , ZoomVideoSDKReceiveSharingStatus_Resume ,   ZoomVideoSDKReceiveSharingStatus_Stop }
	Enumerates the status of sharing. More...
enum	ZoomVideoSDKLiveStreamStatus {   ZoomVideoSDKLiveStreamStatus_None = 1 , ZoomVideoSDKLiveStreamStatus_InProgress , ZoomVideoSDKLiveStreamStatus_Connecting , ZoomVideoSDKLiveStreamStatus_FailedTimeout ,   ZoomVideoSDKLiveStreamStatus_StartFailed , ZoomVideoSDKLiveStreamStatus_Ended }
	Enumerates the statuses of live streaming. More...
enum	ZoomVideoSDKFrameDataFormat { ZoomVideoSDKFrameDataFormat_I420 = 1 , ZoomVideoSDKFrameDataFormat_I420_Limit }
	Enumeration of raw data formats. Defines the color space format and color range for video frames. More...
enum	ZoomVideoSDKVideoRawDataRotation { ZoomVideoSDKVideoRawDataRotationNone = 1 , ZoomVideoSDKVideoRawDataRotation90 , ZoomVideoSDKVideoRawDataRotation180 , ZoomVideoSDKVideoRawDataRotation270 }
	RawDataRotationof the directions of video. More...
enum	ZoomVideoSDKVideoResolution {   ZoomVideoSDKVideoResolution_90 , ZoomVideoSDKVideoResolution_180 , ZoomVideoSDKVideoResolution_360 , ZoomVideoSDKVideoResolution_720 ,   ZoomVideoSDKVideoResolution_Auto = 100 }
	Enumeration of render resolution. More...
enum	ZoomVideoSDKRawDataMemoryMode { ZoomVideoSDKRawDataMemoryModeStack , ZoomVideoSDKRawDataMemoryModeHeap }
	Enumeration of memory modes for raw data handling. More...
enum	ZoomVideoSDKUserRawdataStatus { ZoomVideoSDKUserRawdataOn , ZoomVideoSDKUserRawdataOff }
	Enumeration the statuses of raw data. More...
enum	ZoomVideoSDKPhoneStatus {   ZoomVideoSDKPhoneStatus_None , ZoomVideoSDKPhoneStatus_Calling , ZoomVideoSDKPhoneStatus_Ringing , ZoomVideoSDKPhoneStatus_Accepted ,   ZoomVideoSDKPhoneStatus_Success , ZoomVideoSDKPhoneStatus_Failed , ZoomVideoSDKPhoneStatus_Canceling , ZoomVideoSDKPhoneStatus_Canceled ,   ZoomVideoSDKPhoneStatus_Cancel_Failed , ZoomVideoSDKPhoneStatus_Timeout }
	Enumerates the statuses of a phone call. More...
enum	ZoomVideoSDKPhoneFailedReason {   ZoomVideoSDKPhoneFailedReason_None , ZoomVideoSDKPhoneFailedReason_Busy , ZoomVideoSDKPhoneFailedReason_Not_Available , ZoomVideoSDKPhoneFailedReason_User_Hangup ,   ZoomVideoSDKPhoneFailedReason_Other_Fail , ZoomVideoSDKPhoneFailedReason_No_Answer , ZoomVideoSDKPhoneFailedReason_Block_No_Host , ZoomVideoSDKPhoneFailedReason_Block_High_Rate ,   ZoomVideoSDKPhoneFailedReason_Block_Too_Frequent }
	Enumerates the various reasons for a phone call failure. More...
enum	ZoomVideoSDKRecordingStatus {   ZoomVideoSDKRecordingStatus_None , ZoomVideoSDKRecordingStatus_Start , ZoomVideoSDKRecordingStatus_Stop , ZoomVideoSDKRecordingStatus_DiskFull ,   ZoomVideoSDKRecordingStatus_Pause , ZoomVideoSDKRecordingStatus_Connecting }
	An enum representing the status of the recording status. More...
enum	ZoomVideoSDKVideoPreferenceMode { ZoomVideoSDKVideoPreferenceMode_Balance , ZoomVideoSDKVideoPreferenceMode_Sharpness , ZoomVideoSDKVideoPreferenceMode_Smoothness , ZoomVideoSDKVideoPreferenceMode_Custom }
	Enumerates the video preference modes. More...
enum	ZoomVideoSDKMultiCameraStreamStatus {   ZoomVideoSDKMultiCameraStreamStatus_JoinStart , ZoomVideoSDKMultiCameraStreamStatus_JoinFail , ZoomVideoSDKMultiCameraStreamStatus_Joined , ZoomVideoSDKMultiCameraStreamStatus_Left ,   ZoomVideoSDKMultiCameraStreamStatus_VideoOn , ZoomVideoSDKMultiCameraStreamStatus_VideoOff }
	Enumerates the status of multi-camera streams. More...
enum	ZoomVideoSDKLiveTranscriptionStatus { ZoomVideoSDKLiveTranscriptionStatus_Stop , ZoomVideoSDKLiveTranscriptionStatus_Start }
	Enumerates the status of live transcription. More...
enum	ZoomVideoSDKLiveTranscriptionOperationType {   ZoomVideoSDKLiveTranscriptionOperationType_None , ZoomVideoSDKLiveTranscriptionOperationType_Add , ZoomVideoSDKLiveTranscriptionOperationType_Update , ZoomVideoSDKLiveTranscriptionOperationType_Delete ,   ZoomVideoSDKLiveTranscriptionOperationType_Complete , ZoomVideoSDKLiveTranscriptionOperationType_NotSupported }
	Enumerates the types of operations related to live transcription. More...
enum	ZoomVideoSDKSystemPermissionType { ZoomVideoSDKSystemPermissionType_Camera , ZoomVideoSDKSystemPermissionType_Microphone }
	Enumerates the types of device permission. More...
enum	ZoomVideoSDKChatMsgDeleteBy { ZoomVideoSDKChatMsgDeleteBy_NONE , ZoomVideoSDKChatMsgDeleteBy_SELF , ZoomVideoSDKChatMsgDeleteBy_HOST , ZoomVideoSDKChatMsgDeleteBy_DLP }
	The chat message delete type are sent in the onChatMsgDeleteNotification:messageID:deleteBy: callback. More...
enum	ZoomVideoSDKDialInNumType { ZoomVideoSDKDialInNumType_None , ZoomVideoSDKDialInNumType_Toll , ZoomVideoSDKDialInNumType_TollFree }
	Enumeration of the number types for calling to join the audio into a meeting. More...
enum	ZoomVideoSDKNetworkStatus { ZoomVideoSDKNetworkStatus_None , ZoomVideoSDKNetworkStatus_Bad , ZoomVideoSDKNetworkStatus_Normal , ZoomVideoSDKNetworkStatus_Good }
	Enumerates the network statuses. More...
enum	ZoomVideoSDKRecordAgreementType { ZoomVideoSDKRecordAgreementType_Invalid , ZoomVideoSDKRecordAgreementType_Traditional , ZoomVideoSDKRecordAgreementType_Individual_Only }
	Enumerates the types of consent for cloud recording. More...
enum	ZoomVideoSDKVirtualBackgroundDataType { ZoomVideoSDKVirtualBackgroundDataType_None , ZoomVideoSDKVirtualBackgroundDataType_Image , ZoomVideoSDKVirtualBackgroundDataType_Blur }
	Enumerates the types of virtual backgrounds. More...
enum	ZoomVideoSDKCRCProtocol { ZoomVideoSDKCRCProtocol_H323 = 0 , ZoomVideoSDKCRCProtocol_SIP }
	Enumerates the types of Call CRC (Circuit-Reliable Communication). More...
enum	ZoomVideoSDKCRCCallStatus {   ZoomVideoSDKCRCCallStatus_Success = 0 , ZoomVideoSDKCRCCallStatus_Ring , ZoomVideoSDKCRCCallStatus_Timeout , ZoomVideoSDKCRCCallStatus_Busy ,   ZoomVideoSDKCRCCallStatus_Decline , ZoomVideoSDKCRCCallStatus_Failed }
	Enumerates the statuses of a CRC call. More...
enum	ZoomVideoSDKAnnotationToolType {   ZoomVideoSDKAnnotationToolType_None = 0 , ZoomVideoSDKAnnotationToolType_Pen , ZoomVideoSDKAnnotationToolType_HighLighter , ZoomVideoSDKAnnotationToolType_AutoLine ,   ZoomVideoSDKAnnotationToolType_AutoRectangle , ZoomVideoSDKAnnotationToolType_AutoEllipse , ZoomVideoSDKAnnotationToolType_AutoArrow , ZoomVideoSDKAnnotationToolType_AutoRectangleFill ,   ZoomVideoSDKAnnotationToolType_AutoEllipseFill , ZoomVideoSDKAnnotationToolType_SpotLight , ZoomVideoSDKAnnotationToolType_Arrow , ZoomVideoSDKAnnotationToolType_ERASER ,   ZoomVideoSDKAnnotationToolType_Picker , ZoomVideoSDKAnnotationToolType_AutoRectangleSemiFill , ZoomVideoSDKAnnotationToolType_AutoEllipseSemiFill , ZoomVideoSDKAnnotationToolType_AutoDoubleArrow ,   ZoomVideoSDKAnnotationToolType_AutoDiamond , ZoomVideoSDKAnnotationToolType_AutoStampArrow , ZoomVideoSDKAnnotationToolType_AutoStampCheck , ZoomVideoSDKAnnotationToolType_AutoStampX ,   ZoomVideoSDKAnnotationToolType_AutoStampStar , ZoomVideoSDKAnnotationToolType_AutoStampHeart , ZoomVideoSDKAnnotationToolType_AutoStampQm }
	Enumeration of the type for annotation tool. For more information, please visit https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0067931. More...
enum	ZoomVideoSDKAnnotationClearType { ZoomVideoSDKAnnotationClearType_All = 0 , ZoomVideoSDKAnnotationClearType_Others , ZoomVideoSDKAnnotationClearType_My }
	Enumeration of the type for clear annotation. More...
enum	ZoomVideoSDKSubscribeFailReason {   ZoomVideoSDKSubscribeFailReason_None = 0 , ZoomVideoSDKSubscribeFailReason_HasSubscribeShare , ZoomVideoSDKSubscribeFailReason_HasSubscribeExceededLimit , ZoomVideoSDKSubscribeFailReason_HasSubscribe1080POr720P ,   ZoomVideoSDKSubscribeFailReason_HasSubscribeOneShare , ZoomVideoSDKSubscribeFailReason_TooFrequentCall }
	Enumerates the reasons for a failed video subscription attempt. More...
enum	ZoomVideoSDKShareType { ZoomVideoSDKShareType_None , ZoomVideoSDKShareType_Normal , ZoomVideoSDKShareType_PureAudio , ZoomVideoSDKShareType_Camera }
	Enumerates the types of content that can be shared in a session. More...
enum	ZoomVideoSDKChatPrivilegeType { ZoomVideoSDKChatPrivilege_Unknown = 0 , ZoomVideoSDKChatPrivilege_Everyone_Publicly_And_Privately , ZoomVideoSDKChatPrivilege_No_One , ZoomVideoSDKChatPrivilege_Everyone_Publicly }
	Enumerates the types of chat privileges. More...
enum	ZoomVideoSDKAudioChannel { ZoomVideoSDKAudioChannel_Mono , ZoomVideoSDKAudioChannel_Stereo }
	Enumeration of audio channel types. More...
enum	ZoomVideoSDKTestMicStatus { ZoomVideoSDKMic_CanTest = 0 , ZoomVideoSDKMic_Recording , ZoomVideoSDKMic_CanPlay }
	Enumerates the microphone test statuses. More...
enum	ZoomVideoSDKFileTransferStatus {   FileTransferState_None = 0 , FileTransferState_ReadyToTransfer , FileTransferState_Transfering , FileTransferState_TransferFailed ,   FileTransferState_TransferDone }
	Enumeration of file transfer status. More...
enum	ZoomVideoSDKSessionLeaveReason {   ZoomVideoSDKSessionLeaveReason_Unknown = 0 , ZoomVideoSDKSessionLeaveReason_BySelf , ZoomVideoSDKSessionLeaveReason_KickByHost , ZoomVideoSDKSessionLeaveReason_EndByHost ,   ZoomVideoSDKSessionLeaveReason_NetworkError }
	Enumerates the possible reasons for leaving a session. More...
enum	ZoomVideoSDKMaskShape { ZoomVideoSDKMaskShape_Rectangle , ZoomVideoSDKMaskShape_Circle , ZoomVideoSDKMaskShape_Oval }
	Enumeration of the mask shape. More...
enum	ZoomVideoSDKUVCCameraStatus { ZoomVideoSDKUVCCameraStatus_Attached = 0 , ZoomVideoSDKUVCCameraStatus_Detached }
	Enumeration of the UVC camera status. More...
enum	ZoomVideoSDKSubSessionStatus {   ZoomVideoSDKSubSessionStatus_None , ZoomVideoSDKSubSessionStatus_Committed , ZoomVideoSDKSubSessionStatus_Withdrawn , ZoomVideoSDKSubSessionStatus_Started ,   ZoomVideoSDKSubSessionStatus_Stopping , ZoomVideoSDKSubSessionStatus_Stopped , ZoomVideoSDKSubSessionStatus_CommitFailed , ZoomVideoSDKSubSessionStatus_WithdrawFailed ,   ZoomVideoSDKSubSessionStatus_StartFailed , ZoomVideoSDKSubSessionStatus_StopFailed }
	Enumeration of subSession statuses. More...
enum	ZoomVideoSDKUserHelpRequestResult { ZoomVideoSDKUserHelpRequestResult_Idle = 0 , ZoomVideoSDKUserHelpRequestResult_Busy , ZoomVideoSDKUserHelpRequestResult_Ignore , ZoomVideoSDKUserHelpRequestResult_HostAlreadyInSubSession }
	Enumeration of subsession user help request results. More...
enum	ZoomVideoSDKSharePreprocessType { ZoomVideoSDKSharePreprocessType_none , ZoomVideoSDKSharePreprocessType_view }
	Enumeration of share preprocess types. More...
enum	ZoomVideoSDKShareSetting { ZoomVideoSDKShareSetting_None = 0 , ZoomVideoSDKKShareSetting_LockedShare , ZoomVideoSDKShareSetting_SingleShare , ZoomVideoSDKShareSetting_MultiShare }
	Enumeration of Zoom Video SDK share setting types. More...
enum	ZoomVideoSDKPreferVideoResolution { ZoomVideoSDKPreferVideoResolution_None , ZoomVideoSDKPreferVideoResolution_360P , ZoomVideoSDKPreferVideoResolution_720P }
	Enumeration of preferred video resolution in Zoom Video SDK. More...

Enumeration Type Documentation

ZoomVideoSDKAnnotationClearType

enum ZoomVideoSDKAnnotationClearType

Enumeration of the type for clear annotation.

Enumerator
ZoomVideoSDKAnnotationClearType_All	Clear all annotations. Hosts, managers and shared meeting owners can use.
ZoomVideoSDKAnnotationClearType_Others	Clear only the others' annotations. Only shared meeting owners can use.
ZoomVideoSDKAnnotationClearType_My	Clear only your own annotations. Everyone can use.

Definition at line 667 of file ZoomVideoSDKConstants.h.

                                                            {
    ZoomVideoSDKAnnotationClearType_All = 0,
    ZoomVideoSDKAnnotationClearType_Others,
    ZoomVideoSDKAnnotationClearType_My,
};

ZoomVideoSDKAnnotationToolType

enum ZoomVideoSDKAnnotationToolType

Enumeration of the type for annotation tool. For more information, please visit https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0067931.

Enumerator
ZoomVideoSDKAnnotationToolType_None	Switch to mouse cursor. For initialization.
ZoomVideoSDKAnnotationToolType_Pen	Pen.
ZoomVideoSDKAnnotationToolType_HighLighter	Highlighter.
ZoomVideoSDKAnnotationToolType_AutoLine	A straight line changes automatically in pace with the mouse cursor.
ZoomVideoSDKAnnotationToolType_AutoRectangle	A rectangle changes automatically in pace with the mouse cursor.
ZoomVideoSDKAnnotationToolType_AutoEllipse	An ellipse changes automatically in pace with the mouse cursor.
ZoomVideoSDKAnnotationToolType_AutoArrow	An arrow changes automatically in pace with the mouse cursor.
ZoomVideoSDKAnnotationToolType_AutoRectangleFill	A filled rectangle.
ZoomVideoSDKAnnotationToolType_AutoEllipseFill	A filled ellipse.
ZoomVideoSDKAnnotationToolType_SpotLight	Only available if you started the shared screen or whiteboard. Displays your mouse pointer to all participants when your mouse is within the area being shared. Use this to point out parts of the screen to other participants.
ZoomVideoSDKAnnotationToolType_Arrow	Displays a small arrow instead of your mouse pointer. Each subsequent click will remove the previous arrow placed.
ZoomVideoSDKAnnotationToolType_ERASER	Erase parts of your annotation.
ZoomVideoSDKAnnotationToolType_Picker	Only available if you started the shared screen or whiteboard. Select , move, or resize your annotations.
ZoomVideoSDKAnnotationToolType_AutoRectangleSemiFill	A fair rectangle changes automatically in pace with the mouse cursor.
ZoomVideoSDKAnnotationToolType_AutoEllipseSemiFill	A fair ellipse changes automatically in pace with the mouse cursor.
ZoomVideoSDKAnnotationToolType_AutoDoubleArrow	A line with a double-arrow.
ZoomVideoSDKAnnotationToolType_AutoDiamond	An unfilled rhombus.
ZoomVideoSDKAnnotationToolType_AutoStampArrow	A fixed-size arrow for marking.
ZoomVideoSDKAnnotationToolType_AutoStampCheck	A sign marking that something is correct.
ZoomVideoSDKAnnotationToolType_AutoStampX	A sign marking that something is incorrect.
ZoomVideoSDKAnnotationToolType_AutoStampStar	A star for marking.
ZoomVideoSDKAnnotationToolType_AutoStampHeart	A heart for marking.
ZoomVideoSDKAnnotationToolType_AutoStampQm	A sign for interrogation.

Definition at line 615 of file ZoomVideoSDKConstants.h.

                                                           {
    ZoomVideoSDKAnnotationToolType_None = 0,
    ZoomVideoSDKAnnotationToolType_Pen,
    ZoomVideoSDKAnnotationToolType_HighLighter,
    ZoomVideoSDKAnnotationToolType_AutoLine,
    ZoomVideoSDKAnnotationToolType_AutoRectangle,
    ZoomVideoSDKAnnotationToolType_AutoEllipse,
    ZoomVideoSDKAnnotationToolType_AutoArrow,
    ZoomVideoSDKAnnotationToolType_AutoRectangleFill,
    ZoomVideoSDKAnnotationToolType_AutoEllipseFill,
    ZoomVideoSDKAnnotationToolType_SpotLight,
    ZoomVideoSDKAnnotationToolType_Arrow,
    ZoomVideoSDKAnnotationToolType_ERASER,
    ZoomVideoSDKAnnotationToolType_Picker,
    ZoomVideoSDKAnnotationToolType_AutoRectangleSemiFill,
    ZoomVideoSDKAnnotationToolType_AutoEllipseSemiFill,
    ZoomVideoSDKAnnotationToolType_AutoDoubleArrow,
    ZoomVideoSDKAnnotationToolType_AutoDiamond,
    ZoomVideoSDKAnnotationToolType_AutoStampArrow,
    ZoomVideoSDKAnnotationToolType_AutoStampCheck,
    ZoomVideoSDKAnnotationToolType_AutoStampX,
    ZoomVideoSDKAnnotationToolType_AutoStampStar,
    ZoomVideoSDKAnnotationToolType_AutoStampHeart,
    ZoomVideoSDKAnnotationToolType_AutoStampQm,
};

ZoomVideoSDKAudioChannel

enum ZoomVideoSDKAudioChannel

Enumeration of audio channel types.

Enumerator
ZoomVideoSDKAudioChannel_Mono	Mono audio channel.
ZoomVideoSDKAudioChannel_Stereo	Stereo audio channel.

Definition at line 726 of file ZoomVideoSDKConstants.h.

                                                     {
    ZoomVideoSDKAudioChannel_Mono,
    ZoomVideoSDKAudioChannel_Stereo,
};

ZoomVideoSDKAudioType

enum ZoomVideoSDKAudioType

Enumerates the types of audio.

Enumerator
ZoomVideoSDKAudioType_None	Audio type is VOIP (Voice over IP).
ZoomVideoSDKAudioType_VOIP	Audio type is telephony.
ZoomVideoSDKAudioType_TELEPHONY	No audio type.
ZoomVideoSDKAudioType_Unknown	Unknown audio type.

Definition at line 244 of file ZoomVideoSDKConstants.h.

                                                  {
    ZoomVideoSDKAudioType_None   = 0,
    ZoomVideoSDKAudioType_VOIP,
    ZoomVideoSDKAudioType_TELEPHONY,
    ZoomVideoSDKAudioType_Unknown,
};

ZoomVideoSDKChatMsgDeleteBy

enum ZoomVideoSDKChatMsgDeleteBy

The chat message delete type are sent in the onChatMsgDeleteNotification:messageID:deleteBy: callback.

Enumerator
ZoomVideoSDKChatMsgDeleteBy_NONE	For initialization.
ZoomVideoSDKChatMsgDeleteBy_SELF	Message is deleted by the sender (self deletion).
ZoomVideoSDKChatMsgDeleteBy_HOST	Message is deleted by the session host.
ZoomVideoSDKChatMsgDeleteBy_DLP	Message is deleted by Data Loss Prevention (DLP) system for violating compliance policies.

Definition at line 517 of file ZoomVideoSDKConstants.h.

{
    ZoomVideoSDKChatMsgDeleteBy_NONE,
    ZoomVideoSDKChatMsgDeleteBy_SELF,
    ZoomVideoSDKChatMsgDeleteBy_HOST,
    ZoomVideoSDKChatMsgDeleteBy_DLP,
};

ZoomVideoSDKChatPrivilegeType

enum ZoomVideoSDKChatPrivilegeType

Enumerates the types of chat privileges.

Enumerator
ZoomVideoSDKChatPrivilege_Unknown	Unknown type.
ZoomVideoSDKChatPrivilege_Everyone_Publicly_And_Privately	The user has the privilege to chat both publicly and privately.
ZoomVideoSDKChatPrivilege_No_One	The user has no chat privileges.
ZoomVideoSDKChatPrivilege_Everyone_Publicly	Allow participant to chat with host,manager and everyone.

Definition at line 712 of file ZoomVideoSDKConstants.h.

                                                           {
    ZoomVideoSDKChatPrivilege_Unknown = 0,
    ZoomVideoSDKChatPrivilege_Everyone_Publicly_And_Privately,
    ZoomVideoSDKChatPrivilege_No_One,
    ZoomVideoSDKChatPrivilege_Everyone_Publicly,
};

ZoomVideoSDKCRCCallStatus

enum ZoomVideoSDKCRCCallStatus

Enumerates the statuses of a CRC call.

Enumerator
ZoomVideoSDKCRCCallStatus_Success	The call was successfully established.
ZoomVideoSDKCRCCallStatus_Ring	The call is ringing (waiting to be answered).
ZoomVideoSDKCRCCallStatus_Timeout	The call has timed out.
ZoomVideoSDKCRCCallStatus_Busy	The line is busy.
ZoomVideoSDKCRCCallStatus_Decline	The call was declined by the recipient.
ZoomVideoSDKCRCCallStatus_Failed	The call failed.

Definition at line 597 of file ZoomVideoSDKConstants.h.

                                                       {
    ZoomVideoSDKCRCCallStatus_Success        = 0,
    ZoomVideoSDKCRCCallStatus_Ring,
    ZoomVideoSDKCRCCallStatus_Timeout,
    ZoomVideoSDKCRCCallStatus_Busy,
    ZoomVideoSDKCRCCallStatus_Decline,
    ZoomVideoSDKCRCCallStatus_Failed,
};

ZoomVideoSDKCRCProtocol

enum ZoomVideoSDKCRCProtocol

Enumerates the types of Call CRC (Circuit-Reliable Communication).

Enumerator
ZoomVideoSDKCRCProtocol_H323	H.323 type.
ZoomVideoSDKCRCProtocol_SIP	SIP type.

Definition at line 587 of file ZoomVideoSDKConstants.h.

                                                     {
    ZoomVideoSDKCRCProtocol_H323        = 0,
    ZoomVideoSDKCRCProtocol_SIP,
};

ZoomVideoSDKDialInNumType

enum ZoomVideoSDKDialInNumType

Enumeration of the number types for calling to join the audio into a meeting.

Enumerator
ZoomVideoSDKDialInNumType_None	For initialization.
ZoomVideoSDKDialInNumType_Toll	Paid (toll) number.
ZoomVideoSDKDialInNumType_TollFree	Toll-free number.

Definition at line 532 of file ZoomVideoSDKConstants.h.

{
    ZoomVideoSDKDialInNumType_None,
    ZoomVideoSDKDialInNumType_Toll,
    ZoomVideoSDKDialInNumType_TollFree,
};

ZoomVideoSDKError

enum ZoomVideoSDKError

Enumerates all errors in the VideoSDK.

Enumerator
Errors_Success	<Success.
Errors_Wrong_Usage	Wrong usage.
Errors_Internal_Error	Internal error.
Errors_Uninitialize	SDK is not initialized.
Errors_Memory_Error	Memory allocation error.
Errors_Load_Module_Error	Failed to load module.
Errors_UnLoad_Module_Error	Failed to unload module.
Errors_Invalid_Parameter	One or more parameters are invalid.
Errors_Call_Too_Frequently	API called too frequently.
Errors_No_Impl	Function not implemented.
Errors_Dont_Support_Feature	Feature not supported.
Errors_Unknown	Unknown error.
Errors_Remove_Folder_Fail	Failed to remove folder.
Errors_Auth_Base	Authorization related errors.
Errors_Auth_Error	Authorization failure.
Errors_Auth_Empty_Key_or_Secret	App key or secret is empty.
Errors_Auth_Wrong_Key_or_Secret	App key or secret is incorrect.
Errors_Auth_DoesNot_Support_SDK	Not support SDK.
Errors_Auth_Disable_SDK	SDK is disabled.
Errors_JoinSession_NoSessionName	Join session errors. Session name is missing.
Errors_JoinSession_NoSessionToken	Session token is missing.
Errors_JoinSession_NoUserName	Username is missing.
Errors_JoinSession_Invalid_SessionName	Session name is invalid.
Errors_JoinSession_Invalid_Password	Password is incorrect.
Errors_JoinSession_Invalid_SessionToken	Session token is invalid.
Errors_JoinSession_SessionName_TooLong	Session name is too long.
Errors_JoinSession_Token_MismatchedSessionName	Token does not match session name.
Errors_JoinSession_Token_NoSessionName	Token does not contain a session name.
Errors_JoinSession_Token_RoleType_EmptyOrWrong	Role type in token is empty or incorrect.
Errors_JoinSession_Token_UserIdentity_TooLong	User identity in token is too long.
Errors_Session_Base	Session-related errors.
Errors_Session_Module_Not_Found	Session module not found.
Errors_Session_Service_Invalid	Invalid session service.
Errors_Session_Join_Failed	Failed to join session.
Errors_Session_No_Rights	No permission to join session.
Errors_Session_Already_In_Progress	Already in progress.
Errors_Session_Dont_Support_SessionType	Unsupported session type.
Errors_Session_You_Have_No_Share	You have no share.
Errors_Session_Reconnecting	Session is reconnecting.
Errors_Session_Disconnecting	Session is disconnecting.
Errors_Session_Not_Started	Session has not started.
Errors_Session_Need_Password	Password is required to join.
Errors_Session_Password_Wrong	Incorrect session password.
Errors_Session_Remote_DB_Error	Remote database error.
Errors_Session_Invalid_Param	Invalid parameter.
Errors_Session_Client_Incompatible	Client version is incompatible.
Errors_Session_Account_FreeMinutesExceeded	Free minutes exceeded.
Errors_Session_Account_FreeCreditExceeded	Join session failed because the account's free credit has been exceeded.
Errors_Session_Audio_Error	Audio errors. General audio error.
Errors_Session_Audio_No_Microphone	No microphone detected.
Errors_Session_Audio_No_Speaker	No speaker detected.
Errors_Session_Video_Error	Video errors. General video error.
Errors_Session_Video_Device_Error	Video device error.
Errors_Session_Live_Stream_Error	Live stream error.
Errors_Session_Phone_Error	Phone error.
Errors_Dont_Support_Multi_Stream_Video_User	Multi-stream video not supported for user.
Errors_Fail_Assign_User_Privilege	Failed to assign user privilege.
Errors_No_Recording_In_Process	No recording in progress.
Errors_Set_Virtual_Background_Fail	Failed to set virtual background.
Errors_Malloc_Failed	Raw data errors. Memory allocation for raw data failed.
Errors_Not_In_Session	Not in session.
Errors_No_License	No raw data license.
Errors_Video_Module_Not_Ready	Video module not ready.
Errors_Video_Module_Error	Video module error.
Errors_Video_device_error	Video device error.
Errors_No_Video_Data	No video data available.
Errors_Share_Module_Not_Ready	Share module not ready.
Errors_Share_Module_Error	Share module error.
Errors_No_Share_Data	No shared data available.
Errors_Audio_Module_Not_Ready	Audio module not ready.
Errors_Audio_Module_Error	Audio module error.
Errors_No_Audio_Data	No audio data available.
Errors_Preprocess_Rawdata_Error	Raw data pre-processing failed.
Errors_Rawdata_No_Device_Running	No device is running.
Errors_Rawdata_Init_Device	Failed to initialize media device.
Errors_Rawdata_Virtual_Device	Virtual device error.
Errors_Rawdata_Cannot_Change_Virtual_Device_In_Preview	Cannot change virtual device during preview.
Errors_Rawdata_Internal_Error	Internal raw data error.
Errors_Rawdata_Send_Too_Much_Data_In_Single_Time	Too much data sent at once.
Errors_Rawdata_Send_Too_Frequently	Data sent too frequently.
Errors_Rawdata_Virtual_Mic_Is_Terminate	Virtual microphone has been terminated.
Errors_Rawdata_Invalid_Share_Preprocessing_Data_Object	The share preprocessing data object is invalid.
Errors_Rawdata_Share_Preprocessing_Is_Stopped	Share preprocessing has stopped.
Errors_Session_Share_Error	Session sharing errors. General sharing error.
Errors_Session_Share_Module_Not_Ready	Share module not ready.
Errors_Session_Share_You_Are_Not_Sharing	You are not sharing.
Errors_Session_Share_Type_Is_Not_Support	Unsupported share type.
Errors_Session_Share_Internal_Error	Internal share error.
Errors_Session_Share_Camera_Video_Not_Start	Camera video not started for share.
Errors_Session_Share_Camera_Conflict_With_Video_Effects	Camera conflicts with video effects.
Errors_Session_Filetransfer_UnknownError	File transfer errors. Unknown file transfer error.
Errors_Session_Filetransfer_FileTypeBlocked	File type is blocked.
Errors_Session_Filetransfer_FileSizelimited	File size exceeds limit.
Errors_Spotlight_NotEnoughUsers	Spotlight errors. Not enough users to spotlight.
Errors_Spotlight_ToMuchSpotlightedUsers	Too many spotlighted users.
Errors_Spotlight_UserCannotBeSpotlighted	User cannot be spotlighted.
Errors_Spotlight_UserWithoutVideo	User has no video to spotlight.
Errors_Spotlight_UserNotSpotlighted	User is not spotlighted.

Definition at line 11 of file ZoomVideoSDKConstants.h.

{
    Errors_Success = 0,
    Errors_Wrong_Usage,
    Errors_Internal_Error,
    Errors_Uninitialize,
    Errors_Memory_Error,
    Errors_Load_Module_Error,
    Errors_UnLoad_Module_Error,
    Errors_Invalid_Parameter,
    Errors_Call_Too_Frequently,
    Errors_No_Impl,
    Errors_Dont_Support_Feature,
    Errors_Unknown,
    Errors_Remove_Folder_Fail,
 
    Errors_Auth_Base = 1000,
    Errors_Auth_Error,
    Errors_Auth_Empty_Key_or_Secret,
    Errors_Auth_Wrong_Key_or_Secret,
    Errors_Auth_DoesNot_Support_SDK,
    Errors_Auth_Disable_SDK,
 
    Errors_JoinSession_NoSessionName = 1500,
    Errors_JoinSession_NoSessionToken,
    Errors_JoinSession_NoUserName,
    Errors_JoinSession_Invalid_SessionName,
    Errors_JoinSession_Invalid_Password,
    Errors_JoinSession_Invalid_SessionToken,
    Errors_JoinSession_SessionName_TooLong,
    Errors_JoinSession_Token_MismatchedSessionName,
    Errors_JoinSession_Token_NoSessionName,
    Errors_JoinSession_Token_RoleType_EmptyOrWrong,
    Errors_JoinSession_Token_UserIdentity_TooLong,
 
    Errors_Session_Base = 2000,
    Errors_Session_Module_Not_Found,
    Errors_Session_Service_Invalid,
    Errors_Session_Join_Failed,
    Errors_Session_No_Rights,
    Errors_Session_Already_In_Progress,
    Errors_Session_Dont_Support_SessionType,
    Errors_Session_You_Have_No_Share,
    Errors_Session_Reconnecting,
    Errors_Session_Disconnecting,
    Errors_Session_Not_Started = 2010,
    Errors_Session_Need_Password,
    Errors_Session_Password_Wrong,
    Errors_Session_Remote_DB_Error,
    Errors_Session_Invalid_Param,
    Errors_Session_Client_Incompatible,
    Errors_Session_Account_FreeMinutesExceeded,
    Errors_Session_Account_FreeCreditExceeded,
 
    Errors_Session_Audio_Error = 3000,
    Errors_Session_Audio_No_Microphone,
    Errors_Session_Audio_No_Speaker,
 
    Errors_Session_Video_Error = 4000,
    Errors_Session_Video_Device_Error,
 
 
    Errors_Session_Live_Stream_Error = 5000,
 
    Errors_Session_Phone_Error = 5500,
    Errors_Dont_Support_Multi_Stream_Video_User,
    Errors_Fail_Assign_User_Privilege,
    Errors_No_Recording_In_Process,
    Errors_Set_Virtual_Background_Fail,
 
    Errors_Malloc_Failed = 6001,
    Errors_Not_In_Session,
    Errors_No_License,
    Errors_Video_Module_Not_Ready,
    Errors_Video_Module_Error,
    Errors_Video_device_error,
    Errors_No_Video_Data,
    Errors_Share_Module_Not_Ready,
    Errors_Share_Module_Error,
    Errors_No_Share_Data,
    Errors_Audio_Module_Not_Ready,
    Errors_Audio_Module_Error,
    Errors_No_Audio_Data,
    Errors_Preprocess_Rawdata_Error,
    Errors_Rawdata_No_Device_Running,
    Errors_Rawdata_Init_Device,
    Errors_Rawdata_Virtual_Device,
    Errors_Rawdata_Cannot_Change_Virtual_Device_In_Preview,
    Errors_Rawdata_Internal_Error,
    Errors_Rawdata_Send_Too_Much_Data_In_Single_Time,
    Errors_Rawdata_Send_Too_Frequently,
    Errors_Rawdata_Virtual_Mic_Is_Terminate,
    Errors_Rawdata_Invalid_Share_Preprocessing_Data_Object,
    Errors_Rawdata_Share_Preprocessing_Is_Stopped,
 
    Errors_Session_Share_Error = 7001,
    Errors_Session_Share_Module_Not_Ready,
    Errors_Session_Share_You_Are_Not_Sharing,
    Errors_Session_Share_Type_Is_Not_Support,
    Errors_Session_Share_Internal_Error,
    Errors_Session_Share_Camera_Video_Not_Start,
    Errors_Session_Share_Camera_Conflict_With_Video_Effects,
 
    Errors_Session_Filetransfer_UnknownError = 7500,
    Errors_Session_Filetransfer_FileTypeBlocked,
    Errors_Session_Filetransfer_FileSizelimited,
 
    Errors_Spotlight_NotEnoughUsers = 7600,
    Errors_Spotlight_ToMuchSpotlightedUsers,
    Errors_Spotlight_UserCannotBeSpotlighted,
    Errors_Spotlight_UserWithoutVideo,
    Errors_Spotlight_UserNotSpotlighted,
};

ZoomVideoSDKFileTransferStatus

enum ZoomVideoSDKFileTransferStatus

Enumeration of file transfer status.

Enumerator
FileTransferState_None	The file transfer has no state.
FileTransferState_ReadyToTransfer	The file transfer is ready to start.
FileTransferState_Transfering	The file transfer is in progress.
FileTransferState_TransferFailed	The file transfer failed.
FileTransferState_TransferDone	The file transfer completed successfully.

Definition at line 748 of file ZoomVideoSDKConstants.h.

                                                           {
    FileTransferState_None = 0,
    FileTransferState_ReadyToTransfer,
    FileTransferState_Transfering,
    FileTransferState_TransferFailed,
    FileTransferState_TransferDone,
};

ZoomVideoSDKFrameDataFormat

enum ZoomVideoSDKFrameDataFormat

Enumeration of raw data formats. Defines the color space format and color range for video frames.

Enumerator
ZoomVideoSDKFrameDataFormat_I420	I420 format with Limited color range.
ZoomVideoSDKFrameDataFormat_I420_Limit	I420 format with Full color range.

Definition at line 316 of file ZoomVideoSDKConstants.h.

                                                         {
    ZoomVideoSDKFrameDataFormat_I420            = 1,
    ZoomVideoSDKFrameDataFormat_I420_Limit,
};

ZoomVideoSDKLiveStreamStatus

enum ZoomVideoSDKLiveStreamStatus

Enumerates the statuses of live streaming.

Enumerator
ZoomVideoSDKLiveStreamStatus_None	The live stream status is none.
ZoomVideoSDKLiveStreamStatus_InProgress	The live stream status is currently in progress.
ZoomVideoSDKLiveStreamStatus_Connecting	The live stream status is in the process of connecting.
ZoomVideoSDKLiveStreamStatus_FailedTimeout	The live stream failed due to a timeout.
ZoomVideoSDKLiveStreamStatus_StartFailed	The live stream failed to start.
ZoomVideoSDKLiveStreamStatus_Ended	The live stream has ended.

Definition at line 298 of file ZoomVideoSDKConstants.h.

                                                          {
    ZoomVideoSDKLiveStreamStatus_None = 1,
    ZoomVideoSDKLiveStreamStatus_InProgress,
    ZoomVideoSDKLiveStreamStatus_Connecting,
    ZoomVideoSDKLiveStreamStatus_FailedTimeout,
    ZoomVideoSDKLiveStreamStatus_StartFailed,
    ZoomVideoSDKLiveStreamStatus_Ended,
};

ZoomVideoSDKLiveTranscriptionOperationType

enum ZoomVideoSDKLiveTranscriptionOperationType

Enumerates the types of operations related to live transcription.

Enumerator
ZoomVideoSDKLiveTranscriptionOperationType_None	No operation specified.
ZoomVideoSDKLiveTranscriptionOperationType_Add	Live transcription operation type is added.
ZoomVideoSDKLiveTranscriptionOperationType_Update	Live transcription operation type is updated.
ZoomVideoSDKLiveTranscriptionOperationType_Delete	Live transcription operation type is deleted.
ZoomVideoSDKLiveTranscriptionOperationType_Complete	Live transcription operation type is marked as complete.
ZoomVideoSDKLiveTranscriptionOperationType_NotSupported	Live transcription operation type is not supported.

Definition at line 489 of file ZoomVideoSDKConstants.h.

                                                                        {
    ZoomVideoSDKLiveTranscriptionOperationType_None,
    ZoomVideoSDKLiveTranscriptionOperationType_Add,
    ZoomVideoSDKLiveTranscriptionOperationType_Update,
    ZoomVideoSDKLiveTranscriptionOperationType_Delete,
    ZoomVideoSDKLiveTranscriptionOperationType_Complete,
    ZoomVideoSDKLiveTranscriptionOperationType_NotSupported,
};

ZoomVideoSDKLiveTranscriptionStatus

enum ZoomVideoSDKLiveTranscriptionStatus

Enumerates the status of live transcription.

Enumerator
ZoomVideoSDKLiveTranscriptionStatus_Stop	Live transcription is currently stopped.
ZoomVideoSDKLiveTranscriptionStatus_Start	Live transcription is currently active.

Definition at line 479 of file ZoomVideoSDKConstants.h.

                                                                 {
    ZoomVideoSDKLiveTranscriptionStatus_Stop,
    ZoomVideoSDKLiveTranscriptionStatus_Start,
};

ZoomVideoSDKMaskShape

enum ZoomVideoSDKMaskShape

Enumeration of the mask shape.

Enumerator
ZoomVideoSDKMaskShape_Rectangle	Rectangle.
ZoomVideoSDKMaskShape_Circle	Circle.
ZoomVideoSDKMaskShape_Oval	Oval.

Definition at line 780 of file ZoomVideoSDKConstants.h.

                                                   {
    ZoomVideoSDKMaskShape_Rectangle,
    ZoomVideoSDKMaskShape_Circle,
    ZoomVideoSDKMaskShape_Oval,
};

ZoomVideoSDKMultiCameraStreamStatus

enum ZoomVideoSDKMultiCameraStreamStatus

Enumerates the status of multi-camera streams.

Enumerator
ZoomVideoSDKMultiCameraStreamStatus_JoinStart	Current user only. Sent when the current user attempts to use multiple cameras in the session.
ZoomVideoSDKMultiCameraStreamStatus_JoinFail	Current user only. Sent when the current user fails to use multiple cameras in the session.
ZoomVideoSDKMultiCameraStreamStatus_Joined	Broadcast to all users. Sent when a new camera has been successfully added to the session as the multiple cameras.
ZoomVideoSDKMultiCameraStreamStatus_Left	Broadcast to all users. Sent after a camera that is being used as the multiple cameras leaves the session.
ZoomVideoSDKMultiCameraStreamStatus_VideoOn	Broadcast to all users. Sent when a multiple camera is started.
ZoomVideoSDKMultiCameraStreamStatus_VideoOff	Broadcast to all users. Sent when a multiple camera is stopped.

Definition at line 461 of file ZoomVideoSDKConstants.h.

                                                                 {
    ZoomVideoSDKMultiCameraStreamStatus_JoinStart,
    ZoomVideoSDKMultiCameraStreamStatus_JoinFail,
    ZoomVideoSDKMultiCameraStreamStatus_Joined,
    ZoomVideoSDKMultiCameraStreamStatus_Left,
    ZoomVideoSDKMultiCameraStreamStatus_VideoOn,
    ZoomVideoSDKMultiCameraStreamStatus_VideoOff,
};

ZoomVideoSDKNetworkStatus

enum ZoomVideoSDKNetworkStatus

Enumerates the network statuses.

Enumerator
ZoomVideoSDKNetworkStatus_None	For initialization.
ZoomVideoSDKNetworkStatus_Bad	The network connection is poor, affecting video quality.
ZoomVideoSDKNetworkStatus_Normal	The network connection is stable with typical performance.
ZoomVideoSDKNetworkStatus_Good	The network connection is strong and stable, providing optimal performance.

Definition at line 546 of file ZoomVideoSDKConstants.h.

{
    ZoomVideoSDKNetworkStatus_None,
    ZoomVideoSDKNetworkStatus_Bad,
    ZoomVideoSDKNetworkStatus_Normal,
    ZoomVideoSDKNetworkStatus_Good,
};

ZoomVideoSDKPhoneFailedReason

enum ZoomVideoSDKPhoneFailedReason

Enumerates the various reasons for a phone call failure.

Enumerator
ZoomVideoSDKPhoneFailedReason_None	For initialization.
ZoomVideoSDKPhoneFailedReason_Busy	The telephone number is currently busy.
ZoomVideoSDKPhoneFailedReason_Not_Available	The telephone number is out of service.
ZoomVideoSDKPhoneFailedReason_User_Hangup	The user manually hung up the call.
ZoomVideoSDKPhoneFailedReason_Other_Fail	Other reasons.
ZoomVideoSDKPhoneFailedReason_No_Answer	The user did not answer the call within the allowed time.
ZoomVideoSDKPhoneFailedReason_Block_No_Host	The call invitation was blocked by the system due to an absent host.
ZoomVideoSDKPhoneFailedReason_Block_High_Rate	The call-out attempt was blocked by the system due to the high rates or cost.
ZoomVideoSDKPhoneFailedReason_Block_Too_Frequent	To join the session, the invitee would press one on the phone. An invitee who fails to respond will encounter a timeout. If there are too many invitee timeouts, the call invitation feature for this session will be blocked.

Definition at line 403 of file ZoomVideoSDKConstants.h.

                                                           {
    ZoomVideoSDKPhoneFailedReason_None,
    ZoomVideoSDKPhoneFailedReason_Busy,
    ZoomVideoSDKPhoneFailedReason_Not_Available,
    ZoomVideoSDKPhoneFailedReason_User_Hangup,
    ZoomVideoSDKPhoneFailedReason_Other_Fail,
    ZoomVideoSDKPhoneFailedReason_No_Answer,
    ZoomVideoSDKPhoneFailedReason_Block_No_Host,
    ZoomVideoSDKPhoneFailedReason_Block_High_Rate,
    ZoomVideoSDKPhoneFailedReason_Block_Too_Frequent,
};

ZoomVideoSDKPhoneStatus

enum ZoomVideoSDKPhoneStatus

Enumerates the statuses of a phone call.

Enumerator
ZoomVideoSDKPhoneStatus_None	For initialization.
ZoomVideoSDKPhoneStatus_Calling	In the process of calling out.
ZoomVideoSDKPhoneStatus_Ringing	In the process of ringing.
ZoomVideoSDKPhoneStatus_Accepted	Call has been accepted.
ZoomVideoSDKPhoneStatus_Success	Call was successful.
ZoomVideoSDKPhoneStatus_Failed	Call failed.
ZoomVideoSDKPhoneStatus_Canceling	In process of canceling the response to the previous state.
ZoomVideoSDKPhoneStatus_Canceled	The call has been successfully canceled.
ZoomVideoSDKPhoneStatus_Cancel_Failed	The attempt to cancel the call has failed.
ZoomVideoSDKPhoneStatus_Timeout	The call attempt has timed out.

Definition at line 376 of file ZoomVideoSDKConstants.h.

                                                     {
    ZoomVideoSDKPhoneStatus_None,
    ZoomVideoSDKPhoneStatus_Calling,
    ZoomVideoSDKPhoneStatus_Ringing,
    ZoomVideoSDKPhoneStatus_Accepted,
    ZoomVideoSDKPhoneStatus_Success,
    ZoomVideoSDKPhoneStatus_Failed,
    ZoomVideoSDKPhoneStatus_Canceling,
    ZoomVideoSDKPhoneStatus_Canceled,
    ZoomVideoSDKPhoneStatus_Cancel_Failed,
    ZoomVideoSDKPhoneStatus_Timeout,
};

ZoomVideoSDKPreferVideoResolution

enum ZoomVideoSDKPreferVideoResolution

Enumeration of preferred video resolution in Zoom Video SDK.

Enumerator
ZoomVideoSDKPreferVideoResolution_None	Invalid value .
ZoomVideoSDKPreferVideoResolution_360P	The camera opens in 360p by default.
ZoomVideoSDKPreferVideoResolution_720P	The camera opens in 720p by default.

Definition at line 871 of file ZoomVideoSDKConstants.h.

                                                               {
    ZoomVideoSDKPreferVideoResolution_None,
    ZoomVideoSDKPreferVideoResolution_360P,
    ZoomVideoSDKPreferVideoResolution_720P
};

ZoomVideoSDKRawDataMemoryMode

enum ZoomVideoSDKRawDataMemoryMode

Enumeration of memory modes for raw data handling.

Enumerator
ZoomVideoSDKRawDataMemoryModeStack	The memory mode is srack.
ZoomVideoSDKRawDataMemoryModeHeap	The memory mode is heap.

Definition at line 356 of file ZoomVideoSDKConstants.h.

                                                           {
    ZoomVideoSDKRawDataMemoryModeStack,
    ZoomVideoSDKRawDataMemoryModeHeap
};

ZoomVideoSDKReceiveSharingStatus

enum ZoomVideoSDKReceiveSharingStatus

Enumerates the status of sharing.

Enumerator
ZoomVideoSDKReceiveSharingStatus_None	No view or screen share available.
ZoomVideoSDKReceiveSharingStatus_Start	User started sharing.
ZoomVideoSDKReceiveSharingStatus_Pause	User paused sharing.
ZoomVideoSDKReceiveSharingStatus_Resume	User resumed sharing.
ZoomVideoSDKReceiveSharingStatus_Stop	User stopped sharing.

Definition at line 282 of file ZoomVideoSDKConstants.h.

                                                              {
    ZoomVideoSDKReceiveSharingStatus_None = 0,
    ZoomVideoSDKReceiveSharingStatus_Start,
    ZoomVideoSDKReceiveSharingStatus_Pause,
    ZoomVideoSDKReceiveSharingStatus_Resume,
    ZoomVideoSDKReceiveSharingStatus_Stop,
};

ZoomVideoSDKRecordAgreementType

enum ZoomVideoSDKRecordAgreementType

Enumerates the types of consent for cloud recording.

Enumerator
ZoomVideoSDKRecordAgreementType_Invalid	Invalid type.
ZoomVideoSDKRecordAgreementType_Traditional	In this case, 'accept' means agree to be recorded to gallery and speaker mode, 'decline' means leave session.
ZoomVideoSDKRecordAgreementType_Individual_Only	In this case, 'accept' means agree to be recorded to a separate file, 'decline' means stay in session and can't be recorded.

Definition at line 561 of file ZoomVideoSDKConstants.h.

{
    ZoomVideoSDKRecordAgreementType_Invalid,
    ZoomVideoSDKRecordAgreementType_Traditional,
    ZoomVideoSDKRecordAgreementType_Individual_Only,
};

ZoomVideoSDKRecordingStatus

enum ZoomVideoSDKRecordingStatus

An enum representing the status of the recording status.

Enumerator
ZoomVideoSDKRecordingStatus_None	For initialization.
ZoomVideoSDKRecordingStatus_Start	The recording has successfully started or successfully resumed.
ZoomVideoSDKRecordingStatus_Stop	The recording has stopped.
ZoomVideoSDKRecordingStatus_DiskFull	Recording is unsuccessful due to insufficient storage space.Please try to:1.Free up storage space 2.Purchase additional storage space.
ZoomVideoSDKRecordingStatus_Pause	The recording has paused.
ZoomVideoSDKRecordingStatus_Connecting	The recording connecting.

Definition at line 429 of file ZoomVideoSDKConstants.h.

                                                         {
    ZoomVideoSDKRecordingStatus_None,
    ZoomVideoSDKRecordingStatus_Start,
    ZoomVideoSDKRecordingStatus_Stop,
    ZoomVideoSDKRecordingStatus_DiskFull,
    ZoomVideoSDKRecordingStatus_Pause,
    ZoomVideoSDKRecordingStatus_Connecting,
};

ZoomVideoSDKSessionLeaveReason

enum ZoomVideoSDKSessionLeaveReason

Enumerates the possible reasons for leaving a session.

Enumerator
ZoomVideoSDKSessionLeaveReason_Unknown	Unknown.
ZoomVideoSDKSessionLeaveReason_BySelf	Leave session by self.
ZoomVideoSDKSessionLeaveReason_KickByHost	Kicked by host.
ZoomVideoSDKSessionLeaveReason_EndByHost	Ended by host.
ZoomVideoSDKSessionLeaveReason_NetworkError	Network error.

Definition at line 764 of file ZoomVideoSDKConstants.h.

                                                           {
    ZoomVideoSDKSessionLeaveReason_Unknown = 0,
    ZoomVideoSDKSessionLeaveReason_BySelf,
    ZoomVideoSDKSessionLeaveReason_KickByHost,
    ZoomVideoSDKSessionLeaveReason_EndByHost,
    ZoomVideoSDKSessionLeaveReason_NetworkError,
};

ZoomVideoSDKSessionType

enum ZoomVideoSDKSessionType

Enumeration of session type.

Enumerator
ZoomVideoSDKSessionType_MainSession	The session type is main session.
ZoomVideoSDKSessionType_SubSession	The session type is subSession.

Definition at line 233 of file ZoomVideoSDKConstants.h.

{
    ZoomVideoSDKSessionType_MainSession = 0,
    ZoomVideoSDKSessionType_SubSession,
};

ZoomVideoSDKSharePreprocessType

enum ZoomVideoSDKSharePreprocessType

Enumeration of share preprocess types.

Enumerator
ZoomVideoSDKSharePreprocessType_none	For initialization.
ZoomVideoSDKSharePreprocessType_view	For share view

Definition at line 844 of file ZoomVideoSDKConstants.h.

                                                             {
    ZoomVideoSDKSharePreprocessType_none,
    ZoomVideoSDKSharePreprocessType_view,
};

ZoomVideoSDKShareSetting

enum ZoomVideoSDKShareSetting

Enumeration of Zoom Video SDK share setting types.

Enumerator
ZoomVideoSDKShareSetting_None	For initialization.
ZoomVideoSDKKShareSetting_LockedShare	Only host and manager can share.
ZoomVideoSDKShareSetting_SingleShare	Anyone can share, but only one at a time. Only host and manager can take over.
ZoomVideoSDKShareSetting_MultiShare	Multiple participants can share simultaneously.

Definition at line 854 of file ZoomVideoSDKConstants.h.

{
    ZoomVideoSDKShareSetting_None = 0,
    ZoomVideoSDKKShareSetting_LockedShare,
    ZoomVideoSDKShareSetting_SingleShare,
    ZoomVideoSDKShareSetting_MultiShare
};

ZoomVideoSDKShareType

enum ZoomVideoSDKShareType

Enumerates the types of content that can be shared in a session.

Enumerator
ZoomVideoSDKShareType_None
ZoomVideoSDKShareType_Normal	Application or desktop share.
ZoomVideoSDKShareType_PureAudio	Pure computer audio share.
ZoomVideoSDKShareType_Camera	Camera share.

Definition at line 697 of file ZoomVideoSDKConstants.h.

{
    ZoomVideoSDKShareType_None,
    ZoomVideoSDKShareType_Normal,
    ZoomVideoSDKShareType_PureAudio,
    ZoomVideoSDKShareType_Camera,
};

ZoomVideoSDKSubscribeFailReason

enum ZoomVideoSDKSubscribeFailReason

Enumerates the reasons for a failed video subscription attempt.

Enumerator
ZoomVideoSDKSubscribeFailReason_None	No subscription failure (initial state).
ZoomVideoSDKSubscribeFailReason_HasSubscribeShare	The subscription attempt failed because has already subscribed to two shared video streams.
ZoomVideoSDKSubscribeFailReason_HasSubscribeExceededLimit	The subscription attempt failed because has exceeded the maximum allowed subscription limit.
ZoomVideoSDKSubscribeFailReason_HasSubscribe1080POr720P	The subscription attempt failed because has already subscribed to a 1080P or 720P video stream.
ZoomVideoSDKSubscribeFailReason_HasSubscribeOneShare	Try to subscribe the second share.
ZoomVideoSDKSubscribeFailReason_TooFrequentCall	The subscription attempt failed because subscription requests were made too frequently in a short period of time.

Definition at line 679 of file ZoomVideoSDKConstants.h.

                                                             {
    ZoomVideoSDKSubscribeFailReason_None = 0,
    ZoomVideoSDKSubscribeFailReason_HasSubscribeShare,
    ZoomVideoSDKSubscribeFailReason_HasSubscribeExceededLimit,
    ZoomVideoSDKSubscribeFailReason_HasSubscribe1080POr720P,
    ZoomVideoSDKSubscribeFailReason_HasSubscribeOneShare,
    ZoomVideoSDKSubscribeFailReason_TooFrequentCall,
};

ZoomVideoSDKSubSessionStatus

enum ZoomVideoSDKSubSessionStatus

Enumeration of subSession statuses.

Enumerator
ZoomVideoSDKSubSessionStatus_None	The Initialized status.
ZoomVideoSDKSubSessionStatus_Committed	When a subsession is committed.
ZoomVideoSDKSubSessionStatus_Withdrawn	When a subsession is withdrawn.
ZoomVideoSDKSubSessionStatus_Started	When the subsession is started.
ZoomVideoSDKSubSessionStatus_Stopping	When the subsession is stopping.
ZoomVideoSDKSubSessionStatus_Stopped	When the subsession is stopped.
ZoomVideoSDKSubSessionStatus_CommitFailed	When commit subsession failed.
ZoomVideoSDKSubSessionStatus_WithdrawFailed	When withdraw subsession failed.
ZoomVideoSDKSubSessionStatus_StartFailed	When start subsession failed.
ZoomVideoSDKSubSessionStatus_StopFailed	When stop subsession failed.

Definition at line 802 of file ZoomVideoSDKConstants.h.

{
    ZoomVideoSDKSubSessionStatus_None,
    ZoomVideoSDKSubSessionStatus_Committed,
    ZoomVideoSDKSubSessionStatus_Withdrawn,
    ZoomVideoSDKSubSessionStatus_Started,
    ZoomVideoSDKSubSessionStatus_Stopping,
    ZoomVideoSDKSubSessionStatus_Stopped,
    ZoomVideoSDKSubSessionStatus_CommitFailed,
    ZoomVideoSDKSubSessionStatus_WithdrawFailed,
    ZoomVideoSDKSubSessionStatus_StartFailed,
    ZoomVideoSDKSubSessionStatus_StopFailed,
};

ZoomVideoSDKSystemPermissionType

enum ZoomVideoSDKSystemPermissionType

Enumerates the types of device permission.

Enumerator
ZoomVideoSDKSystemPermissionType_Camera	System permission - Camera is needed.
ZoomVideoSDKSystemPermissionType_Microphone	System permission - Microphone is needed.

Definition at line 507 of file ZoomVideoSDKConstants.h.

                                                              {
    ZoomVideoSDKSystemPermissionType_Camera,
    ZoomVideoSDKSystemPermissionType_Microphone,
};

ZoomVideoSDKTestMicStatus

enum ZoomVideoSDKTestMicStatus

Enumerates the microphone test statuses.

Enumerator
ZoomVideoSDKMic_CanTest	The microphone is ready to start a test.
ZoomVideoSDKMic_Recording	The microphone is currently recording audio for the test.
ZoomVideoSDKMic_CanPlay	The recorded audio is ready for playback.

Definition at line 736 of file ZoomVideoSDKConstants.h.

                                                      {
    ZoomVideoSDKMic_CanTest = 0,
    ZoomVideoSDKMic_Recording,
    ZoomVideoSDKMic_CanPlay,
};

ZoomVideoSDKUserHelpRequestResult

enum ZoomVideoSDKUserHelpRequestResult

Enumeration of subsession user help request results.

Enumerator
ZoomVideoSDKUserHelpRequestResult_Idle	The h receive the help request and there is no other one currently requesting for help.
ZoomVideoSDKUserHelpRequestResult_Busy	Host is handling another use's request with the request dialog.
ZoomVideoSDKUserHelpRequestResult_Ignore	The host is handling another user's request.
ZoomVideoSDKUserHelpRequestResult_HostAlreadyInSubSession	The host is already in this subsession.

Definition at line 829 of file ZoomVideoSDKConstants.h.

{
    ZoomVideoSDKUserHelpRequestResult_Idle = 0,
    ZoomVideoSDKUserHelpRequestResult_Busy,
    ZoomVideoSDKUserHelpRequestResult_Ignore,
    ZoomVideoSDKUserHelpRequestResult_HostAlreadyInSubSession
};

ZoomVideoSDKUserRawdataStatus

enum ZoomVideoSDKUserRawdataStatus

Enumeration the statuses of raw data.

Enumerator
ZoomVideoSDKUserRawdataOn	The raw data status is on.
ZoomVideoSDKUserRawdataOff	The raw data status if off.

Definition at line 366 of file ZoomVideoSDKConstants.h.

                                                           {
    ZoomVideoSDKUserRawdataOn,
    ZoomVideoSDKUserRawdataOff
};

ZoomVideoSDKUVCCameraStatus

enum ZoomVideoSDKUVCCameraStatus

Enumeration of the UVC camera status.

Enumerator
ZoomVideoSDKUVCCameraStatus_Attached	UVC camera attached.
ZoomVideoSDKUVCCameraStatus_Detached	UVC camera detached.

Definition at line 792 of file ZoomVideoSDKConstants.h.

                                                        {
    ZoomVideoSDKUVCCameraStatus_Attached = 0,
    ZoomVideoSDKUVCCameraStatus_Detached
};

ZoomVideoSDKVideoAspect

enum ZoomVideoSDKVideoAspect

Enumeration of the video aspect ratio.

Enumerator
ZoomVideoSDKVideoAspect_Original	Display the captured data without any cropping or scaling.
ZoomVideoSDKVideoAspect_Full_Filled	Stretch both horizontally and vertically to fill the display (may cause distortion).
ZoomVideoSDKVideoAspect_LetterBox	Add black bars to maintain aspect ratio (e.g., 16:9 content on a 4:3 display or vice versa).
ZoomVideoSDKVideoAspect_PanAndScan	Crop the sides or top/bottom to fill the screen (e.g., cut sides for 16:9 on 4:3, or top/bottom for 4:3 on 16:9).

Definition at line 258 of file ZoomVideoSDKConstants.h.

                                                     {
    ZoomVideoSDKVideoAspect_Original         = 0,
    ZoomVideoSDKVideoAspect_Full_Filled,
    ZoomVideoSDKVideoAspect_LetterBox,
    ZoomVideoSDKVideoAspect_PanAndScan,
};

ZoomVideoSDKVideoPreferenceMode

enum ZoomVideoSDKVideoPreferenceMode

Enumerates the video preference modes.

Enumerator
ZoomVideoSDKVideoPreferenceMode_Balance	Balance mode.
ZoomVideoSDKVideoPreferenceMode_Sharpness	Sharpness mode, prioritizing video clarity.
ZoomVideoSDKVideoPreferenceMode_Smoothness	Smoothness mode, focusing on a smooth video experience.
ZoomVideoSDKVideoPreferenceMode_Custom	Custom mode, allowing user-defined video preferences.

Definition at line 447 of file ZoomVideoSDKConstants.h.

                                                             {
    ZoomVideoSDKVideoPreferenceMode_Balance,
    ZoomVideoSDKVideoPreferenceMode_Sharpness,
    ZoomVideoSDKVideoPreferenceMode_Smoothness,
    ZoomVideoSDKVideoPreferenceMode_Custom,
};

ZoomVideoSDKVideoRawDataRotation

enum ZoomVideoSDKVideoRawDataRotation

RawDataRotationof the directions of video.

Enumerator
ZoomVideoSDKVideoRawDataRotationNone	Video direction 0
ZoomVideoSDKVideoRawDataRotation90	Video direction 90
ZoomVideoSDKVideoRawDataRotation180	Video direction 180
ZoomVideoSDKVideoRawDataRotation270	Video direction 270

Definition at line 326 of file ZoomVideoSDKConstants.h.

                                                             {
    ZoomVideoSDKVideoRawDataRotationNone      = 1,
    ZoomVideoSDKVideoRawDataRotation90,
    ZoomVideoSDKVideoRawDataRotation180,
    ZoomVideoSDKVideoRawDataRotation270,
};

ZoomVideoSDKVideoResolution

enum ZoomVideoSDKVideoResolution

Enumeration of render resolution.

Enumerator
ZoomVideoSDKVideoResolution_90	The resolution is 90p.
ZoomVideoSDKVideoResolution_180	The resolution is 180p.
ZoomVideoSDKVideoResolution_360	The resolution is 360p.
ZoomVideoSDKVideoResolution_720	The resolution is 720p. Video resolution might be 1080p based on the user's network condition and device specs.
ZoomVideoSDKVideoResolution_Auto	The resolution is changed automatically according to the size of the view, only avaliable for video canvas.

Definition at line 340 of file ZoomVideoSDKConstants.h.

                                                         {
    ZoomVideoSDKVideoResolution_90,
    ZoomVideoSDKVideoResolution_180,
    ZoomVideoSDKVideoResolution_360,
    ZoomVideoSDKVideoResolution_720,
    ZoomVideoSDKVideoResolution_Auto = 100,
};

ZoomVideoSDKVideoType

enum ZoomVideoSDKVideoType

Enumeration of video type.

Enumerator
ZoomVideoSDKVideoType_VideoData	Video Camera Data.
ZoomVideoSDKVideoType_ShareData	Share Data.

Definition at line 272 of file ZoomVideoSDKConstants.h.

                                                   {
    ZoomVideoSDKVideoType_VideoData  = 1,
    ZoomVideoSDKVideoType_ShareData,
};

ZoomVideoSDKVirtualBackgroundDataType

enum ZoomVideoSDKVirtualBackgroundDataType

Enumerates the types of virtual backgrounds.

Enumerator
ZoomVideoSDKVirtualBackgroundDataType_None	No virtual background is applied.
ZoomVideoSDKVirtualBackgroundDataType_Image	An image is used as the virtual background.
ZoomVideoSDKVirtualBackgroundDataType_Blur	A blur effect is applied to the background.

Definition at line 574 of file ZoomVideoSDKConstants.h.

{
    ZoomVideoSDKVirtualBackgroundDataType_None,
    ZoomVideoSDKVirtualBackgroundDataType_Image,
    ZoomVideoSDKVirtualBackgroundDataType_Blur,
};