Definitions of error codes, enumerations, and constants used throughout the Zoom SDK. More...

import <Foundation/Foundation.h>

Enumerations
enum	ZoomSDKUserType { ZoomSDKUserType_ZoomUser = 100 , ZoomSDKUserType_SSOUser = 101 , ZoomSDKUserType_WithoutLogin = 102 }
	Enumeration of user types. More...
enum	SDKUserType { SDKUserType_APIUser , SDKUserType_EmailLogin , SDKUserType_FaceBook , SDKUserType_GoogleOAuth , SDKUserType_SSO , SDKUserType_Unknown }
	Enumeration of the types of users. More...
enum	LeaveMeetingCmd { LeaveMeetingCmd_Leave , LeaveMeetingCmd_End }
	Enumeration of commands for leaving meeting. More...
enum	ActionMeetingCmd { ActionMeetingCmd_MuteVideo , ActionMeetingCmd_UnMuteVideo , ActionMeetingCmd_MuteAudio , ActionMeetingCmd_UnMuteAudio , ActionMeetingCmd_EnableUnmuteBySelf , ActionMeetingCmd_DisableUnmuteBySelf , ActionMeetingCmd_MuteAll , ActionMeetingCmd_UnmuteAll , ActionMeetingCmd_LockMeeting , ActionMeetingCmd_UnLockMeeting , ActionMeetingCmd_ShareFitWindowMode , ActionMeetingCmd_PauseShare , ActionMeetingCmd_ResumeShare , ActionMeetingCmd_JoinVoip , ActionMeetingCmd_LeaveVoip }
	Enumeration of all the commands in the meeting. More...
enum	MeetingPropertyCmd { MeetingPropertyCmd_Topic , MeetingPropertyCmd_InviteEmailTemplate , MeetingPropertyCmd_InviteEmailTitle , MeetingPropertyCmd_JoinMeetingUrl , MeetingPropertyCmd_DefaultRecordPath , MeetingPropertyCmd_MeetingNumber , MeetingPropertyCmd_HostTag , MeetingPropertyCmd_MeetingID , MeetingPropertyCmd_MeetingPassword }
	Get default information of meeting. More...
enum	AnnotationToolType { AnnotationToolType_None , AnnotationToolType_Pen , AnnotationToolType_HighLighter , AnnotationToolType_AutoLine , AnnotationToolType_AutoRectangle , AnnotationToolType_AutoEllipse , AnnotationToolType_AutoArrow , AnnotationToolType_AutoRectangleFill , AnnotationToolType_AutoEllipseFill , AnnotationToolType_SpotLight , AnnotationToolType_Arrow , AnnotationToolType_ERASER , AnnotationToolType_Textbox , AnnotationToolType_Picker , AnnotationToolType_AutoRectangleSemiFill , AnnotationToolType_AutoEllipseSemiFill , AnnotationToolType_AutoDoubleArrow , AnnotationToolType_AutoDiamond , AnnotationToolType_AutoStampArrow , AnnotationToolType_AutoStampCheck , AnnotationToolType_AutoStampX , AnnotationToolType_AutoStampStar , AnnotationToolType_AutoStampHeart , AnnotationToolType_AutoStampQm }
	Type of annotation tools. For more information, please visit https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0067931. More...
enum	AnnotationClearType { AnnotationClearType_All , AnnotationClearType_Self , AnnotationClearType_Other }
	Types of clearing annotations. More...
enum	MeetingComponent { MeetingComponent_MainWindow , MeetingComponent_Audio , MeetingComponent_Chat , MeetingComponent_Participants , MeetingComponent_MainToolBar , MeetingComponent_MainShareToolBar , MeetingComponent_AuxShareToolBar , MeetingComponent_Setting , MeetingComponent_ShareOptionWindow , MeetingComponent_ThumbnailVideo , MeetingComponent_InviteWindow , MeetingComponent_ShareSelectWindow }
	In-meeting UI components. More...
enum	MeetingSettingCmd { MeetingSettingCmd_DualScreenMode , MeetingSettingCmd_AutoFullScreenWhenJoinMeeting , MeetingSettingCmd_EnablePlayChimeWhenEnterOrExit }
	Enumeration of Meeting settings. More...
enum	ZoomSDKError { ZoomSDKError_Success , ZoomSDKError_Failed , ZoomSDKError_Uninit , ZoomSDKError_ServiceFailed , ZoomSDKError_WrongUsage , ZoomSDKError_InvalidParameter , ZoomSDKError_NoPermission , ZoomSDKError_NoRecordingInProgress , ZoomSDKError_TooFrequentCall , ZoomSDKError_UnSupportedFeature , ZoomSDKError_EmailLoginIsDisabled , ZoomSDKError_ModuleLoadFail , ZoomSDKError_NoVideoData , ZoomSDKError_NoAudioData , ZoomSDKError_NoShareData , ZoomSDKError_NoVideoDeviceFound , ZoomSDKError_DeviceError , ZoomSDKError_NotInMeeting , ZoomSDKError_initDevice , ZoomSDKError_CanNotChangeVirtualDevice , ZoomSDKError_PreprocessRawdataError , ZoomSDKError_NoLicense , ZoomSDKError_Malloc_Failed , ZoomSDKError_ShareCannotSubscribeMyself , ZoomSDKError_NeedUserConfirmRecordDisclaimer , ZoomSDKError_UnKnown , ZoomSDKError_NotJoinAudio , ZoomSDKError_HardwareDontSupport , ZoomSDKError_DomainDontSupport , ZoomSDKError_FileTransferError }
	Enumeration of common errors of SDK. More...
enum	ZoomSDKAuthError { ZoomSDKAuthError_Success = 0 , ZoomSDKAuthError_KeyOrSecretWrong , ZoomSDKAuthError_AccountNotSupport , ZoomSDKAuthError_AccountNotEnableSDK , ZoomSDKAuthError_Timeout , ZoomSDKAuthError_NetworkIssue , ZoomSDKAuthError_Client_Incompatible , ZoomSDKAuthError_JwtTokenWrong , ZoomSDKAuthError_KeyOrSecretEmpty , ZoomSDKAuthError_LimitExceededException , ZoomSDKAuthError_Unknown = 100 }
	Enumeration of SDK authentication results. More...
enum	ZoomSDKPremeetingError { ZoomSDKPremeetingError_Success , ZoomSDKPremeetingError_Failed , ZoomSDKPremeetingError_TimeOut , ZoomSDKPremeetingError_Unknown = 100 }
	Enumeration of SDK pre-meeting errors. More...
enum	ZoomSDKMeetingError { ZoomSDKMeetingError_Success = 0 , ZoomSDKMeetingError_ConnectionError = 1 , ZoomSDKMeetingError_ReconnectFailed = 2 , ZoomSDKMeetingError_MMRError = 3 , ZoomSDKMeetingError_PasswordError = 4 , ZoomSDKMeetingError_SessionError = 5 , ZoomSDKMeetingError_MeetingOver = 6 , ZoomSDKMeetingError_MeetingNotStart = 7 , ZoomSDKMeetingError_MeetingNotExist = 8 , ZoomSDKMeetingError_UserFull = 9 , ZoomSDKMeetingError_ClientIncompatible = 10 , ZoomSDKMeetingError_NoMMR = 11 , ZoomSDKMeetingError_MeetingLocked = 12 , ZoomSDKMeetingError_MeetingRestricted = 13 , ZoomSDKMeetingError_MeetingJBHRestricted = 14 , ZoomSDKMeetingError_EmitWebRequestFailed = 15 , ZoomSDKMeetingError_StartTokenExpired = 16 , ZoomSDKMeetingError_VideoSessionError = 17 , ZoomSDKMeetingError_AudioAutoStartError = 18 , ZoomSDKMeetingError_RegisterWebinarFull = 19 , ZoomSDKMeetingError_RegisterWebinarHostRegister = 20 , ZoomSDKMeetingError_RegisterWebinarPanelistRegister = 21 , ZoomSDKMeetingError_RegisterWebinarDeniedEmail = 22 , ZoomSDKMeetingError_RegisterWebinarEnforceLogin = 23 , ZoomSDKMeetingError_ZCCertificateChanged = 24 , ZoomSDKMeetingError_vanityNotExist = 27 , ZoomSDKMeetingError_joinWebinarWithSameEmail = 28 , ZoomSDKMeetingError_disallowHostMeeting = 29 , ZoomSDKMeetingError_ConfigFileWriteFailed = 50 , ZoomSDKMeetingError_forbidToJoinInternalMeeting = 60 , ZoomSDKMeetingError_RemovedByHost = 61 , ZoomSDKMeetingError_HostDisallowOutsideUserJoin = 62 , ZoomSDKMeetingError_UnableToJoinExternalMeeting = 63 , ZoomSDKMeetingError_BlockedByAccountAdmin = 64 , ZoomSDKMeetingError_NeedSigninForPrivateMeeting = 82 , ZoomSDKMeetingError_NeedConfirmPlink = 88 , ZoomSDKMeetingError_NeedInputPlink = 89 , ZoomSDKMeetingError_Unknown = 100 , ZoomSDKMeetingError_None = 101 , ZoomSDKMeetingError_AppPrivilegeTokenError = 500 , ZoomSDKMeetingError_AuthorizedUserNotInMeeting = 501 , ZoomSDKMeetingError_OnBehalfTokenConflictLoginError = 502 , ZoomSDKMeetingError_UserLevelTokenNotHaveHostZakObf = 503 , ZoomSDKMeetingError_AppCanNotAnonymousJoinMeeting = 504 , ZoomSDKMeetingError_OnBehalfTokenInvalid = 505 , ZoomSDKMeetingError_OnBehalfTokenNotMatchMeeting = 506 , ZoomSDKMeetingError_JmakUserEmailNotMatch = 1143 }
	Enumeration of errors to start/join meeting. More...
enum	ZoomSDKLoginStatus { ZoomSDKLoginStatus_Idle = 0 , ZoomSDKLoginStatus_Success = 1 , ZoomSDKLoginStatus_Failed = 2 , ZoomSDKLoginStatus_Processing = 3 }
	Enumeration of ZOOM SDK login status. More...
enum	ZoomSDKMeetingStatus { ZoomSDKMeetingStatus_Idle = 0 , ZoomSDKMeetingStatus_Connecting = 1 , ZoomSDKMeetingStatus_WaitingForHost = 2 , ZoomSDKMeetingStatus_InMeeting = 3 , ZoomSDKMeetingStatus_Disconnecting = 4 , ZoomSDKMeetingStatus_Reconnecting = 5 , ZoomSDKMeetingStatus_Failed = 6 , ZoomSDKMeetingStatus_Ended = 7 , ZoomSDKMeetingStatus_AudioReady = 8 , ZoomSDKMeetingStatus_OtherMeetingInProgress = 9 , ZoomSDKMeetingStatus_InWaitingRoom = 10 , ZoomSDKMeetingStatus_Webinar_Promote = 12 , ZoomSDKMeetingStatus_Webinar_Depromote = 13 , ZoomSDKMeetingStatus_Join_Breakout_Room = 14 , ZoomSDKMeetingStatus_Leave_Breakout_Room = 15 }
	Enumeration of meeting status. More...
enum	ZoomSDKShareStatus { ZoomSDKShareStatus_None , ZoomSDKShareStatus_SelfBegin , ZoomSDKShareStatus_SelfEnd , ZoomSDKShareStatus_OtherBegin , ZoomSDKShareStatus_OtherEnd , ZoomSDKShareStatus_ViewOther , ZoomSDKShareStatus_Pause , ZoomSDKShareStatus_Resume , ZoomSDKShareStatus_ContentTypeChange , ZoomSDKShareStatus_SelfStartAudioShare , ZoomSDKShareStatus_SelfStopAudioShare , ZoomSDKShareStatus_OtherStartAudioShare , ZoomSDKShareStatus_OtherStopAudioShare , ZoomSDKShareStatus_Disconnected }
	Enumeration of sharing status. More...
enum	ZoomSDKAudioStatus { ZoomSDKAudioStatus_None = 0 , ZoomSDKAudioStatus_Muted = 1 , ZoomSDKAudioStatus_UnMuted = 2 , ZoomSDKAudioStatus_MutedByHost = 3 , ZoomSDKAudioStatus_UnMutedByHost = 4 , ZoomSDKAudioStatus_MutedAllByHost = 5 , ZoomSDKAudioStatus_UnMutedAllByHost = 6 }
	Enumeration of Audio status. More...
enum	ZoomSDKVideoStatus { ZoomSDKVideoStatus_Off , ZoomSDKVideoStatus_On , ZoomSDKVideoStatus_MutedByHost , ZoomSDKVideoStatus_None }
	Enumeration of the status of a user's video. More...
enum	ZoomSDKAudioType { ZoomSDKAudioType_None = 0 , ZoomSDKAudioType_Voip = 1 , ZoomSDKAudioType_Phone = 2 , ZoomSDKAudioType_Unknown = 3 }
	Enumeration of the type of a user's audio connection. More...
enum	ZoomSDKRemoteControlStatus { ZoomSDKRemoteControlStatus_None , ZoomSDKRemoteControlStatus_CanRequestFromWho , ZoomSDKRemoteControlStatus_RequestFromWho , ZoomSDKRemoteControlStatus_DeclineByWho , ZoomSDKRemoteControlStatus_RemoteControlledByWho , ZoomSDKRemoteControlStatus_StartRemoteControlWho , ZoomSDKRemoteControlStatus_EndRemoteControlWho , ZoomSDKRemoteControlStatus_HasPrivilegeFromWho , ZoomSDKRemoteControlStatus_LostPrivilegeFromWho , ZoomSDKRemoteControlStatus_WhoCanControlMe }
	Enumeration of status of remote control. More...
enum	ZoomSDKRecordingStatus { ZoomSDKRecordingStatus_None , ZoomSDKRecordingStatus_Start , ZoomSDKRecordingStatus_Stop , ZoomSDKRecordingStatus_DiskFull , ZoomSDKRecordingStatus_Pause , ZoomSDKRecordingStatus_Connecting , ZoomSDKRecordingStatus_Fail }
	Enumeration of Recording status. More...
enum	ZoomSDKConnectionQuality { ZoomSDKConnectionQuality_Unknown , ZoomSDKConnectionQuality_VeryBad , ZoomSDKConnectionQuality_Bad , ZoomSDKConnectionQuality_NotGood , ZoomSDKConnectionQuality_Normal , ZoomSDKConnectionQuality_Good , ZoomSDKConnectionQuality_Excellent }
	Enumeration of connection quality. More...
enum	ZoomSDKVideoQuality { ZoomSDKVideoQuality_Unknown , ZoomSDKVideoQuality_Bad , ZoomSDKVideoQuality_Normal , ZoomSDKVideoQuality_Good }
	Enumeration of video quality. More...
enum	H323CalloutStatus { H323CalloutStatus_Success , H323CalloutStatus_Ring , H323CalloutStatus_Timeout , H323CalloutStatus_Failed , H323CalloutStatus_Unknown , H323CalloutStatus_Busy , H323CalloutStatus_Decline }
	Enumeration of H.323 device outgoing call status. More...
enum	H323PairingResult { H323PairingResult_Unknown , H323PairingResult_Success , H323PairingResult_Meeting_Not_Exist , H323PairingResult_Paringcode_Not_Exist , H323PairingResult_No_Privilege , H323PairingResult_Other_Error }
	Enumeration of H.323 device pairing Status. More...
enum	H323DeviceType { H323DeviceType_Unknown , H323DeviceType_H323 , H323DeviceType_SIP }
	Enumeration of H.323 device types. More...
enum	ScreenType { ScreenType_First , ScreenType_Second }
	Enumeration of screen types for multi-sharing. More...
enum	JoinMeetingReqInfoType { JoinMeetingReqInfoType_None , JoinMeetingReqInfoType_Password , JoinMeetingReqInfoType_Password_Wrong , JoinMeetingReqInfoType_ScreenName }
	Join meeting with required information. More...
enum	MeetingType { MeetingType_None , MeetingType_Normal , MeetingType_BreakoutRoom , MeetingType_Webinar }
	Enumeration of meeting types. More...
enum	UserRole { UserRole_None , UserRole_Host , UserRole_CoHost , UserRole_Attendee , UserRole_Panelist , UserRole_BreakoutRoom_Moderator }
	Enumeration of user roles. More...
enum	PhoneStatus { PhoneStatus_None , PhoneStatus_Calling , PhoneStatus_Ringing , PhoneStatus_Accepted , PhoneStatus_Success , PhoneStatus_Failed , PhoneStatus_Canceling , PhoneStatus_Canceled , PhoneStatus_Cancel_Failed , PhoneStatus_Timeout }
	Enumeration of phone call status. More...
enum	PhoneFailedReason { PhoneFailedReason_None , PhoneFailedReason_Busy , PhoneFailedReason_Not_Available , PhoneFailedReason_User_Hangup , PhoneFailedReason_Other_Fail , PhoneFailedReason_No_Answer , PhoneFailedReason_Block_No_Host , PhoneFailedReason_Block_High_Rate , PhoneFailedReason_Block_Too_Frequent }
	Enumeration of the reasons for the telephone call’s failure. More...
enum	ZoomSDKShareContentType { ZoomSDKShareContentType_UNKNOWN , ZoomSDKShareContentType_AS , ZoomSDKShareContentType_DS , ZoomSDKShareContentType_WB , ZoomSDKShareContentType_AIRHOST , ZoomSDKShareContentType_CAMERA , ZoomSDKShareContentType_DATA , ZoomSDKShareContentType_WIRED_DEVICE , ZoomSDKShareContentType_FRAME , ZoomSDKShareContentType_DOCUMENT , ZoomSDKShareContentType_COMPUTER_AUDIO , ZoomSDKShareContentType_VIDEO_FILE }
	Enumeration of types of shared content. More...
enum	CallInNumberType { CallInNumberType_None , CallInNumberType_Toll , CallInNumberType_TollFree }
	Enumeration of the number types for calling to join the audio into a meeting. More...
enum	SDKButton { AudioButton , VideoButton , ParticipantButton , FitBarNewShareButton , FitBarRemoteControlButton , FitBarPauseShareButton , FitBarAnnotateButton , QAButton , FitBarBroadcastButton , PollingButton , FitBarMoreButton , MainExitFullScreenButton , ClaimHostButton , UpgradeButtonInFreeMeetingRemainTimeTooltip , SwapShareContentAndVideoButton , ChatButton , ToolBarReactionsButton , ToolBarShareButton , RecordButton }
	Enumeration of in-meeting buttons on the toolbar. More...
enum	SecuritySessionComponet { SecuritySessionComponent_Unknown , SecuritySessionComponent_Chat , SecuritySessionComponent_FT , SecuritySessionComponent_Audio , SecuritySessionComponent_Video , SecuritySessionComponent_AS }
	Enumeration of security session types. More...
enum	StatisticWarningType { StatisticWarningType_None , StatisticWarningType_NetworkBad , StatisticWarningType_CPUHigh , StatisticWarningType_SystemBusy }
	Enumeration of warning types. More...
enum	ConnectionComponent { ConnectionComponent_None , ConnectionComponent_Share , ConnectionComponent_Video , ConnectionComponent_Audio }
	Enumeration of component types. More...
enum	EndMeetingReason { EndMeetingReason_None = 0 , EndMeetingReason_KickByHost = 1 , EndMeetingReason_EndByHost = 2 , EndMeetingReason_JBHTimeOut = 3 , EndMeetingReason_NoAttendee = 4 , EndMeetingReason_HostStartAnotherMeeting = 5 , EndMeetingReason_FreeMeetingTimeOut = 6 , EndMeetingReason_Undefined = 7 , EndMeetingReason_DueToAuthorizedUserLeave = 8 }
	Enumeration of ending meeting errors. More...
enum	EncryptType { EncryptType_NO , EncryptType_YES , EncryptType_Auto }
	Enumeration of H.323/SIP encryption types. More...
enum	SettingConnectionType { SettingConnectionType_Unknown , SettingConnectionType_P2P , SettingConnectionType_Cloud }
	Enumeration of connection types. More...
enum	SettingNetworkType { SettingNetworkType_Unknown , SettingNetworkType_Wired , SettingNetworkType_WiFi , SettingNetworkType_PPP , SettingNetworkType_3G , SettingNetworkType_Other }
	Enumeration of network types. More...
enum	VideoRenderElementType { VideoRenderElementType_None , VideoRenderElementType_Preview , VideoRenderElementType_Active , VideoRenderElementType_Normal }
	Enumeration of video render element types. More...
enum	VideoRenderDataType { VideoRenderDataType_None , VideoRenderDataType_Video , VideoRenderDataType_Avatar }
	Enumeration of video render data types. More...
enum	ViewShareMode { ViewShareMode_FullFill , ViewShareMode_LetterBox }
	Enumeration of video aspect modes. More...
enum	AnnotationStatus { AnnotationStatus_Ready , AnnotationStatus_Close , AnnotationStatus_None }
	Enumeration of annotation status. More...
enum	LiveStreamStatus { LiveStreamStatus_None , LiveStreamStatus_InProgress , LiveStreamStatus_Connecting , LiveStreamStatus_StartFailedTimeout , LiveStreamStatus_StartFailed , LiveStreamStatus_Ended }
	Enumeration of live stream status. More...
enum	FreeMeetingNeedUpgradeType { FreeMeetingNeedUpgradeType_NONE , FreeMeetingNeedUpgradeType_BY_ADMIN , FreeMeetingNeedUpgradeType_BY_GIFTURL }
	Enumeration indicating reasons why a free meeting needs an upgrade. More...
enum	DirectShareStatus { DirectShareStatus_None = 0 , DirectShareStatus_Connecting = 1 , DirectShareStatus_InProgress = 2 , DirectShareStatus_Ended = 3 , DirectShareStatus_NeedMeetingIDOrSharingKey = 4 , DirectShareStatus_WrongMeetingIDOrSharingKey = 5 , DirectShareStatus_NetworkError = 6 , DirectShareStatus_NeedInputNewPairingCode , DirectShareStatus_Prepared , DirectShareStatus_Unknown = 100 }
	Enumeration of direct sharing status. More...
enum	WebinarRegisterType { WebinarRegisterType_None , WebinarRegisterType_URL , WebinarRegisterType_Email }
	Enumeration of types to register webinar. More...
enum	ZoomSDKTestMicStatus { testMic_Normal = 0 , testMic_Recording , testMic_RecrodingStopped , testMic_Playing }
	Enumeration of microphone test types. More...
enum	ZoomSDKDeviceStatus { Device_Error_Unknown , New_Device_Found , Device_Error_Found , No_Device , Audio_No_Input , Audio_Error_Be_Muted , Device_List_Update , Audio_Disconnect_As_Detected_Echo }
	Enumeration of device status. More...
enum	ZoomSDKShareSettingType { ShareSettingType_OnlyHostCanGrab = 0 , ShareSettingType_OnlyHostCanShare = 1 , ShareSettingType_AnyoneCanGrab = 2 , ShareSettingType_MultiShare = 3 , ShareSettingType_None = 4 }
	Enumeration of sharing types. More...
enum	shareSettingCmd { shareSettingCmd_enterFullScreen , shareSettingCmd_enterMaxWindow , shareSettingCmd_sideToSideMode , shareSettingCmd_MaintainCurrentSize , shareSettingCmd_AutoFitWindowWhenViewShare }
	Enumeration of General setting about share. More...
enum	AttendeeViewQuestionType { ViewType_OnlyAnswered_Question = 0 , ViewType_All_Question }
	Enumeration of attendee view question type. More...
enum	ZoomSDKQAQuestionState { QAQuestionState_Init = 0 , QAQuestionState_Sent , QAQuestionState_Received , QAQuestionState_SendFail , QAQuestionState_Sending , QAQuestionState_Unknown }
	Enumeration of question status. More...
enum	ZoomSDKQAConnectStatus { QAConnectStatus_Connecting = 0 , QAConnectStatus_Connected , QAConnectStatus_Disconnected , QAConnectStatus_Disconnect_Conflict }
	Enumeration of Q&A connection statuses. More...
enum	ZoomSDKAudioActionInfo { ZoomSDKAudioActionInfo_none = 0 , ZoomSDKAudioActionInfo_needJoinVoip , ZoomSDKAudioActionInfo_muteOrUnmenuAudio , ZoomSDKAudioActionInfo_noAudioDeviceConnected , ZoomSDKAudioActionInfo_computerAudioDeviceError }
	Enumeration of audio button action info. More...
enum	ZoomSDKBOUserStatus { ZoomSDKBOUserStatus_Unknown = 0 , ZoomSDKBOUserStatus_UnAssigned , ZoomSDKBOUserStatus_Assigned_Not_Join , ZoomSDKBOUserStatus_InBreakOutMeeting }
	Enumeration of breakout meeting user status. More...
enum	ZoomSDKFPSValue { ZoomSDKFPSValue_One , ZoomSDKFPSValue_Two , ZoomSDKFPSValue_Four , ZoomSDKFPSValue_Six , ZoomSDKFPSValue_Eight , ZoomSDKFPSValue_Ten , ZoomSDKFPSValue_Fifteen }
	Enumeration of limited FPS (frames per second) values. More...
enum	ZoomSDKRequest4HelpResult { ZoomSDKRequest4HelpResult_Busy , ZoomSDKRequest4HelpResult_Ignore , ZoomSDKRequest4HelpResult_HostAlreadyInBO , ZoomSDKRequest4HelpResult_Idle }
	Enumeration of attendee request for help results. More...
enum	ZoomSDKRawDataMemoryMode { ZoomSDKRawDataMemoryMode_Stack , ZoomSDKRawDataMemoryMode_Heap }
	Enumeration of memory modes for raw data handling. More...
enum	ZoomSDKResolution { ZoomSDKResolution_90P , ZoomSDKResolution_180P , ZoomSDKResolution_360P , ZoomSDKResolution_720P , ZoomSDKResolution_1080P , ZoomSDKResolution_NoUse = 100 }
	Enumeration of video resolution options. More...
enum	ZoomSDKLocalVideoDeviceRotation { ZoomSDKLOCAL_DEVICE_ROTATION_ACTION_UNKnown , ZoomSDKLOCAL_DEVICE_ROTATION_ACTION_0 , ZoomSDKLOCAL_DEVICE_ROTATION_ACTION_CLOCK90 , ZoomSDKLOCAL_DEVICE_ROTATION_ACTION_CLOCK180 , ZoomSDKLOCAL_DEVICE_ROTATION_ACTION_ANTI_CLOCK90 }
	Enumeration of local video device rotation actions. More...
enum	ZoomSDKRawDataType { ZoomSDKRawDataType_Video = 1 , ZoomSDKRawDataType_Share }
	Enumeration of raw data types. More...
enum	ZoomSDKAnnotationSavedType { ZoomSDKAnnotationSavedType_PNG , ZoomSDKAnnotationSavedType_PDF }
	Enumeration of file types for saving screenshots. More...
enum	ZoomSDKChatPrivilegeType { ZoomSDKChatPrivilegeType_To_Everyone , ZoomSDKChatPrivilegeType_To_All_Panelist , ZoomSDKChatPrivilegeType_To_Host , ZoomSDKChatPrivilegeType_Disable_Attendee_Chat , ZoomSDKChatPrivilegeType_Host_Public }
	Enumeration of the privilege for attendee chat. More...
enum	ZoomSDKPanelistChatPrivilege { ZoomSDKPanelistChatPrivilege_PanelistOnly , ZoomSDKPanelistChatPrivilege_All }
	Enumeration of the panelist chat privilege in webinar meeting. More...
enum	ZoomSDKChatMessageType { ZoomSDKChatMessageType_To_None , ZoomSDKChatMessageType_To_All , ZoomSDKChatMessageType_To_All_Panelist , ZoomSDKChatMessageType_To_Individual_Panelist , ZoomSDKChatMessageType_To_Individual , ZoomSDKChatMessageType_To_WaitingRoomUsers }
	Enumeration of the type for chat message. More...
enum	ZoomSDKSuppressBackgroundNoiseLevel { ZoomSDKSuppressBackgroundNoiseLevel_None , ZoomSDKSuppressBackgroundNoiseLevel_Auto , ZoomSDKSuppressBackgroundNoiseLevel_Low , ZoomSDKSuppressBackgroundNoiseLevel_Medium , ZoomSDKSuppressBackgroundNoiseLevel_High }
	Enumeration of background noise suppression levels. For more information, please visit https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0059985. More...
enum	ZoomSDKScreenCaptureMode { ZoomSDKScreenCaptureMode_Auto , ZoomSDKScreenCaptureMode_Legacy , ZoomSDKScreenCaptureMode_GPU_Copy_Filter , ZoomSDKScreenCaptureMode_ADA_Copy_Filter , ZoomSDKScreenCaptureMode_ADA_Copy_Without_Filter }
	Enumeration of the mode for screen capture. For more information, please visit https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0063824. More...
enum	ZoomSDKSettingVideoLightAdaptionModel { ZoomSDKSettingVideoLightAdaptionModel_None , ZoomSDKSettingVideoLightAdaptionModel_Auto , ZoomSDKSettingVideoLightAdaptionModel_Manual }
	Enumeration of video light adjustment modes. For more information, please visit https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0060612. More...
enum	ZoomSDKSettingVBVideoError { ZoomSDKSettingVBVideoError_None = 0 , ZoomSDKSettingVBVideoError_UnknownFormat , ZoomSDKSettingVBVideoError_ResolutionBig , ZoomSDKSettingVBVideoError_ResolutionHigh720P , ZoomSDKSettingVBVideoError_ResolutionLow , ZoomSDKSettingVBVideoError_PlayError , ZoomSDKSettingVBVideoError_OpenError }
	Enumeration of virtual background video errors. More...
enum	ZoomSDKVideoEffectType { ZoomSDKVideoEffectType_None = 0 , ZoomSDKVideoEffectType_Filter = 1 , ZoomSDKVideoEffectType_Frame = 2 , ZoomSDKVideoEffectType_CustomFilter = 3 , ZoomSDKVideoEffectType_Sticker = 4 }
	Enumeration of video effect types. More...
enum	ZoomSDKUIAppearance { ZoomSDKUIAppearance_System , ZoomSDKUIAppearance_Light , ZoomSDKUIAppearance_Dark }
	Enumeration of UI appearance modes. More...
enum	ZoomSDKUITheme { ZoomSDKUITheme_Bloom , ZoomSDKUITheme_Rose , ZoomSDKUITheme_Agave , ZoomSDKUITheme_Classic }
	Enumeration of available UI themes. More...
enum	ZoomSDKEmojiReactionType { ZoomSDKEmojiReactionType_Unknown = 0 , ZoomSDKEmojiReactionType_Clap , ZoomSDKEmojiReactionType_Thumbsup , ZoomSDKEmojiReactionType_Heart , ZoomSDKEmojiReactionType_Joy , ZoomSDKEmojiReactionType_Openmouth , ZoomSDKEmojiReactionType_Tada }
	Enumeration of available emoji reaction types. For more information, please visit https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0060612. More...
enum	ZoomSDKEmojiReactionSkinTone { ZoomSDKEmojiReactionSkinTone_Unknown = 0 , ZoomSDKEmojiReactionSkinTone_Default , ZoomSDKEmojiReactionSkinTone_Light , ZoomSDKEmojiReactionSkinTone_MediumLight , ZoomSDKEmojiReactionSkinTone_Medium , ZoomSDKEmojiReactionSkinTone_MediumDark , ZoomSDKEmojiReactionSkinTone_Dark }
	Enumeration of available emoji reaction skin tones. More...
enum	ZoomSDKAudioEchoCancellationLevel { ZoomSDKAudioEchoCancellationLevel_Auto = 0 , ZoomSDKAudioEchoCancellationLevel_Low , ZoomSDKAudioEchoCancellationLevel_High }
	Enumeration of echo cancellation. For more information, please visit https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0066398. More...
enum	ZoomSDKSettingShareScreenShareOption { ZoomSDKSettingShareScreenShareOption_IndividualWindow , ZoomSDKSettingShareScreenShareOption_AllWindowFromApplication , ZoomSDKSettingShareScreenShareOption_AutoShareDesktop , ZoomSDKSettingShareScreenShareOption_AllOption }
	Enumeration of screen sharing options when setting the page share screen item. For more information, please visit https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0060612. More...
enum	ZoomSDKSpotlightResult { ZoomSDKSpotlightResult_Success = 0 , ZoomSDKSpotlightResult_Fail_NotEnoughUsers , ZoomSDKSpotlightResult_Fail_ToMuchSpotlightedUsers , ZoomSDKSpotlightResult_Fail_UserCannotBeSpotlighted , ZoomSDKSpotlightResult_Fail_UserWithoutVideo , ZoomSDKSpotlightResult_Fail_NoPrivilegeToSpotlight , ZoomSDKSpotlightResult_Fail_UserNotSpotlighted , ZoomSDKSpotlightResult_Unknown = 100 }
	Enumeration of the spotlight operation result. More...
enum	ZoomSDKPinResult { ZoomSDKPinResult_Success = 0 , ZoomSDKPinResult_Fail_NotEnoughUsers , ZoomSDKPinResult_Fail_ToMuchPinnedUsers , ZoomSDKPinResult_Fail_UserCannotBePinned , ZoomSDKPinResult_Fail_VideoModeDoNotSupport , ZoomSDKPinResult_Fail_NoPrivilegeToPin , ZoomSDKPinResult_Fail_MeetingDoNotSupport , ZoomSDKPinResult_Fail_TooManyUsers , ZoomSDKPinResult_Unknown = 100 }
	Enumeration of the result of a pin operation. More...
enum	ZoomSDKLoginFailReason { ZoomSDKLoginFailReason_None = 0 , ZoomSDKLoginFailReason_EmailLoginDisabled , ZoomSDKLoginFailReason_UserNotExist , ZoomSDKLoginFailReason_WrongPassword , ZoomSDKLoginFailReason_AccountLocked , ZoomSDKLoginFailReason_SDKNeedUpdate , ZoomSDKLoginFailReason_TooManyFailedAttempts , ZoomSDKLoginFailReason_SMSCodeError , ZoomSDKLoginFailReason_SMSCodeExpired , ZoomSDKLoginFailReason_PhoneNumberFormatInValid , ZoomSDKLoginFailReason_LoginTokenInvalid , ZoomSDKLoginFailReason_UserDisagreeLoginDisclaimer , ZoomSDKLoginFailReason_MFARequired , ZoomSDKLoginFailReason_NeedBirthdayAsk , ZoomSDKLoginFailReason_Other_Issue = 100 }
	Enumeration of the login failure reasons. More...
enum	ZoomSDKSettingPageURL { ZoomSDKSettingPageURL_General_ViewMoreSetting , ZoomSDKSettingPageURL_Audio_LearnMore , ZoomSDKSettingPageURL_VB_LearnMore , ZoomSDKSettingPageURL_ShareScreen_LearnMore }
	Enumeration of setting page URLs. More...
enum	ZoomSDKBOControllerError { ZoomSDKBOControllerError_Null_Pointer = 0 , ZoomSDKBOControllerError_Wrong_Current_Status , ZoomSDKBOControllerError_Token_Not_Ready , ZoomSDKBOControllerError_No_Privilege , ZoomSDKBOControllerError_BO_List_Is_Uploading , ZoomSDKBOControllerError_Upload_Fail , ZoomSDKBOControllerError_No_One_Has_Been_Assigned , ZoomSDKBOControllerError_Unknown = 100 }
	Enumeration of the errors related to the Breakout Room (BO) controller operations. More...
enum	ZoomSDKVideoRenderResolution { ZoomSDKVideoRenderResolution_None = 0 , ZoomSDKVideoRenderResolution_90p , ZoomSDKVideoRenderResolution_180p , ZoomSDKVideoRenderResolution_360p , ZoomSDKVideoRenderResolution_720p , ZoomSDKVideoRenderResolution_1080p }
	Enumeration of video render resolution. More...
enum	ZoomSDKBOStopCountDown { ZoomSDKBOStopCountDown_Not = 0 , ZoomSDKBOStopCountDown_Seconds_10 , ZoomSDKBOStopCountDown_Seconds_15 , ZoomSDKBOStopCountDown_Seconds_30 , ZoomSDKBOStopCountDown_Seconds_60 , ZoomSDKBOStopCountDown_Seconds_120 }
	Enumeration of Breakout Room (BO) stop countdown durations. More...
enum	ZoomSDKBOStatus { ZoomSDKBOStatus_Invalid = 0 , ZoomSDKBOStatus_Edit = 1 , ZoomSDKBOStatus_Started = 2 , ZoomSDKBOStatus_Stopping = 3 , ZoomSDKBOStatus_Ended = 4 }
	Enumeration of Breakout Room (BO) status. More...
enum	ZoomSDKVideoSubscribeFailReason { ZoomSDKVideoSubscribe_Fail_None = 0 , ZoomSDKVideoSubscribe_Fail_ViewOnly , ZoomSDKVideoSubscribe_Fail_NotInMeeting , ZoomSDKVideoSubscribe_Fail_HasSubscribe1080POr720P , ZoomSDKVideoSubscribe_Fail_HasSubscribe720P , ZoomSDKVideoSubscribe_Fail_HasSubscribeTwo720P , ZoomSDKVideoSubscribe_Fail_HasSubscribeExceededLimit , ZoomSDKVideoSubscribe_Fail_TooFrequentCall }
	Enumeration of the type for video subscribe failed reason. More...
enum	ZoomSDKLiveTranscriptionStaus { ZoomSDK_LiveTranscription_Status_Stop = 0 , ZoomSDK_LiveTranscription_Status_Start = 1 , ZoomSDK_LiveTranscription_Status_User_Sub = 2 , ZoomSDK_LiveTranscription_Status_Connecting = 10 }
	Enumeration of live transcription status in a meeting. More...
enum	ZoomSDKLiveTranscriptionOperationType { ZoomSDK_LiveTranscription_OperationType_None = 0 , ZoomSDK_LiveTranscription_OperationType_Add , ZoomSDK_LiveTranscription_OperationType_Update , ZoomSDK_LiveTranscription_OperationType_Delete , ZoomSDK_LiveTranscription_OperationType_Complete , ZoomSDK_LiveTranscription_OperationType_NotSupported }
	Enumeration of live transcription operation types. More...
enum	ZoomSDKShareViewZoomRatio { ZoomSDKShareViewZoomRatio_50 = 0 , ZoomSDKShareViewZoomRatio_100 , ZoomSDKShareViewZoomRatio_150 , ZoomSDKShareViewZoomRatio_200 , ZoomSDKShareViewZoomRatio_300 }
	Enumeration of zoom ratios of the shared content view. More...
enum	ZoomSDKChatMessageDeleteType { ZoomSDK_Chat_Delete_By_None , ZoomSDK_Chat_Delete_By_Self , ZoomSDK_Chat_Delete_By_Host , ZoomSDK_Chat_Delete_By_Dlp }
	Enumeration of the chat message delete type. More...
enum	ZoomSDKAudioShareMode { ZoomSDKAudioShareMode_Mono , ZoomSDKAudioShareMode_Stereo }
	Enumeration of the audio share modes. More...
enum	ZoomSDKWaitingRoomLayoutType { ZoomSDKWaitingRoomLayoutType_Default , ZoomSDKWaitingRoomLayoutType_Logo , ZoomSDKWaitingRoomLayoutType_Video }
	Enumeration of waiting room layout type. For more information, please visit https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0059359. More...
enum	ZoomSDKCustomWaitingRoomDataStatus { ZoomSDKCustomWaitingRoomDataStatus_Init , ZoomSDKCustomWaitingRoomDataStatus_Downloading , ZoomSDKCustomWaitingRoomDataStatus_Download_OK , ZoomSDKCustomWaitingRoomDataStatus_Download_Failed }
	Enumeration of the status of custom waiting room data. More...
enum	ZoomSDKSignInterpretationStatus { ZoomSDKSignInterpretationStatus_Initial , ZoomSDKSignInterpretationStatus_Started , ZoomSDKSignInterpretationStatus_Stopped }
	Enumeration of the status of sign language interpretation. More...
enum	ZoomSDKNotificationServiceStatus { ZoomSDKNotificationServiceStatus_None = 0 , ZoomSDKNotificationServiceStatus_Starting , ZoomSDKNotificationServiceStatus_Started , ZoomSDKNotificationServiceStatus_StartFailed , ZoomSDKNotificationServiceStatus_Closed }
	Enumeration of the status of the notification service. More...
enum	ZoomSDKNotificationServiceError { ZoomSDKNotificationServiceError_Success = 0 , ZoomSDKNotificationServiceError_Unknown , ZoomSDKNotificationServiceError_Internal_Error , ZoomSDKNotificationServiceError_Invalid_Token , ZoomSDKNotificationServiceError_Multi_Connect , ZoomSDKNotificationServiceError_Network_Issue , ZoomSDKNotificationServiceError_Max_Duration }
	Enumeration of notification service error codes. More...
enum	ZoomSDKFaceMakeupType { ZoomSDKFaceMakeupType_None , ZoomSDKFaceMakeupType_Mustache , ZoomSDKFaceMakeupType_Eyebrow , ZoomSDKFaceMakeupType_Lip }
	Enumeration of the types of face makeup effects. More...
enum	ZoomSDKRequestLocalRecordingStatus { ZoomSDKRequestLocalRecordingStatus_Granted , ZoomSDKRequestLocalRecordingStatus_Denied , ZoomSDKRequestLocalRecordingStatus_Timeout }
	Enumeration of the status of a local recording permission request. More...
enum	ZoomSDKAttendeeViewMode { ZoomSDKAttendeeViewMode_None , ZoomSDKAttendeeViewMode_FollowHost , ZoomSDKAttendeeViewMode_Speaker , ZoomSDKAttendeeViewMode_Gallery , ZoomSDKAttendeeViewMode_Sharing_Standard , ZoomSDKAttendeeViewMode_Sharing_SidebysideSpeaker , ZoomSDKAttendeeViewMode_Sharing_SidebysideGallery }
	Enumeration of attendee view modes in a Zoom meeting. For more information, please visit https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0063672. More...
enum	ZoomSDKEmojiReactionDisplayType { ZoomSDKEmojiReactionDisplayType_None , ZoomSDKEmojiReactionDisplayType_Full , ZoomSDKEmojiReactionDisplayType_Medium , ZoomSDKEmojiReactionDisplayType_Hidden }
	Enumeration of emoji reaction display types in the meeting UI. More...
enum	ZoomSDKMeetingSupportAudioType { ZoomSDKMeetingSupportAudioType_None = 0 , ZoomSDKMeetingSupportAudioType_Voip = 1 , ZoomSDKMeetingSupportAudioType_Telephony = 1 << 1 }
	Enumeration of supported audio types in a Zoom meeting. This is a bitmask enumeration; multiple values can be combined using bitwise OR. More...
enum	ZoomSDKLocalRecordingRequestPrivilegeStatus { ZoomSDKLocalRecordingRequestPrivilege_None = 0 , ZoomSDKLocalRecordingRequestPrivilege_AllowRequest , ZoomSDKLocalRecordingRequestPrivilege_AutoGrant , ZoomSDKLocalRecordingRequestPrivilege_AutoDeny }
	Enumeration of local recording request privilege settings. More...
enum	ZoomSDKFrameDataFormat { ZoomSDKFrameDataFormat_I420_Limited , ZoomSDKFrameDataFormat_I420_Full }
	Enumeration of video frame data format. More...
enum	ZoomSDKPresenceStatus { ZoomSDKPresenceStatus_None , ZoomSDKPresenceStatus_Available , ZoomSDKPresenceStatus_UnAvailable , ZoomSDKPresenceStatus_InMeeting , ZoomSDKPresenceStatus_Busy , ZoomSDKPresenceStatus_DoNotDisturb , ZoomSDKPresenceStatus_Away , ZoomSDKPresenceStatus_PhoneCall , ZoomSDKPresenceStatus_Presenting , ZoomSDKPresenceStatus_Calendar , ZoomSDKPresenceStatus_OutOfOffice }
	Enumeration of user's presence status. For more information, please visit https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0065488. More...
enum	ZoomSDKReminderType { ZoomSDKReminderType_LoginRequired = 0 , ZoomSDKReminderType_StartOrJoinMeeting , ZoomSDKReminderType_RecordReminder , ZoomSDKReminderType_RecordDisclaimer , ZoomSDKReminderType_LiveStreamDisclaimer , ZoomSDKReminderType_ArchiveDisclaimer , ZoomSDKReminderType_WebinarAsPanelistJoin , ZoomSDKReminderType_TermsService , ZoomSDKReminderType_SmartSummaryDisclaimer , ZoomSDKReminderType_SmartSummaryEnableRequestReminder , ZoomSDKReminderType_QueryDisclaimer , ZoomSDKReminderType_QueryEnableRequestReminder , ZoomSDKReminderType_EnableSmartSummaryReminder , ZoomSDKReminderType_WebinarAttendeePromoteReminder , ZoomSDKReminderType_JoinMeetingPrivateModeReminder , ZoomSDKReminderType_SmartRecordingEnableRequestReminder , ZoomSDKReminderType_EnableSmartRecordingReminder , ZoomSDKReminderType_AICompanionPlusDisclaimer , ZoomSDKReminderType_ClosedCaptionDisclamier , ZoomSDKReminderType_MultiDisclamier , ZoomSDKReminderType_JoinMeetingConnectorAsGuestReminder , ZoomSDKReminderType_CommonDisclaimer , ZoomSDKReminderType_CustomAICompanionDisclamier , ZoomSDKReminderType_AICRestrictNotifyDisclamier }
	Enumeration of reminder types. More...
enum	ZoomSDKPreAssignBODataStatus { ZoomSDKPreAssignBODataStatus_None , ZoomSDKPreAssignBODataStatus_Downloading , ZoomSDKPreAssignBODataStatus_Download_Ok , ZoomSDKPreAssignBODataStatus_Download_Fail }
	Enumeration of the pre-assign breakout room data download status. More...
enum	ZoomSDKAutoFramingMode { ZoomSDKAutoFramingMode_None , ZoomSDKAutoFramingMode_Center_Coordinates , ZoomSDKAutoFramingMode_Face_Recognition }
	Enumeration of auto framing modes in video. More...
enum	ZoomSDKFaceRecognitionFailStrategy { ZoomSDKFaceRecognitionFailStrategy_None , ZoomSDKFaceRecognitionFailStrategy_Remain , ZoomSDKFaceRecognitionFailStrategy_Using_Center_Coordinates , ZoomSDKFaceRecognitionFailStrategy_Using_Original_Video }
	Enumeration of face recognition failure strategies. More...
enum	ZoomSDKEmojiFeedbackType { ZoomSDKEmojiFeedbackType_None , ZoomSDKEmojiFeedbackType_Yes , ZoomSDKEmojiFeedbackType_No , ZoomSDKEmojiFeedbackType_SpeedUp , ZoomSDKEmojiFeedbackType_SlowDown , ZoomSDKEmojiFeedbackType_Away }
	Enumeration of emoji feedback types. More...
enum	ZoomSDKVideoFileSharePlayError { ZoomSDKVideoFileSharePlayError_None , ZoomSDKVideoFileSharePlayError_Not_Supported , ZoomSDKVideoFileSharePlayError_Resolution_Too_High , ZoomSDKVideoFileSharePlayError_Open_Fail , ZoomSDKVideoFileSharePlayError_Play_Fail , ZoomSDKVideoFileSharePlayError_Seek_Fail }
	Enumeration of video file share play errors. More...
enum	ZoomSDKAudioChannel { ZoomSDKAudioChannel_Mono , ZoomSDKAudioChannel_Stereo }
	Enumeration of audio channel types. More...
enum	ZoomSDKRichTextStyle { ZoomSDKRichTextStyle_None , ZoomSDKRichTextStyle_Bold , ZoomSDKRichTextStyle_Italic , ZoomSDKRichTextStyle_Strikethrough , ZoomSDKRichTextStyle_BulletedList , ZoomSDKRichTextStyle_NumberedList , ZoomSDKRichTextStyle_Underline , ZoomSDKRichTextStyle_FontSize , ZoomSDKRichTextStyle_FontColor , ZoomSDKRichTextStyle_BackgroundColor , ZoomSDKRichTextStyle_Indent , ZoomSDKRichTextStyle_Paragraph , ZoomSDKRichTextStyle_Quote , ZoomSDKRichTextStyle_InsertLink }
	Enumeration of the content font style type for chat message. For more information, please visit https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0064400. More...
enum	ZoomSDKWhiteboardShareOption { ZoomSDKWhiteboardShareOption_HostShare , ZoomSDKWhiteboardShareOption_HostGrabShare , ZoomSDKWhiteboardShareOption_AllGrabShare }
	Enumeration of the whiteboard share options. More...
enum	ZoomSDKWhiteboardCreateOption { ZoomSDKWhiteboardCreateOption_HostOnly , ZoomSDKWhiteboardCreateOption_AccountUsers , ZoomSDKWhiteboardCreateOption_All }
	Enumeration of the whiteboard create options. More...
enum	ZoomSDKWhiteboardStatus { ZoomSDKWhiteboardStatus_Started , ZoomSDKWhiteboardStatus_Stopped }
	Enumeration of the whiteboard status. More...
enum	ZoomSDKReminderActionType { ZoomSDKReminderActionType_None , ZoomSDKReminderActionType_NeedSignin , ZoomSDKReminderActionType_NeedSwitchAccount }
	Enumeration of the reminder action type. More...
enum	ZoomSDKFocusModeShareType { ZoomSDKFocusModeShareType_None , ZoomSDKFocusModeShareType_HostOnly , ZoomSDKFocusModeShareType_AllParticipants }
	Enumeration of the focus mode share type. For more information, please visit https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0063004. More...
enum	ZoomSDKRemoteSupportType { ZoomSDKRemoteSupportType_None , ZoomSDKRemoteSupportType_Desktop , ZoomSDKRemoteSupportType_Application }
	Enumeration of the remote support type. For more information, please visit https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0068720. More...
enum	ZoomSDKRemoteSupportStatus { ZoomSDKRemoteSupportStatus_RequestDeny , ZoomSDKRemoteSupportStatus_RequestGrant , ZoomSDKRemoteSupportStatus_StopBySupportedUser , ZoomSDKRemoteSupportStatus_StopBySupporter }
	Enumeration of the remote support status. More...
enum	ZoomSDKRequestStartCloudRecordingStatus { ZoomSDKRequestStartCloudRecordingStatus_Granted , ZoomSDKRequestStartCloudRecordingStatus_Denied , ZoomSDKRequestStartCloudRecordingStatus_TimedOut }
	Enumeration of the response status when a participant requests the host to start cloud recording. More...
enum	ZoomSDKMeetingFeatureEnableOption { ZoomSDKMeetingFeatureEnableOption_None , ZoomSDKMeetingFeatureEnableOption_Once , ZoomSDKMeetingFeatureEnableOption_Always }
	Enumeration of options to enable a specific meeting feature. More...
enum	ZoomSDKCannotShareReasonType { ZoomSDKCannotShareReasonType_None , ZoomSDKCannotShareReasonType_Locked , ZoomSDKCannotShareReasonType_Disabled , ZoomSDKCannotShareReasonType_Other_Screen_Sharing , ZoomSDKCannotShareReasonType_Other_WB_Sharing , ZoomSDKCannotShareReasonType_Need_Grab_Myself_Screen_Sharing , ZoomSDKCannotShareReasonType_Need_Grab_Other_Screen_Sharing , ZoomSDKCannotShareReasonType_Need_Grab_Audio_Sharing , ZoomSDKCannotShareReasonType_Need_Grap_WB_Sharing , ZoomSDKCannotShareReasonType_Reach_Maximum , ZoomSDKCannotShareReasonType_Have_Share_From_Mainsession , ZoomSDKCannotShareReasonType_Other_Docs_Sharing , ZoomSDKCannotShareReasonType_Need_Grab_Docs_Sharing , ZoomSDKCannotShareReasonType_UnKnown }
	Enumeration of reasons why sharing is not allowed. More...
enum	ZoomSDKAICompanionFeature { ZoomSDKAICompanionFeature_SmartSummary , ZoomSDKAICompanionFeature_Query , ZoomSDKAICompanionFeature_SmartRecording }
	Enumeration of AI Companion features in a meeting. More...
enum	ZoomSDKCameraControlRequestType { ZoomSDKCameraControlRequestType_RequestControl , ZoomSDKCameraControlRequestType_GiveUpControl }
	Enumeration of camera control requests types. More...
enum	ZoomSDKCameraControlRequestResult { ZoomSDKCameraControlRequestResult_Approve , ZoomSDKCameraControlRequestResult_Decline , ZoomSDKCameraControlRequestResult_Revoke }
	Enumeration of the results of a camera control request. More...
enum	ZoomSDKFileTransferStatus { ZoomSDKFileTransferStatus_None = 0 , ZoomSDKFileTransferStatus_ReadyToTransfer , ZoomSDKFileTransferStatus_Transfering , ZoomSDKFileTransferStatus_TransferFailed , ZoomSDKFileTransferStatus_TransferDone }
	Enumeration of the status of a file transfer. More...
enum	ZoomSDKAudioRawdataSamplingRate { ZoomSDKAudioRawdataSamplingRate_32K , ZoomSDKAudioRawdataSamplingRate_48K }
	Enumeration representing the sampling rate of acquired raw audio data. More...
enum	ZoomSDKWallpaperLayoutMode { ZoomSDKWallpaperLayoutMode_None , ZoomSDKWallpaperLayoutMode_Fill , ZoomSDKWallpaperLayoutMode_Fit }
	Enumeration of wallpaper layout modes. More...
enum	ZoomSDKWallpaperSettingStatus { ZoomSDKWallpaperSettingStatus_None , ZoomSDKWallpaperSettingStatus_Downloading , ZoomSDKWallpaperSettingStatus_Downloaded , ZoomSDKWallpaperSettingStatus_DownloadFail }
	Enumeration of the wallpaper setting status. More...
enum	ZoomSDKVideoPreferenceMode { ZoomSDKVideoPreferenceMode_Balance , ZoomSDKVideoPreferenceMode_Sharpness , ZoomSDKVideoPreferenceMode_Smoothness , ZoomSDKVideoPreferenceMode_Custom }
	Enumeration of video preference modes. More...
enum	ZoomSDKTransferMeetingMode { ZoomSDKTransferMeetingMode_None , ZoomSDKTransferMeetingMode_Transfer , ZoomSDKTransferMeetingMode_Companion }
	Enumeration of meeting transfer modes. More...
enum	SettingComponent { SettingComponent_AdvancedFeatureButton , SettingComponent_AdvancedFeatureTab , SettingComponent_GeneralFeatureTab , SettingComponent_VideoFeatureTab , SettingComponent_AudioFeatureTab , SettingComponent_VirtualBackgroundFeatureTab , SettingComponent_RecordingFeatureTab , SettingComponent_StatisticsFeatureTab , SettingComponent_FeedbackFeatureTab , SettingComponent_AccessibilityFeatureTab , SettingComponent_ScreenShareFeatureTab , SettingComponent_ShortCutFeatureTab , SettingComponent_VideoAndVirtualBackgroundFeatureTab }
	Enumerate of the various components in the settings UI. More...
enum	ZoomSDKDocsStatus { ZoomSDKDocsStatus_None , ZoomSDKDocsStatus_Start , ZoomSDKDocsStatus_Stop }
	Enumeration of document sharing status in a meeting. More...
enum	ZoomSDKDocsShareOption { ZoomSDKDocsShareOption_None , ZoomSDKDocsShareOption_HostCoHostShare , ZoomSDKDocsShareOption_HostCoHostGrabShare , ZoomSDKDocsShareOption_AllGrabShare }
	Enumeration of document sharing permission options. More...
enum	ZoomSDKDocsCreateOption { ZoomSDKDocsCreateOption_None , ZoomSDKDocsCreateOption_HostOnly , ZoomSDKDocsCreateOption_AccountUsers , ZoomSDKDocsCreateOption_All }
	Enumeration of document creation permission options. More...
enum	ZoomSDKGrantCoOwnerAssetsType { ZoomSDKGrantCoOwnerAssetsType_None , ZoomSDKGrantCoOwnerAssetsType_Summary , ZoomSDKGrantCoOwnerAssetsType_CloudRecording }
	Enumeration of asset type. More...
enum	ZoomSDKVideoRawdataColorspace { ZoomSDKVideoRawdataColorspace_BT601_L , ZoomSDKVideoRawdataColorspace_BT601_F , ZoomSDKVideoRawdataColorspace_BT709_L , ZoomSDKVideoRawdataColorspace_BT709_F }
	The colorspace of video rawdata. More...
enum	ZoomSDKCustom3DAvatarElementImageType { ZoomSDKCustom3DAvatarElementImageType_None = 0 , ZoomSDKCustom3DAvatarElementImageType_Skin , ZoomSDKCustom3DAvatarElementImageType_Face , ZoomSDKCustom3DAvatarElementImageType_Hair , ZoomSDKCustom3DAvatarElementImageType_Eyes , ZoomSDKCustom3DAvatarElementImageType_EyeColor , ZoomSDKCustom3DAvatarElementImageType_Eyelashes , ZoomSDKCustom3DAvatarElementImageType_Eyebrows , ZoomSDKCustom3DAvatarElementImageType_Nose , ZoomSDKCustom3DAvatarElementImageType_Mouth , ZoomSDKCustom3DAvatarElementImageType_LipColor , ZoomSDKCustom3DAvatarElementImageType_Age , ZoomSDKCustom3DAvatarElementImageType_FacialHair , ZoomSDKCustom3DAvatarElementImageType_Body , ZoomSDKCustom3DAvatarElementImageType_Clothing , ZoomSDKCustom3DAvatarElementImageType_HeadCovering , ZoomSDKCustom3DAvatarElementImageType_Glasses }
	Enumeration of custom 3D avatar element image types. More...
enum	ZoomSDKCustom3DAvatarElementColorType { ZoomSDKCustom3DAvatarElementColorType_None = 0 , ZoomSDKCustom3DAvatarElementColorType_Eyebrow , ZoomSDKCustom3DAvatarElementColorType_Mustache , ZoomSDKCustom3DAvatarElementColorType_Hair , ZoomSDKCustom3DAvatarElementColorType_Eyelash }
	Enumeration of custom 3D avatar element color types. More...

Detailed Description

Definitions of error codes, enumerations, and constants used throughout the Zoom SDK.

This header file defines all error codes, status enumerations, user types, meeting states, and other constants that are used across the Zoom SDK for macOS.

Definition in file ZoomSDKErrors.h.

Enumeration Type Documentation

◆ ActionMeetingCmd

enum ActionMeetingCmd

Enumeration of all the commands in the meeting.

Enumerator
ActionMeetingCmd_MuteVideo	Mute the video.
ActionMeetingCmd_UnMuteVideo	Unmute the video.
ActionMeetingCmd_MuteAudio	Mute the audio.
ActionMeetingCmd_UnMuteAudio	Unmute the audio.
ActionMeetingCmd_EnableUnmuteBySelf	Enable the feature that user can unmute himself when muted.
ActionMeetingCmd_DisableUnmuteBySelf	Disable the feature that user can not unmute himself when muted.
ActionMeetingCmd_MuteAll	Mute all participants in the meeting, available only for the host/co-host.
ActionMeetingCmd_UnmuteAll	Unmute all participants in the meeting, available only for the host/co-host.
ActionMeetingCmd_LockMeeting	Lock the meeting, available only for the host/co-host. Once locked, the new participants can no longer join the meeting/co-host.
ActionMeetingCmd_UnLockMeeting	Unlock the meeting, available only for the host/co-host.
ActionMeetingCmd_ShareFitWindowMode	Adjust the display size fit to the window.
ActionMeetingCmd_PauseShare	Pause sharing.
ActionMeetingCmd_ResumeShare	Resume sharing.
ActionMeetingCmd_JoinVoip	Join meeting by VoIP.
ActionMeetingCmd_LeaveVoip	Disconnect VoIP from meeting.

Definition at line 55 of file ZoomSDKErrors.h.

            {
    ActionMeetingCmd_MuteVideo,
    ActionMeetingCmd_UnMuteVideo,
    ActionMeetingCmd_MuteAudio,
    ActionMeetingCmd_UnMuteAudio,
    ActionMeetingCmd_EnableUnmuteBySelf,
    ActionMeetingCmd_DisableUnmuteBySelf, 
    ActionMeetingCmd_MuteAll, 
    ActionMeetingCmd_UnmuteAll,
    ActionMeetingCmd_LockMeeting, 
    ActionMeetingCmd_UnLockMeeting,
    ActionMeetingCmd_ShareFitWindowMode,
    ActionMeetingCmd_PauseShare,
    ActionMeetingCmd_ResumeShare,
    ActionMeetingCmd_JoinVoip,
    ActionMeetingCmd_LeaveVoip
}ActionMeetingCmd;

◆ AnnotationClearType

enum AnnotationClearType

Types of clearing annotations.

Enumerator
AnnotationClearType_All	Clear all annotations. Hosts, cohost and shared meeting owners can use.
AnnotationClearType_Self	Clear only your own annotations. Everyone can use.
AnnotationClearType_Other	Clear only the others' annotations. Only shared meeting owners can use.

Definition at line 169 of file ZoomSDKErrors.h.

            {
    AnnotationClearType_All,
    AnnotationClearType_Self,
    AnnotationClearType_Other
}AnnotationClearType;

◆ AnnotationStatus

enum AnnotationStatus

Enumeration of annotation status.

Enumerator
AnnotationStatus_Ready	Ready to annotate.
AnnotationStatus_Close	Annotation is closed.
AnnotationStatus_None	For initialization.

Definition at line 1055 of file ZoomSDKErrors.h.

            {
    AnnotationStatus_Ready,
    AnnotationStatus_Close,
    AnnotationStatus_None
}AnnotationStatus;

◆ AnnotationToolType

enum AnnotationToolType

Type of annotation tools. For more information, please visit https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0067931.

Enumerator
AnnotationToolType_None	Switch to mouse cursor. For initialization.
AnnotationToolType_Pen	Pen.
AnnotationToolType_HighLighter	Highlighter.
AnnotationToolType_AutoLine	A straight line changes automatically in pace with the mouse cursor.
AnnotationToolType_AutoRectangle	A rectangle changes automatically in pace with the mouse cursor.
AnnotationToolType_AutoEllipse	An ellipse changes automatically in pace with the mouse cursor.
AnnotationToolType_AutoArrow	An arrow changes automatically in pace with the mouse cursor.
AnnotationToolType_AutoRectangleFill	A filled rectangle.
AnnotationToolType_AutoEllipseFill	A filled ellipse.
AnnotationToolType_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.
AnnotationToolType_Arrow	Displays a small arrow instead of your mouse pointer. Each subsequent click will remove the previous arrow placed.
AnnotationToolType_ERASER	Erase parts of your annotation.
AnnotationToolType_Textbox	Insert a textbox to input letters.
AnnotationToolType_Picker	Only available if you started the shared screen or whiteboard. Select , move, or resize your annotations.
AnnotationToolType_AutoRectangleSemiFill	A fair rectangle changes automatically in pace with the mouse cursor.
AnnotationToolType_AutoEllipseSemiFill	A fair ellipse changes automatically in pace with the mouse cursor.
AnnotationToolType_AutoDoubleArrow	A line with a double-arrow.
AnnotationToolType_AutoDiamond	An unfilled rhombus.
AnnotationToolType_AutoStampArrow	A fixed-size arrow for marking.
AnnotationToolType_AutoStampCheck	A sign marking that something is correct.
AnnotationToolType_AutoStampX	A sign marking that something is incorrect.
AnnotationToolType_AutoStampStar	A star for marking.
AnnotationToolType_AutoStampHeart	A heart for marking.
AnnotationToolType_AutoStampQm	A sign for interrogation.

Definition at line 115 of file ZoomSDKErrors.h.

            {
    AnnotationToolType_None,
    AnnotationToolType_Pen,
    AnnotationToolType_HighLighter,
    AnnotationToolType_AutoLine,
    AnnotationToolType_AutoRectangle,
    AnnotationToolType_AutoEllipse,
    AnnotationToolType_AutoArrow,
    AnnotationToolType_AutoRectangleFill,
    AnnotationToolType_AutoEllipseFill,
    AnnotationToolType_SpotLight,
    AnnotationToolType_Arrow,
    AnnotationToolType_ERASER,
    AnnotationToolType_Textbox,
    AnnotationToolType_Picker,
    AnnotationToolType_AutoRectangleSemiFill,
    AnnotationToolType_AutoEllipseSemiFill,
    AnnotationToolType_AutoDoubleArrow,
    AnnotationToolType_AutoDiamond,
    AnnotationToolType_AutoStampArrow,
    AnnotationToolType_AutoStampCheck,
    AnnotationToolType_AutoStampX,
    AnnotationToolType_AutoStampStar,
    AnnotationToolType_AutoStampHeart,
    AnnotationToolType_AutoStampQm
}AnnotationToolType;

◆ AttendeeViewQuestionType

enum AttendeeViewQuestionType

Enumeration of attendee view question type.

Enumerator
ViewType_OnlyAnswered_Question	Attendee only view the answered question.
ViewType_All_Question	Attendee view the all question.

Definition at line 1203 of file ZoomSDKErrors.h.

             {
    ViewType_OnlyAnswered_Question = 0,
    ViewType_All_Question
}AttendeeViewQuestionType;

◆ CallInNumberType

enum CallInNumberType

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

Enumerator
CallInNumberType_None	For initialization.
CallInNumberType_Toll	Paid (toll) number.
CallInNumberType_TollFree	Toll-free number.

Definition at line 845 of file ZoomSDKErrors.h.

{
    CallInNumberType_None,
    CallInNumberType_Toll,
    CallInNumberType_TollFree
}CallInNumberType;

◆ ConnectionComponent

enum ConnectionComponent

Enumeration of component types.

Enumerator
ConnectionComponent_None	For initialization.
ConnectionComponent_Share	Share.
ConnectionComponent_Video	Video.
ConnectionComponent_Audio	Audio.

Definition at line 938 of file ZoomSDKErrors.h.

            {
    ConnectionComponent_None,
    ConnectionComponent_Share,
    ConnectionComponent_Video,
    ConnectionComponent_Audio
}ConnectionComponent;

◆ DirectShareStatus

enum DirectShareStatus

Enumeration of direct sharing status.

Enumerator
DirectShareStatus_None	For initialization.
DirectShareStatus_Connecting	Waiting for enabling the direct sharing.
DirectShareStatus_InProgress	In direct sharing mode.
DirectShareStatus_Ended	End the direct sharing.
DirectShareStatus_NeedMeetingIDOrSharingKey	Input the meeting ID/pairing code.
DirectShareStatus_WrongMeetingIDOrSharingKey	The meeting ID or pairing code is wrong.
DirectShareStatus_NetworkError	Network issue. Reconnect later.
DirectShareStatus_NeedInputNewPairingCode	Need input new paring code.
DirectShareStatus_Prepared	Prepared.
DirectShareStatus_Unknown	Unknown share status.

Definition at line 1097 of file ZoomSDKErrors.h.

            {
    DirectShareStatus_None = 0,
    DirectShareStatus_Connecting = 1,
    DirectShareStatus_InProgress = 2,
    DirectShareStatus_Ended = 3,
    DirectShareStatus_NeedMeetingIDOrSharingKey = 4,
    DirectShareStatus_WrongMeetingIDOrSharingKey = 5, 
    DirectShareStatus_NetworkError = 6,
    DirectShareStatus_NeedInputNewPairingCode,
    DirectShareStatus_Prepared,
    DirectShareStatus_Unknown = 100
}DirectShareStatus;

◆ EncryptType

enum EncryptType

Enumeration of H.323/SIP encryption types.

Enumerator
EncryptType_NO	Meeting room system is not encrypted.
EncryptType_YES	Meeting room system is encrypted.
EncryptType_Auto	Meeting room system is encrypted automatically.

Definition at line 976 of file ZoomSDKErrors.h.

{
    EncryptType_NO,
    EncryptType_YES,
    EncryptType_Auto
}EncryptType;

◆ EndMeetingReason

enum EndMeetingReason

Enumeration of ending meeting errors.

Enumerator
EndMeetingReason_None	For initialization.
EndMeetingReason_KickByHost	The user is kicked off by the host and leaves the meeting.
EndMeetingReason_EndByHost	Host ends the meeting.
EndMeetingReason_JBHTimeOut	Join the meeting before host (JBH) timeout.
EndMeetingReason_NoAttendee	Meeting is ended for there is no attendee joins it.
EndMeetingReason_HostStartAnotherMeeting	Host ends the meeting for he will start another meeting.
EndMeetingReason_FreeMeetingTimeOut	Meeting is ended for the free meeting timeout.
EndMeetingReason_Undefined	Represents an undefined end meeting reason, typically used for new error codes introduced by the backend after client release.
EndMeetingReason_DueToAuthorizedUserLeave

Definition at line 952 of file ZoomSDKErrors.h.

            {
    EndMeetingReason_None = 0,
    EndMeetingReason_KickByHost = 1,
    EndMeetingReason_EndByHost = 2,
    EndMeetingReason_JBHTimeOut = 3,
    EndMeetingReason_NoAttendee = 4,
    EndMeetingReason_HostStartAnotherMeeting = 5,
    EndMeetingReason_FreeMeetingTimeOut = 6,
    EndMeetingReason_Undefined = 7,
    /* Authorized user left. */
    EndMeetingReason_DueToAuthorizedUserLeave = 8,
}EndMeetingReason;

◆ FreeMeetingNeedUpgradeType

enum FreeMeetingNeedUpgradeType

Enumeration indicating reasons why a free meeting needs an upgrade.

Enumerator
FreeMeetingNeedUpgradeType_NONE
FreeMeetingNeedUpgradeType_BY_ADMIN	Upgrade required due to admin payment reminder.
FreeMeetingNeedUpgradeType_BY_GIFTURL	Upgrade triggered by gift URL.

Definition at line 1086 of file ZoomSDKErrors.h.

            {
    FreeMeetingNeedUpgradeType_NONE,
    FreeMeetingNeedUpgradeType_BY_ADMIN,
    FreeMeetingNeedUpgradeType_BY_GIFTURL
}FreeMeetingNeedUpgradeType;

◆ H323CalloutStatus

enum H323CalloutStatus

Enumeration of H.323 device outgoing call status.

Note: The order of enumeration members has been changed. H323CalloutStatus_Unknown has been moved.

Enumerator
H323CalloutStatus_Success	Call out successfully.
H323CalloutStatus_Ring	In process of ringing.
H323CalloutStatus_Timeout	Timeout.
H323CalloutStatus_Failed	Failed to call out.
H323CalloutStatus_Unknown	Unknown status.
H323CalloutStatus_Busy	Busy.
H323CalloutStatus_Decline	Declined.

Definition at line 649 of file ZoomSDKErrors.h.

{
    H323CalloutStatus_Success,
    H323CalloutStatus_Ring,
    H323CalloutStatus_Timeout,
    H323CalloutStatus_Failed,
    H323CalloutStatus_Unknown,
    H323CalloutStatus_Busy,
    H323CalloutStatus_Decline
}H323CalloutStatus;

◆ H323DeviceType

enum H323DeviceType

Enumeration of H.323 device types.

Enumerator
H323DeviceType_Unknown	Unknown device type.
H323DeviceType_H323	H.323 device.
H323DeviceType_SIP	SIP device.

Definition at line 689 of file ZoomSDKErrors.h.

{
    H323DeviceType_Unknown,
    H323DeviceType_H323,
    H323DeviceType_SIP
}H323DeviceType;

◆ H323PairingResult

enum H323PairingResult

Enumeration of H.323 device pairing Status.

Enumerator
H323PairingResult_Unknown	Unknown status.
H323PairingResult_Success	Pairing successfully.
H323PairingResult_Meeting_Not_Exist	Pairing meeting does not exist.
H323PairingResult_Paringcode_Not_Exist	Pairing code does not exist.
H323PairingResult_No_Privilege	No pairing privilege.
H323PairingResult_Other_Error	Other errors.

Definition at line 670 of file ZoomSDKErrors.h.

{
    H323PairingResult_Unknown,
    H323PairingResult_Success,
    H323PairingResult_Meeting_Not_Exist,
    H323PairingResult_Paringcode_Not_Exist,
    H323PairingResult_No_Privilege,
    H323PairingResult_Other_Error
}H323PairingResult;

◆ JoinMeetingReqInfoType

enum JoinMeetingReqInfoType

Join meeting with required information.

Enumerator
JoinMeetingReqInfoType_None	For initialization.
JoinMeetingReqInfoType_Password	Join meeting with password.
JoinMeetingReqInfoType_Password_Wrong	The password for join meeting is incorrect.
JoinMeetingReqInfoType_ScreenName	The user needs to enter the screen name.

Definition at line 713 of file ZoomSDKErrors.h.

{
    JoinMeetingReqInfoType_None,
    JoinMeetingReqInfoType_Password,
    JoinMeetingReqInfoType_Password_Wrong,
    JoinMeetingReqInfoType_ScreenName
}JoinMeetingReqInfoType;

◆ LeaveMeetingCmd

enum LeaveMeetingCmd

Enumeration of commands for leaving meeting.

Enumerator
LeaveMeetingCmd_Leave	Command of leaving meeting.
LeaveMeetingCmd_End	Command of ending Meeting.

Definition at line 45 of file ZoomSDKErrors.h.

             {
    LeaveMeetingCmd_Leave,
    LeaveMeetingCmd_End
}LeaveMeetingCmd;

◆ LiveStreamStatus

enum LiveStreamStatus

Enumeration of live stream status.

Enumerator
LiveStreamStatus_None	Only for initialization.
LiveStreamStatus_InProgress	Live stream in process.
LiveStreamStatus_Connecting	Be connecting.
LiveStreamStatus_StartFailedTimeout	Connect timeout.
LiveStreamStatus_StartFailed	Connect failed to the live streaming.
LiveStreamStatus_Ended	End.

Definition at line 1067 of file ZoomSDKErrors.h.

            {
    LiveStreamStatus_None,
    LiveStreamStatus_InProgress,
    LiveStreamStatus_Connecting,
    LiveStreamStatus_StartFailedTimeout, 
    LiveStreamStatus_StartFailed,
    LiveStreamStatus_Ended
}LiveStreamStatus;

◆ MeetingComponent

enum MeetingComponent

In-meeting UI components.

Enumerator
MeetingComponent_MainWindow	Meeting window.
MeetingComponent_Audio	Audio.
MeetingComponent_Chat	Chat.
MeetingComponent_Participants	Participants.
MeetingComponent_MainToolBar	Main toolbar at the bottom of meeting window.
MeetingComponent_MainShareToolBar	Main toolbar for sharing on the primary view.
MeetingComponent_AuxShareToolBar	Deprecated This enum value is deprecated and will be removed in a future release.
MeetingComponent_Setting	Setting components.
MeetingComponent_ShareOptionWindow	Window for sharing options.
MeetingComponent_ThumbnailVideo	Thumbnail video layout.
MeetingComponent_InviteWindow	Window for invite other into meeting.
MeetingComponent_ShareSelectWindow	Window for sharing select.

Definition at line 181 of file ZoomSDKErrors.h.

            {
    MeetingComponent_MainWindow,
    MeetingComponent_Audio,
    MeetingComponent_Chat,
    MeetingComponent_Participants,
    MeetingComponent_MainToolBar,
    MeetingComponent_MainShareToolBar,
    MeetingComponent_AuxShareToolBar,
    MeetingComponent_Setting, 
    MeetingComponent_ShareOptionWindow,
    MeetingComponent_ThumbnailVideo,
    MeetingComponent_InviteWindow,
    MeetingComponent_ShareSelectWindow
}MeetingComponent;

◆ MeetingPropertyCmd

enum MeetingPropertyCmd

Get default information of meeting.

Enumerator
MeetingPropertyCmd_Topic	The topic of meeting.
MeetingPropertyCmd_InviteEmailTemplate	The template of email invitation.
MeetingPropertyCmd_InviteEmailTitle	The title of email invitation.
MeetingPropertyCmd_JoinMeetingUrl	The invitation URL.
MeetingPropertyCmd_DefaultRecordPath	The default path to save the recording files.
MeetingPropertyCmd_MeetingNumber	The meeting number.
MeetingPropertyCmd_HostTag	The tag of host.
MeetingPropertyCmd_MeetingID	Meeting ID.
MeetingPropertyCmd_MeetingPassword	Meeting password.

Definition at line 91 of file ZoomSDKErrors.h.

             {
    MeetingPropertyCmd_Topic,
    MeetingPropertyCmd_InviteEmailTemplate,
    MeetingPropertyCmd_InviteEmailTitle,
    MeetingPropertyCmd_JoinMeetingUrl,
    MeetingPropertyCmd_DefaultRecordPath,
    MeetingPropertyCmd_MeetingNumber,
    MeetingPropertyCmd_HostTag, 
    MeetingPropertyCmd_MeetingID,
    MeetingPropertyCmd_MeetingPassword
}MeetingPropertyCmd;

◆ MeetingSettingCmd

enum MeetingSettingCmd

Enumeration of Meeting settings.

Enumerator
MeetingSettingCmd_DualScreenMode	Dual screen mode.
MeetingSettingCmd_AutoFullScreenWhenJoinMeeting	Enter full screen mode when user joins the meeting.
MeetingSettingCmd_EnablePlayChimeWhenEnterOrExit	Enable to play chime when user joins or exits the meeting.

Definition at line 211 of file ZoomSDKErrors.h.

            {
    MeetingSettingCmd_DualScreenMode,
    MeetingSettingCmd_AutoFullScreenWhenJoinMeeting,
    MeetingSettingCmd_EnablePlayChimeWhenEnterOrExit
}MeetingSettingCmd;

◆ MeetingType

enum MeetingType

Enumeration of meeting types.

Enumerator
MeetingType_None	There is no meeting.
MeetingType_Normal	Normal meeting.
MeetingType_BreakoutRoom	Breakout meeting.
MeetingType_Webinar	Webinar meeting.

Definition at line 728 of file ZoomSDKErrors.h.

{
    MeetingType_None,
    MeetingType_Normal,
    MeetingType_BreakoutRoom,
    MeetingType_Webinar
}MeetingType;

◆ PhoneFailedReason

enum PhoneFailedReason

Enumeration of the reasons for the telephone call’s failure.

Enumerator
PhoneFailedReason_None	For initialization.
PhoneFailedReason_Busy	The telephone service is busy.
PhoneFailedReason_Not_Available	The telephone is out of service.
PhoneFailedReason_User_Hangup	The phone is hung up.
PhoneFailedReason_Other_Fail	Other reasons.
PhoneFailedReason_No_Answer	The call is not answered.
PhoneFailedReason_Block_No_Host	Disable the international callout function before the host joins the meeting.
PhoneFailedReason_Block_High_Rate	The call-out is blocked by the system due to the high cost.
PhoneFailedReason_Block_Too_Frequent	All the users invited by the call should press one(1) to join the meeting. If many invitees do not press the button and instead are timed out, the call invitation for this meeting is blocked.

Definition at line 789 of file ZoomSDKErrors.h.

{
    PhoneFailedReason_None,
    PhoneFailedReason_Busy,
    PhoneFailedReason_Not_Available,
    PhoneFailedReason_User_Hangup,
    PhoneFailedReason_Other_Fail,
    PhoneFailedReason_No_Answer,
    PhoneFailedReason_Block_No_Host,
    PhoneFailedReason_Block_High_Rate,
    PhoneFailedReason_Block_Too_Frequent
}PhoneFailedReason;

◆ PhoneStatus

enum PhoneStatus

Enumeration of phone call status.

Enumerator
PhoneStatus_None	No status.
PhoneStatus_Calling	In process of calling out.
PhoneStatus_Ringing	In process of ringing.
PhoneStatus_Accepted	The call is accepted.
PhoneStatus_Success	Call successful.
PhoneStatus_Failed	Call failed.
PhoneStatus_Canceling	In process of canceling the response to the previous state.
PhoneStatus_Canceled	Cancel successfully.
PhoneStatus_Cancel_Failed	Failed to cancel.
PhoneStatus_Timeout	Timeout.

Definition at line 762 of file ZoomSDKErrors.h.

{
    PhoneStatus_None,
    PhoneStatus_Calling,
    PhoneStatus_Ringing,
    PhoneStatus_Accepted,
    PhoneStatus_Success,
    PhoneStatus_Failed,
    PhoneStatus_Canceling,
    PhoneStatus_Canceled,
    PhoneStatus_Cancel_Failed,
    PhoneStatus_Timeout
}PhoneStatus;

◆ ScreenType

enum ScreenType

Enumeration of screen types for multi-sharing.

Enumerator
ScreenType_First	Primary display.
ScreenType_Second	Secondary display.

Definition at line 702 of file ZoomSDKErrors.h.

{
  ScreenType_First,
  ScreenType_Second
}ScreenType;

◆ SDKButton

enum SDKButton

Enumeration of in-meeting buttons on the toolbar.

Enumerator
AudioButton	Audio button: manage in-meeting audio of the current user.
VideoButton	Video button: manage in-meeting video of the current user.
ParticipantButton	Participant button: manage or check the participants.
FitBarNewShareButton	Share button: share screen or application, etc.
FitBarRemoteControlButton	Remote control button when sharing or viewing the share.
FitBarPauseShareButton	Pause the share.
FitBarAnnotateButton	Annotation button.
QAButton	Question and answer(QA) button. Available only in webinar.
FitBarBroadcastButton	Broadcast the webinar so user can join the webinar.
PollingButton	Poll button: questionnaire.
FitBarMoreButton	More: other functions in the menu.
MainExitFullScreenButton	Exit full screen.
ClaimHostButton	Button for getting host.
UpgradeButtonInFreeMeetingRemainTimeTooltip	Upgarde button of free meeting remain time tooltip view.
SwapShareContentAndVideoButton	Swap share and video button: swap to display share or video.
ChatButton	Chat button: manage in-meeting chat of the current user.
ToolBarReactionsButton	Reaction Button on tool bar.
ToolBarShareButton	Share button on tool bar.
RecordButton	Recording button.

Definition at line 858 of file ZoomSDKErrors.h.

{
    AudioButton,
    VideoButton,
    ParticipantButton,
    FitBarNewShareButton, 
    FitBarRemoteControlButton,
    FitBarPauseShareButton,
    FitBarAnnotateButton,
    QAButton,
    FitBarBroadcastButton,
    PollingButton,
    FitBarMoreButton,
    MainExitFullScreenButton,
    ClaimHostButton,
    UpgradeButtonInFreeMeetingRemainTimeTooltip,
    SwapShareContentAndVideoButton,
    ChatButton,
    ToolBarReactionsButton,
    ToolBarShareButton,
    RecordButton
}SDKButton;

◆ SDKUserType

enum SDKUserType

Enumeration of the types of users.

Enumerator
SDKUserType_APIUser	API user.
SDKUserType_EmailLogin	User logs in with email.
SDKUserType_FaceBook	User logs in with Facebook account.
SDKUserType_GoogleOAuth	User logs in with Google authentication.
SDKUserType_SSO	User logs in with SSO token.
SDKUserType_Unknown	Unknown user type.

Definition at line 27 of file ZoomSDKErrors.h.

             {
    SDKUserType_APIUser,
    SDKUserType_EmailLogin,
    SDKUserType_FaceBook,
    SDKUserType_GoogleOAuth,
    SDKUserType_SSO,
    SDKUserType_Unknown
}SDKUserType;

◆ SecuritySessionComponet

enum SecuritySessionComponet

Enumeration of security session types.

Deprecated: This enum is deprecated and will be removed in a future release.

Enumerator
SecuritySessionComponent_Unknown	Unknown component.
SecuritySessionComponent_Chat	Chat.
SecuritySessionComponent_FT	File Transfer.
SecuritySessionComponent_Audio	Audio.
SecuritySessionComponent_Video	Video.
SecuritySessionComponent_AS	Share application.

Definition at line 904 of file ZoomSDKErrors.h.

{
    SecuritySessionComponent_Unknown,
    SecuritySessionComponent_Chat,
    SecuritySessionComponent_FT,
    SecuritySessionComponent_Audio,
    SecuritySessionComponent_Video,
    SecuritySessionComponent_AS
}SecuritySessionComponet;

◆ SettingComponent

enum SettingComponent

Enumerate of the various components in the settings UI.

Enumerator
SettingComponent_AdvancedFeatureButton	Deprecated This enum value is deprecated and will be removed in a future release.
SettingComponent_AdvancedFeatureTab	The advanced settings tab.
SettingComponent_GeneralFeatureTab	The general settings tab.
SettingComponent_VideoFeatureTab	Deprecated Use SettingComponent_VideoAndVirtualBackgroundFeatureTab instead.
SettingComponent_AudioFeatureTab	The audio settings tab.
SettingComponent_VirtualBackgroundFeatureTab	Deprecated Use SettingComponent_VideoAndVirtualBackgroundFeatureTab instead.
SettingComponent_RecordingFeatureTab	The recording settings tab.
SettingComponent_StatisticsFeatureTab	The statistics settings tab.
SettingComponent_FeedbackFeatureTab	Deprecated This enum value is deprecated and will be removed in a future release.
SettingComponent_AccessibilityFeatureTab	The accessibility settings tab.
SettingComponent_ScreenShareFeatureTab	The screen sharing settings tab.
SettingComponent_ShortCutFeatureTab	The shortcut settings tab.
SettingComponent_VideoAndVirtualBackgroundFeatureTab	The video & virtual background settings tab.

Definition at line 2566 of file ZoomSDKErrors.h.

            {
    SettingComponent_AdvancedFeatureButton,
    SettingComponent_AdvancedFeatureTab,
    SettingComponent_GeneralFeatureTab,
    SettingComponent_VideoFeatureTab,
    SettingComponent_AudioFeatureTab,
    SettingComponent_VirtualBackgroundFeatureTab,
    SettingComponent_RecordingFeatureTab,
    SettingComponent_StatisticsFeatureTab,
    SettingComponent_FeedbackFeatureTab,
    SettingComponent_AccessibilityFeatureTab,
    SettingComponent_ScreenShareFeatureTab,
    SettingComponent_ShortCutFeatureTab,
    SettingComponent_VideoAndVirtualBackgroundFeatureTab
}SettingComponent;

◆ SettingConnectionType

enum SettingConnectionType

Enumeration of connection types.

Enumerator
SettingConnectionType_Unknown	Unknown connection types.
SettingConnectionType_P2P	Peer to peer.
SettingConnectionType_Cloud	Connect to the cloud.

Definition at line 989 of file ZoomSDKErrors.h.

            {
    SettingConnectionType_Unknown,
    SettingConnectionType_P2P,
    SettingConnectionType_Cloud
}SettingConnectionType;

◆ SettingNetworkType

enum SettingNetworkType

Enumeration of network types.

Enumerator
SettingNetworkType_Unknown	Unknown network type.
SettingNetworkType_Wired	Wired LAN.
SettingNetworkType_WiFi	WIFI.
SettingNetworkType_PPP	PPP.
SettingNetworkType_3G
SettingNetworkType_Other	Other network types.

Definition at line 1001 of file ZoomSDKErrors.h.

            {
    SettingNetworkType_Unknown,
    SettingNetworkType_Wired,
    SettingNetworkType_WiFi,
    SettingNetworkType_PPP,
    /* 3G. */
    SettingNetworkType_3G,
    SettingNetworkType_Other
}SettingNetworkType;

◆ shareSettingCmd

enum shareSettingCmd

Enumeration of General setting about share.

Enumerator
shareSettingCmd_enterFullScreen	When user share screen will enter full screen.
shareSettingCmd_enterMaxWindow	When user to share screen will enter max window.
shareSettingCmd_sideToSideMode	Display the shared screen and participants' video side by side. For more information, please visit https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0067526.
shareSettingCmd_MaintainCurrentSize	Keep current size.
shareSettingCmd_AutoFitWindowWhenViewShare	Automatically scale the shared screen to fit the size of the Zoom window.

Definition at line 1187 of file ZoomSDKErrors.h.

             {
    shareSettingCmd_enterFullScreen,
    shareSettingCmd_enterMaxWindow,
    shareSettingCmd_sideToSideMode,
    shareSettingCmd_MaintainCurrentSize,
    shareSettingCmd_AutoFitWindowWhenViewShare
}shareSettingCmd;

◆ StatisticWarningType

enum StatisticWarningType

Enumeration of warning types.

Enumerator
StatisticWarningType_None	No warnings.
StatisticWarningType_NetworkBad	The quality of the network connection is very poor.
StatisticWarningType_CPUHigh	Deprecated This enum value is deprecated and will be removed in a future release.
StatisticWarningType_SystemBusy	The system is busy.

Definition at line 923 of file ZoomSDKErrors.h.

{
    StatisticWarningType_None,
    StatisticWarningType_NetworkBad,
    StatisticWarningType_CPUHigh,
    StatisticWarningType_SystemBusy
}StatisticWarningType;

◆ UserRole

enum UserRole

Enumeration of user roles.

Enumerator
UserRole_None	For initialization.
UserRole_Host	Host.
UserRole_CoHost	Co-host.
UserRole_Attendee	Attendee or webinar attendee.
UserRole_Panelist	Panelist.
UserRole_BreakoutRoom_Moderator	Moderator of breakout room.

Definition at line 743 of file ZoomSDKErrors.h.

{
    UserRole_None,
    UserRole_Host,
    UserRole_CoHost,
    UserRole_Attendee,
    UserRole_Panelist,
    UserRole_BreakoutRoom_Moderator
}UserRole;

◆ VideoRenderDataType

enum VideoRenderDataType

Enumeration of video render data types.

Enumerator
VideoRenderDataType_None	For initialization.
VideoRenderDataType_Video	Video data.
VideoRenderDataType_Avatar	Avatar data.

Definition at line 1033 of file ZoomSDKErrors.h.

            {
    VideoRenderDataType_None,
    VideoRenderDataType_Video,
    VideoRenderDataType_Avatar
}VideoRenderDataType;

◆ VideoRenderElementType

enum VideoRenderElementType

Enumeration of video render element types.

Enumerator
VideoRenderElementType_None	For initialization.
VideoRenderElementType_Preview	Preview the video of user himself.
VideoRenderElementType_Active	Render the video of active speaker.
VideoRenderElementType_Normal	Render normal video.

Definition at line 1019 of file ZoomSDKErrors.h.

            {
    VideoRenderElementType_None,
    VideoRenderElementType_Preview,
    VideoRenderElementType_Active, 
    VideoRenderElementType_Normal
}VideoRenderElementType;

◆ ViewShareMode

enum ViewShareMode

Enumeration of video aspect modes.

Enumerator
ViewShareMode_FullFill	Stretch both horizontally and vertically to fill the display (may cause distortion).
ViewShareMode_LetterBox	Add black bars to maintain aspect ratio (e.g., 16:9 content on a 4:3 display or vice versa).

Definition at line 1045 of file ZoomSDKErrors.h.

            {
    ViewShareMode_FullFill,
    ViewShareMode_LetterBox
}ViewShareMode;

◆ WebinarRegisterType

enum WebinarRegisterType

Enumeration of types to register webinar.

Enumerator
WebinarRegisterType_None	For initialization.
WebinarRegisterType_URL	Register webinar with URL.
WebinarRegisterType_Email	Register webinar with email.

Definition at line 1123 of file ZoomSDKErrors.h.

{
    WebinarRegisterType_None,
    WebinarRegisterType_URL,
    WebinarRegisterType_Email
}WebinarRegisterType;

◆ ZoomSDKAICompanionFeature

enum ZoomSDKAICompanionFeature

Enumeration of AI Companion features in a meeting.

Enumerator
ZoomSDKAICompanionFeature_SmartSummary	Meeting summary with AI Companion generates summary assets.
ZoomSDKAICompanionFeature_Query	Meeting summary with AI Companion generates transcript assets.
ZoomSDKAICompanionFeature_SmartRecording	Meeting summary with AI Companion generates recording assets.

Definition at line 2436 of file ZoomSDKErrors.h.

{
    ZoomSDKAICompanionFeature_SmartSummary,
    ZoomSDKAICompanionFeature_Query,
    ZoomSDKAICompanionFeature_SmartRecording
}ZoomSDKAICompanionFeature;

◆ ZoomSDKAnnotationSavedType

enum ZoomSDKAnnotationSavedType

Enumeration of file types for saving screenshots.

Enumerator
ZoomSDKAnnotationSavedType_PNG	PNG file format.
ZoomSDKAnnotationSavedType_PDF	PDF file format.

Definition at line 1368 of file ZoomSDKErrors.h.

{
    ZoomSDKAnnotationSavedType_PNG,
    ZoomSDKAnnotationSavedType_PDF
}ZoomSDKAnnotationSavedType;

◆ ZoomSDKAttendeeViewMode

enum ZoomSDKAttendeeViewMode

Enumeration of attendee view modes in a Zoom meeting. For more information, please visit https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0063672.

Enumerator
ZoomSDKAttendeeViewMode_None	For initialization.
ZoomSDKAttendeeViewMode_FollowHost	Attendee view follows the host's view setting.
ZoomSDKAttendeeViewMode_Speaker	Speaker view: shows the active speaker.
ZoomSDKAttendeeViewMode_Gallery	Gallery view: displays all participants in a grid.
ZoomSDKAttendeeViewMode_Sharing_Standard	Standard screen sharing view.
ZoomSDKAttendeeViewMode_Sharing_SidebysideSpeaker	Side-by-side view with shared content and speaker.
ZoomSDKAttendeeViewMode_Sharing_SidebysideGallery	Side-by-side view with shared content and gallery.

Definition at line 1983 of file ZoomSDKErrors.h.

{
    ZoomSDKAttendeeViewMode_None,
    ZoomSDKAttendeeViewMode_FollowHost,
    ZoomSDKAttendeeViewMode_Speaker,
    ZoomSDKAttendeeViewMode_Gallery,
    ZoomSDKAttendeeViewMode_Sharing_Standard,
    ZoomSDKAttendeeViewMode_Sharing_SidebysideSpeaker,
    ZoomSDKAttendeeViewMode_Sharing_SidebysideGallery
}ZoomSDKAttendeeViewMode;

◆ ZoomSDKAudioActionInfo

enum ZoomSDKAudioActionInfo

Enumeration of audio button action info.

Enumerator
ZoomSDKAudioActionInfo_none	The audio button action info is none.
ZoomSDKAudioActionInfo_needJoinVoip	Need to join VoIP audio.
ZoomSDKAudioActionInfo_muteOrUnmenuAudio	Need to mute or unmute audio.
ZoomSDKAudioActionInfo_noAudioDeviceConnected	No audio device connected.
ZoomSDKAudioActionInfo_computerAudioDeviceError	Computer audio device error.

Definition at line 1246 of file ZoomSDKErrors.h.

             {
    ZoomSDKAudioActionInfo_none = 0,
    ZoomSDKAudioActionInfo_needJoinVoip,
    ZoomSDKAudioActionInfo_muteOrUnmenuAudio,
    ZoomSDKAudioActionInfo_noAudioDeviceConnected,
    ZoomSDKAudioActionInfo_computerAudioDeviceError
}ZoomSDKAudioActionInfo;

◆ ZoomSDKAudioChannel

enum ZoomSDKAudioChannel

Enumeration of audio channel types.

Enumerator
ZoomSDKAudioChannel_Mono	Mono audio channel.
ZoomSDKAudioChannel_Stereo	Stereo audio channel.

Definition at line 2227 of file ZoomSDKErrors.h.

{
    ZoomSDKAudioChannel_Mono,
    ZoomSDKAudioChannel_Stereo
}ZoomSDKAudioChannel;

◆ ZoomSDKAudioEchoCancellationLevel

enum ZoomSDKAudioEchoCancellationLevel

Enumeration of echo cancellation. For more information, please visit https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0066398.

Enumerator
ZoomSDKAudioEchoCancellationLevel_Auto	Automatically adjust echo cancellation, balancing CPU and performance.
ZoomSDKAudioEchoCancellationLevel_Low	Better echo limitation, taking into account multiple people talking at the same time, low CPU utilization.
ZoomSDKAudioEchoCancellationLevel_High	Best experience when multiple people are talking at the same time. Enabling this option may increase CPU utilization.

Definition at line 1577 of file ZoomSDKErrors.h.

{
    ZoomSDKAudioEchoCancellationLevel_Auto = 0,
    ZoomSDKAudioEchoCancellationLevel_Low,
    ZoomSDKAudioEchoCancellationLevel_High
}ZoomSDKAudioEchoCancellationLevel;

◆ ZoomSDKAudioRawdataSamplingRate

enum ZoomSDKAudioRawdataSamplingRate

Enumeration representing the sampling rate of acquired raw audio data.

Enumerator
ZoomSDKAudioRawdataSamplingRate_32K	The sampling rate of the acquired raw audio data is 32K.
ZoomSDKAudioRawdataSamplingRate_48K	The sampling rate of the acquired raw audio data is 48K.

Definition at line 2494 of file ZoomSDKErrors.h.

{
    ZoomSDKAudioRawdataSamplingRate_32K,
    ZoomSDKAudioRawdataSamplingRate_48K
}ZoomSDKAudioRawdataSamplingRate;

◆ ZoomSDKAudioShareMode

enum ZoomSDKAudioShareMode

Enumeration of the audio share modes.

Enumerator
ZoomSDKAudioShareMode_Mono	Mono audio share mode. Single channel audio.
ZoomSDKAudioShareMode_Stereo	Stereo audio share mode. Two-channel audio.

Definition at line 1866 of file ZoomSDKErrors.h.

{
    ZoomSDKAudioShareMode_Mono,
    ZoomSDKAudioShareMode_Stereo
}ZoomSDKAudioShareMode;

◆ ZoomSDKAudioStatus

enum ZoomSDKAudioStatus

Enumeration of Audio status.

Enumerator
ZoomSDKAudioStatus_None	For initialization.
ZoomSDKAudioStatus_Muted	The audio is muted.
ZoomSDKAudioStatus_UnMuted	The audio is unmuted.
ZoomSDKAudioStatus_MutedByHost	The audio is muted by the host.
ZoomSDKAudioStatus_UnMutedByHost	The audio is unmuted by the host.
ZoomSDKAudioStatus_MutedAllByHost	Host mutes all participants.
ZoomSDKAudioStatus_UnMutedAllByHost	Host unmutes all participants.

Definition at line 520 of file ZoomSDKErrors.h.

            {
    ZoomSDKAudioStatus_None = 0,
    ZoomSDKAudioStatus_Muted = 1,
    ZoomSDKAudioStatus_UnMuted = 2,
    ZoomSDKAudioStatus_MutedByHost = 3,
    ZoomSDKAudioStatus_UnMutedByHost = 4,
    ZoomSDKAudioStatus_MutedAllByHost = 5,
    ZoomSDKAudioStatus_UnMutedAllByHost = 6
}ZoomSDKAudioStatus;

◆ ZoomSDKAudioType

enum ZoomSDKAudioType

Enumeration of the type of a user's audio connection.

Enumerator
ZoomSDKAudioType_None	No audio connection.
ZoomSDKAudioType_Voip	Connected via VoIP (Voice over Internet Protocol).
ZoomSDKAudioType_Phone	Connected via phone call.
ZoomSDKAudioType_Unknown	Unknown audio connection type.

Definition at line 554 of file ZoomSDKErrors.h.

            {
    ZoomSDKAudioType_None = 0,
    ZoomSDKAudioType_Voip = 1,
    ZoomSDKAudioType_Phone = 2,
    ZoomSDKAudioType_Unknown = 3
}ZoomSDKAudioType;

◆ ZoomSDKAuthError

enum ZoomSDKAuthError

Enumeration of SDK authentication results.

Enumerator
ZoomSDKAuthError_Success	Authentication is successful.
ZoomSDKAuthError_KeyOrSecretWrong	Key or secret is wrong.
ZoomSDKAuthError_AccountNotSupport	Client account does not support.
ZoomSDKAuthError_AccountNotEnableSDK	Client account does not enable SDK.
ZoomSDKAuthError_Timeout	Auth timeout.
ZoomSDKAuthError_NetworkIssue	Network issue.
ZoomSDKAuthError_Client_Incompatible	Client incompatible.
ZoomSDKAuthError_JwtTokenWrong	The jwt token to authenticate is wrong.
ZoomSDKAuthError_KeyOrSecretEmpty	The key or secret to authenticate is empty.
ZoomSDKAuthError_LimitExceededException	The authentication rate limit is exceeded.
ZoomSDKAuthError_Unknown	Unknown error.

Definition at line 289 of file ZoomSDKErrors.h.

             {
    ZoomSDKAuthError_Success = 0,
    ZoomSDKAuthError_KeyOrSecretWrong,
    ZoomSDKAuthError_AccountNotSupport,
    ZoomSDKAuthError_AccountNotEnableSDK,
    ZoomSDKAuthError_Timeout,
    ZoomSDKAuthError_NetworkIssue,
    ZoomSDKAuthError_Client_Incompatible,
    ZoomSDKAuthError_JwtTokenWrong,
    ZoomSDKAuthError_KeyOrSecretEmpty,
    ZoomSDKAuthError_LimitExceededException,
    ZoomSDKAuthError_Unknown = 100
}ZoomSDKAuthError;

◆ ZoomSDKAutoFramingMode

enum ZoomSDKAutoFramingMode

Enumeration of auto framing modes in video.

Enumerator
ZoomSDKAutoFramingMode_None	No auto framing.
ZoomSDKAutoFramingMode_Center_Coordinates	Use the video frame’s center point as the center to zoom in.
ZoomSDKAutoFramingMode_Face_Recognition	Use the detected face in the video frame as the center to zoom in.

Definition at line 2157 of file ZoomSDKErrors.h.

{
    ZoomSDKAutoFramingMode_None,
    ZoomSDKAutoFramingMode_Center_Coordinates,
    ZoomSDKAutoFramingMode_Face_Recognition
}ZoomSDKAutoFramingMode;

◆ ZoomSDKBOControllerError

enum ZoomSDKBOControllerError

Enumeration of the errors related to the Breakout Room (BO) controller operations.

Enumerator
ZoomSDKBOControllerError_Null_Pointer	The pointer is null.
ZoomSDKBOControllerError_Wrong_Current_Status	Invalid action due to current BO status (e.g., already started or stopped).
ZoomSDKBOControllerError_Token_Not_Ready	BO token is not ready yet.
ZoomSDKBOControllerError_No_Privilege	Only the host has the privilege to create, start, or stop breakout rooms.
ZoomSDKBOControllerError_BO_List_Is_Uploading	Breakout room list is currently being uploaded.
ZoomSDKBOControllerError_Upload_Fail	Failed to upload the breakout room list to the conference attributes.
ZoomSDKBOControllerError_No_One_Has_Been_Assigned	No participants have been assigned to breakout rooms.
ZoomSDKBOControllerError_Unknown	Unknown error.

Definition at line 1704 of file ZoomSDKErrors.h.

            {
    ZoomSDKBOControllerError_Null_Pointer = 0,
    ZoomSDKBOControllerError_Wrong_Current_Status,
    ZoomSDKBOControllerError_Token_Not_Ready,
    ZoomSDKBOControllerError_No_Privilege,
    ZoomSDKBOControllerError_BO_List_Is_Uploading,
    ZoomSDKBOControllerError_Upload_Fail,
    ZoomSDKBOControllerError_No_One_Has_Been_Assigned,
    ZoomSDKBOControllerError_Unknown = 100
} ZoomSDKBOControllerError;

◆ ZoomSDKBOStatus

enum ZoomSDKBOStatus

Enumeration of Breakout Room (BO) status.

Enumerator
ZoomSDKBOStatus_Invalid	BO status is invalid.
ZoomSDKBOStatus_Edit	Editing and assigning participants to Breakout Rooms.
ZoomSDKBOStatus_Started	Breakout Rooms have started.
ZoomSDKBOStatus_Stopping	Breakout Rooms are currently stopping.
ZoomSDKBOStatus_Ended	Breakout Rooms have ended.

Definition at line 1762 of file ZoomSDKErrors.h.

            {
    ZoomSDKBOStatus_Invalid = 0,
    ZoomSDKBOStatus_Edit = 1,
    ZoomSDKBOStatus_Started = 2,
    ZoomSDKBOStatus_Stopping = 3,
    ZoomSDKBOStatus_Ended = 4
} ZoomSDKBOStatus;

◆ ZoomSDKBOStopCountDown

enum ZoomSDKBOStopCountDown

Enumeration of Breakout Room (BO) stop countdown durations.

Enumerator
ZoomSDKBOStopCountDown_Not	No countdown. Breakout Rooms stop immediately.
ZoomSDKBOStopCountDown_Seconds_10	Countdown duration: 10 seconds before BO stops.
ZoomSDKBOStopCountDown_Seconds_15	Countdown duration: 15 seconds before BO stops.
ZoomSDKBOStopCountDown_Seconds_30	Countdown duration: 30 seconds before BO stops.
ZoomSDKBOStopCountDown_Seconds_60	Countdown duration: 60 seconds before BO stops.
ZoomSDKBOStopCountDown_Seconds_120	Countdown duration: 120 seconds before BO stops.

Definition at line 1744 of file ZoomSDKErrors.h.

            {
    ZoomSDKBOStopCountDown_Not = 0,
    ZoomSDKBOStopCountDown_Seconds_10,
    ZoomSDKBOStopCountDown_Seconds_15,
    ZoomSDKBOStopCountDown_Seconds_30,
    ZoomSDKBOStopCountDown_Seconds_60,
    ZoomSDKBOStopCountDown_Seconds_120
} ZoomSDKBOStopCountDown;

◆ ZoomSDKBOUserStatus

enum ZoomSDKBOUserStatus

Enumeration of breakout meeting user status.

Enumerator
ZoomSDKBOUserStatus_Unknown	The breakout meeting status is unknown.
ZoomSDKBOUserStatus_UnAssigned	The user is unassigned to any breakout meeting.
ZoomSDKBOUserStatus_Assigned_Not_Join	The user is assigned but has not joined the breakout meeting.
ZoomSDKBOUserStatus_InBreakOutMeeting	The user is currently in the breakout meeting.

Definition at line 1262 of file ZoomSDKErrors.h.

            {
    ZoomSDKBOUserStatus_Unknown = 0,
    ZoomSDKBOUserStatus_UnAssigned,
    ZoomSDKBOUserStatus_Assigned_Not_Join,
    ZoomSDKBOUserStatus_InBreakOutMeeting
}ZoomSDKBOUserStatus;

◆ ZoomSDKCameraControlRequestResult

enum ZoomSDKCameraControlRequestResult

Enumeration of the results of a camera control request.

Enumerator
ZoomSDKCameraControlRequestResult_Approve	The camera control request was approved.
ZoomSDKCameraControlRequestResult_Decline	The camera control request was declined.
ZoomSDKCameraControlRequestResult_Revoke	The previously approved camera control was revoked.

Definition at line 2462 of file ZoomSDKErrors.h.

{
    ZoomSDKCameraControlRequestResult_Approve,
    ZoomSDKCameraControlRequestResult_Decline,
    ZoomSDKCameraControlRequestResult_Revoke
}ZoomSDKCameraControlRequestResult;

◆ ZoomSDKCameraControlRequestType

enum ZoomSDKCameraControlRequestType

Enumeration of camera control requests types.

Enumerator
ZoomSDKCameraControlRequestType_RequestControl	Request to take control of the camera.
ZoomSDKCameraControlRequestType_GiveUpControl	Give up control of the camera.

Definition at line 2450 of file ZoomSDKErrors.h.

{
    ZoomSDKCameraControlRequestType_RequestControl,
    ZoomSDKCameraControlRequestType_GiveUpControl
}ZoomSDKCameraControlRequestType;

◆ ZoomSDKCannotShareReasonType

enum ZoomSDKCannotShareReasonType

Enumeration of reasons why sharing is not allowed.

Enumerator
ZoomSDKCannotShareReasonType_None	For initialization.
ZoomSDKCannotShareReasonType_Locked	Only the host is allowed to share.
ZoomSDKCannotShareReasonType_Disabled	Sharing is disabled.
ZoomSDKCannotShareReasonType_Other_Screen_Sharing	Another participant is currently sharing their screen.
ZoomSDKCannotShareReasonType_Other_WB_Sharing	Another participant is currently sharing their whiteboard.
ZoomSDKCannotShareReasonType_Need_Grab_Myself_Screen_Sharing	The user is sharing screen, and can grab. To grab, call 'EnableGrabShareWithoutReminder:true' before starting the share.
ZoomSDKCannotShareReasonType_Need_Grab_Other_Screen_Sharing	Another is sharing screen, and can grab. To grab, call 'EnableGrabShareWithoutReminder:true' before starting the share.
ZoomSDKCannotShareReasonType_Need_Grab_Audio_Sharing	Another is sharing pure computer audio, and can grab. To grab, call 'EnableGrabShareWithoutReminder:true' before starting the share.
ZoomSDKCannotShareReasonType_Need_Grap_WB_Sharing	Other or myself is sharing cloud whiteboard, and can grab. To grab, call 'EnableGrabShareWithoutReminder:true' before starting the share.
ZoomSDKCannotShareReasonType_Reach_Maximum	The meeting has reached the maximum allowed screen share sessions.
ZoomSDKCannotShareReasonType_Have_Share_From_Mainsession	Other share screen in main session.
ZoomSDKCannotShareReasonType_Other_Docs_Sharing	Another participant is sharing zoom docs.
ZoomSDKCannotShareReasonType_Need_Grab_Docs_Sharing	Other or myself is sharing docs, can grab. To grab, call 'EnableGrabShareWithoutReminder:true' before starting the share.
ZoomSDKCannotShareReasonType_UnKnown	UnKnown reason.

Definition at line 2400 of file ZoomSDKErrors.h.

{
    ZoomSDKCannotShareReasonType_None,
    ZoomSDKCannotShareReasonType_Locked,
    ZoomSDKCannotShareReasonType_Disabled,
    ZoomSDKCannotShareReasonType_Other_Screen_Sharing,
    ZoomSDKCannotShareReasonType_Other_WB_Sharing,
    ZoomSDKCannotShareReasonType_Need_Grab_Myself_Screen_Sharing,
    ZoomSDKCannotShareReasonType_Need_Grab_Other_Screen_Sharing,
    ZoomSDKCannotShareReasonType_Need_Grab_Audio_Sharing,
    ZoomSDKCannotShareReasonType_Need_Grap_WB_Sharing,
    ZoomSDKCannotShareReasonType_Reach_Maximum,
    ZoomSDKCannotShareReasonType_Have_Share_From_Mainsession,
    ZoomSDKCannotShareReasonType_Other_Docs_Sharing,
    ZoomSDKCannotShareReasonType_Need_Grab_Docs_Sharing,
    ZoomSDKCannotShareReasonType_UnKnown
}ZoomSDKCannotShareReasonType;

◆ ZoomSDKChatMessageDeleteType

enum ZoomSDKChatMessageDeleteType

Enumeration of the chat message delete type.

Enumerator
ZoomSDK_Chat_Delete_By_None	For initialization.
ZoomSDK_Chat_Delete_By_Self	Message is deleted by the sender (self deletion).
ZoomSDK_Chat_Delete_By_Host	Message is deleted by the meeting host.
ZoomSDK_Chat_Delete_By_Dlp	Message is deleted by Data Loss Prevention (DLP) system for violating compliance policies.

Definition at line 1851 of file ZoomSDKErrors.h.

{
    ZoomSDK_Chat_Delete_By_None,
    ZoomSDK_Chat_Delete_By_Self,
    ZoomSDK_Chat_Delete_By_Host,
    ZoomSDK_Chat_Delete_By_Dlp
}ZoomSDKChatMessageDeleteType;

◆ ZoomSDKChatMessageType

enum ZoomSDKChatMessageType

Enumeration of the type for chat message.

Enumerator
ZoomSDKChatMessageType_To_None	For initialize.
ZoomSDKChatMessageType_To_All	Chat message is send to all in normal meeting ,also means to all panelist and attendees when webinar meeting.
ZoomSDKChatMessageType_To_All_Panelist	Chat message is send to all panelists.
ZoomSDKChatMessageType_To_Individual_Panelist	Chat message is send to individual attendee and cc panelists.
ZoomSDKChatMessageType_To_Individual	Chat message is send to individual user.
ZoomSDKChatMessageType_To_WaitingRoomUsers	Chat message is send to waiting room user.

Definition at line 1407 of file ZoomSDKErrors.h.

{
    ZoomSDKChatMessageType_To_None,
    ZoomSDKChatMessageType_To_All,
    ZoomSDKChatMessageType_To_All_Panelist,
    ZoomSDKChatMessageType_To_Individual_Panelist,
    ZoomSDKChatMessageType_To_Individual,
    ZoomSDKChatMessageType_To_WaitingRoomUsers
}ZoomSDKChatMessageType;

◆ ZoomSDKChatPrivilegeType

enum ZoomSDKChatPrivilegeType

Enumeration of the privilege for attendee chat.

Enumerator
ZoomSDKChatPrivilegeType_To_Everyone	Allow attendee to chat with everyone. [meeting & webinar].
ZoomSDKChatPrivilegeType_To_All_Panelist	Allow attendee to chat with all panelists only.[for webinar].
ZoomSDKChatPrivilegeType_To_Host	Allow attendee to chat with host only [meeting].
ZoomSDKChatPrivilegeType_Disable_Attendee_Chat	Allow attendee to chat with no one [meeting & webinar].
ZoomSDKChatPrivilegeType_Host_Public	Allow attendee to chat with host and public [meeting].

Definition at line 1379 of file ZoomSDKErrors.h.

{
    ZoomSDKChatPrivilegeType_To_Everyone,
    ZoomSDKChatPrivilegeType_To_All_Panelist,
    ZoomSDKChatPrivilegeType_To_Host,
    ZoomSDKChatPrivilegeType_Disable_Attendee_Chat,
    ZoomSDKChatPrivilegeType_Host_Public
}ZoomSDKChatPrivilegeType;

◆ ZoomSDKConnectionQuality

enum ZoomSDKConnectionQuality

Enumeration of connection quality.

Enumerator
ZoomSDKConnectionQuality_Unknown	Unknown connection status.
ZoomSDKConnectionQuality_VeryBad	The connection quality is very poor.
ZoomSDKConnectionQuality_Bad	The connection quality is poor.
ZoomSDKConnectionQuality_NotGood	The connection quality is not good.
ZoomSDKConnectionQuality_Normal	The connection quality is normal.
ZoomSDKConnectionQuality_Good	The connection quality is good.
ZoomSDKConnectionQuality_Excellent	The connection quality is excellent.

Definition at line 614 of file ZoomSDKErrors.h.

            {
    ZoomSDKConnectionQuality_Unknown,
    ZoomSDKConnectionQuality_VeryBad, 
    ZoomSDKConnectionQuality_Bad,
    ZoomSDKConnectionQuality_NotGood,
    ZoomSDKConnectionQuality_Normal,
    ZoomSDKConnectionQuality_Good,
    ZoomSDKConnectionQuality_Excellent
}ZoomSDKConnectionQuality;

◆ ZoomSDKCustom3DAvatarElementColorType

enum ZoomSDKCustom3DAvatarElementColorType

Enumeration of custom 3D avatar element color types.

Enumerator
ZoomSDKCustom3DAvatarElementColorType_None	None.
ZoomSDKCustom3DAvatarElementColorType_Eyebrow	Eyebrow.
ZoomSDKCustom3DAvatarElementColorType_Mustache	Mustache.
ZoomSDKCustom3DAvatarElementColorType_Hair	Hair.
ZoomSDKCustom3DAvatarElementColorType_Eyelash	Eyelash.

Definition at line 2713 of file ZoomSDKErrors.h.

{
    ZoomSDKCustom3DAvatarElementColorType_None = 0,
    ZoomSDKCustom3DAvatarElementColorType_Eyebrow,
    ZoomSDKCustom3DAvatarElementColorType_Mustache,
    ZoomSDKCustom3DAvatarElementColorType_Hair,
    ZoomSDKCustom3DAvatarElementColorType_Eyelash,
}ZoomSDKCustom3DAvatarElementColorType;

◆ ZoomSDKCustom3DAvatarElementImageType

enum ZoomSDKCustom3DAvatarElementImageType

Enumeration of custom 3D avatar element image types.

Enumerator
ZoomSDKCustom3DAvatarElementImageType_None	None.
ZoomSDKCustom3DAvatarElementImageType_Skin	Skin.
ZoomSDKCustom3DAvatarElementImageType_Face	Face.
ZoomSDKCustom3DAvatarElementImageType_Hair	Hair.
ZoomSDKCustom3DAvatarElementImageType_Eyes	Eyes.
ZoomSDKCustom3DAvatarElementImageType_EyeColor	Eye color.
ZoomSDKCustom3DAvatarElementImageType_Eyelashes	Eyelashes.
ZoomSDKCustom3DAvatarElementImageType_Eyebrows	Eyebrows.
ZoomSDKCustom3DAvatarElementImageType_Nose	Nose.
ZoomSDKCustom3DAvatarElementImageType_Mouth	Mouth.
ZoomSDKCustom3DAvatarElementImageType_LipColor	Lip color.
ZoomSDKCustom3DAvatarElementImageType_Age	Age.
ZoomSDKCustom3DAvatarElementImageType_FacialHair	Facial hair.
ZoomSDKCustom3DAvatarElementImageType_Body	Body.
ZoomSDKCustom3DAvatarElementImageType_Clothing	Clothing.
ZoomSDKCustom3DAvatarElementImageType_HeadCovering	Head covering.
ZoomSDKCustom3DAvatarElementImageType_Glasses	Glasses.

Definition at line 2672 of file ZoomSDKErrors.h.

{
    ZoomSDKCustom3DAvatarElementImageType_None = 0,
    ZoomSDKCustom3DAvatarElementImageType_Skin,
    ZoomSDKCustom3DAvatarElementImageType_Face,
    ZoomSDKCustom3DAvatarElementImageType_Hair,
    ZoomSDKCustom3DAvatarElementImageType_Eyes,
    ZoomSDKCustom3DAvatarElementImageType_EyeColor,
    ZoomSDKCustom3DAvatarElementImageType_Eyelashes,
    ZoomSDKCustom3DAvatarElementImageType_Eyebrows,
    ZoomSDKCustom3DAvatarElementImageType_Nose,
    ZoomSDKCustom3DAvatarElementImageType_Mouth,
    ZoomSDKCustom3DAvatarElementImageType_LipColor,
    ZoomSDKCustom3DAvatarElementImageType_Age,
    ZoomSDKCustom3DAvatarElementImageType_FacialHair,
    ZoomSDKCustom3DAvatarElementImageType_Body,
    ZoomSDKCustom3DAvatarElementImageType_Clothing,
    ZoomSDKCustom3DAvatarElementImageType_HeadCovering,
    ZoomSDKCustom3DAvatarElementImageType_Glasses,
}ZoomSDKCustom3DAvatarElementImageType;

◆ ZoomSDKCustomWaitingRoomDataStatus

enum ZoomSDKCustomWaitingRoomDataStatus

Enumeration of the status of custom waiting room data.

Enumerator
ZoomSDKCustomWaitingRoomDataStatus_Init	Initial state, before any download has started.
ZoomSDKCustomWaitingRoomDataStatus_Downloading	Custom waiting room data is currently being downloaded.
ZoomSDKCustomWaitingRoomDataStatus_Download_OK	Custom waiting room data has been successfully downloaded.
ZoomSDKCustomWaitingRoomDataStatus_Download_Failed	Failed to download custom waiting room data.

Definition at line 1890 of file ZoomSDKErrors.h.

{
    ZoomSDKCustomWaitingRoomDataStatus_Init,
    ZoomSDKCustomWaitingRoomDataStatus_Downloading,
    ZoomSDKCustomWaitingRoomDataStatus_Download_OK,
    ZoomSDKCustomWaitingRoomDataStatus_Download_Failed
}ZoomSDKCustomWaitingRoomDataStatus;

◆ ZoomSDKDeviceStatus

enum ZoomSDKDeviceStatus

Enumeration of device status.

Enumerator
Device_Error_Unknown	Unknown device error.
New_Device_Found	New device detected by the system.
Device_Error_Found	Device not found.
No_Device	No device.
Audio_No_Input	No audio input detected from the microphone.
Audio_Error_Be_Muted	Audio is muted. Press Command+Shift+A to unmute.
Device_List_Update	The device list has been updated.
Audio_Disconnect_As_Detected_Echo	Audio disconnected due to detected echo.

Definition at line 1150 of file ZoomSDKErrors.h.

            {
    Device_Error_Unknown,
    New_Device_Found,
    Device_Error_Found,
    No_Device,
    Audio_No_Input,
    Audio_Error_Be_Muted,
    Device_List_Update,
    Audio_Disconnect_As_Detected_Echo
}ZoomSDKDeviceStatus;

◆ ZoomSDKDocsCreateOption

enum ZoomSDKDocsCreateOption

Enumeration of document creation permission options.

Enumerator
ZoomSDKDocsCreateOption_None	Invalid option, possibly because the meeting does not support docs.
ZoomSDKDocsCreateOption_HostOnly	Only the host can initiate new docs.
ZoomSDKDocsCreateOption_AccountUsers	Users under the same account can initiate new docs.
ZoomSDKDocsCreateOption_All	All participants can initiate new docs.

Definition at line 2629 of file ZoomSDKErrors.h.

{
    ZoomSDKDocsCreateOption_None,
    ZoomSDKDocsCreateOption_HostOnly,
    ZoomSDKDocsCreateOption_AccountUsers,
    ZoomSDKDocsCreateOption_All
}ZoomSDKDocsCreateOption;

◆ ZoomSDKDocsShareOption

enum ZoomSDKDocsShareOption

Enumeration of document sharing permission options.

Enumerator
ZoomSDKDocsShareOption_None	Invalid option, such as the meeting not supporting document sharing.
ZoomSDKDocsShareOption_HostCoHostShare	Only Only the host or co-host can share documents.
ZoomSDKDocsShareOption_HostCoHostGrabShare	Anyone can share docs, but only one doc can be shared at a time, and the host or co-host can take over another'sharing.
ZoomSDKDocsShareOption_AllGrabShare	Anyone can share docs, but only one doc can be shared at a time, and any participant can take over another'sharing.

Definition at line 2613 of file ZoomSDKErrors.h.

{
    ZoomSDKDocsShareOption_None,
    ZoomSDKDocsShareOption_HostCoHostShare,
    ZoomSDKDocsShareOption_HostCoHostGrabShare,
    ZoomSDKDocsShareOption_AllGrabShare
}ZoomSDKDocsShareOption;

◆ ZoomSDKDocsStatus

enum ZoomSDKDocsStatus

Enumeration of document sharing status in a meeting.

Enumerator
ZoomSDKDocsStatus_None	For initialization.
ZoomSDKDocsStatus_Start	User starts sharing docs.
ZoomSDKDocsStatus_Stop	User stops sharing docs.

Definition at line 2599 of file ZoomSDKErrors.h.

{
    ZoomSDKDocsStatus_None,
    ZoomSDKDocsStatus_Start,
    ZoomSDKDocsStatus_Stop
}ZoomSDKDocsStatus;

◆ ZoomSDKEmojiFeedbackType

enum ZoomSDKEmojiFeedbackType

Enumeration of emoji feedback types.

Enumerator
ZoomSDKEmojiFeedbackType_None	No emoji feedback.
ZoomSDKEmojiFeedbackType_Yes	Yes emoji feedback.
ZoomSDKEmojiFeedbackType_No	No emoji feedback.
ZoomSDKEmojiFeedbackType_SpeedUp	Speed up emoji feedback.
ZoomSDKEmojiFeedbackType_SlowDown	Slow down emoji feedback.
ZoomSDKEmojiFeedbackType_Away	Away emoji feedback.

Definition at line 2187 of file ZoomSDKErrors.h.

{
    ZoomSDKEmojiFeedbackType_None,
    ZoomSDKEmojiFeedbackType_Yes,
    ZoomSDKEmojiFeedbackType_No,
    ZoomSDKEmojiFeedbackType_SpeedUp,
    ZoomSDKEmojiFeedbackType_SlowDown,
    ZoomSDKEmojiFeedbackType_Away
}ZoomSDKEmojiFeedbackType;

◆ ZoomSDKEmojiReactionDisplayType

enum ZoomSDKEmojiReactionDisplayType

Enumeration of emoji reaction display types in the meeting UI.

Enumerator
ZoomSDKEmojiReactionDisplayType_None	For initialization.
ZoomSDKEmojiReactionDisplayType_Full	Display all emoji reactions in full detail.
ZoomSDKEmojiReactionDisplayType_Medium	Display emoji reactions in a medium form.
ZoomSDKEmojiReactionDisplayType_Hidden	Do not display emoji reactions.

Definition at line 2004 of file ZoomSDKErrors.h.

{
    ZoomSDKEmojiReactionDisplayType_None,
    ZoomSDKEmojiReactionDisplayType_Full,
    ZoomSDKEmojiReactionDisplayType_Medium,
    ZoomSDKEmojiReactionDisplayType_Hidden
}ZoomSDKEmojiReactionDisplayType;

◆ ZoomSDKEmojiReactionSkinTone

enum ZoomSDKEmojiReactionSkinTone

Enumeration of available emoji reaction skin tones.

Enumerator
ZoomSDKEmojiReactionSkinTone_Unknown
ZoomSDKEmojiReactionSkinTone_Default	Default skin tone.
ZoomSDKEmojiReactionSkinTone_Light	Light skin tone.
ZoomSDKEmojiReactionSkinTone_MediumLight	Medium-light skin tone.
ZoomSDKEmojiReactionSkinTone_Medium	Medium skin tone.
ZoomSDKEmojiReactionSkinTone_MediumDark	Medium-dark skin tone.
ZoomSDKEmojiReactionSkinTone_Dark	Dark skin tone.

Definition at line 1557 of file ZoomSDKErrors.h.

{
    ZoomSDKEmojiReactionSkinTone_Unknown = 0,
    ZoomSDKEmojiReactionSkinTone_Default,
    ZoomSDKEmojiReactionSkinTone_Light,
    ZoomSDKEmojiReactionSkinTone_MediumLight,
    ZoomSDKEmojiReactionSkinTone_Medium,
    ZoomSDKEmojiReactionSkinTone_MediumDark,
    ZoomSDKEmojiReactionSkinTone_Dark
}ZoomSDKEmojiReactionSkinTone;

◆ ZoomSDKEmojiReactionType

enum ZoomSDKEmojiReactionType

Enumeration of available emoji reaction types. For more information, please visit https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0060612.

Enumerator
ZoomSDKEmojiReactionType_Unknown
ZoomSDKEmojiReactionType_Clap	Clap emoji reaction.
ZoomSDKEmojiReactionType_Thumbsup	Thumbs-up emoji reaction.
ZoomSDKEmojiReactionType_Heart	Heart emoji reaction.
ZoomSDKEmojiReactionType_Joy	Joy emoji reaction.
ZoomSDKEmojiReactionType_Openmouth	Open-mouth emoji reaction.
ZoomSDKEmojiReactionType_Tada	Tada emoji reaction.

Definition at line 1537 of file ZoomSDKErrors.h.

{
    ZoomSDKEmojiReactionType_Unknown = 0,
    ZoomSDKEmojiReactionType_Clap,
    ZoomSDKEmojiReactionType_Thumbsup,
    ZoomSDKEmojiReactionType_Heart,
    ZoomSDKEmojiReactionType_Joy,
    ZoomSDKEmojiReactionType_Openmouth,
    ZoomSDKEmojiReactionType_Tada
}ZoomSDKEmojiReactionType;

◆ ZoomSDKError

enum ZoomSDKError

Enumeration of common errors of SDK.

Enumerator
ZoomSDKError_Success	Success.
ZoomSDKError_Failed	Failed.
ZoomSDKError_Uninit	SDK is not initialize.
ZoomSDKError_ServiceFailed	Service is failed.
ZoomSDKError_WrongUsage	Incorrect usage of the feature.
ZoomSDKError_InvalidParameter	Wrong parameter.
ZoomSDKError_NoPermission	No permission.
ZoomSDKError_NoRecordingInProgress	There is no recording in process.
ZoomSDKError_TooFrequentCall	Api calls are too frequent.
ZoomSDKError_UnSupportedFeature	Unsupported feature.
ZoomSDKError_EmailLoginIsDisabled	Unsupport email login.
ZoomSDKError_ModuleLoadFail	Module load fail.
ZoomSDKError_NoVideoData	No video data.
ZoomSDKError_NoAudioData	No audio data.
ZoomSDKError_NoShareData	No share data.
ZoomSDKError_NoVideoDeviceFound	Not found video device.
ZoomSDKError_DeviceError	Device error.
ZoomSDKError_NotInMeeting	Not in meeting.
ZoomSDKError_initDevice	Init device.
ZoomSDKError_CanNotChangeVirtualDevice	Can't change virtual device.
ZoomSDKError_PreprocessRawdataError	Preprocess rawdata error.
ZoomSDKError_NoLicense	No license.
ZoomSDKError_Malloc_Failed	Malloc failed.
ZoomSDKError_ShareCannotSubscribeMyself	ShareCannotSubscribeMyself.
ZoomSDKError_NeedUserConfirmRecordDisclaimer	Need user confirm record disclaimer.
ZoomSDKError_UnKnown	Unknown error.
ZoomSDKError_NotJoinAudio	Not join audio.
ZoomSDKError_HardwareDontSupport	The current device doesn't support the feature.
ZoomSDKError_DomainDontSupport	Domain not support.
ZoomSDKError_FileTransferError	File transfer fail.

Definition at line 223 of file ZoomSDKErrors.h.

            {
    ZoomSDKError_Success,
    ZoomSDKError_Failed,
    ZoomSDKError_Uninit,
    ZoomSDKError_ServiceFailed, 
    ZoomSDKError_WrongUsage,
    ZoomSDKError_InvalidParameter,
    ZoomSDKError_NoPermission,
    ZoomSDKError_NoRecordingInProgress,
    ZoomSDKError_TooFrequentCall,
    ZoomSDKError_UnSupportedFeature,
    ZoomSDKError_EmailLoginIsDisabled,
    ZoomSDKError_ModuleLoadFail,
    ZoomSDKError_NoVideoData,
    ZoomSDKError_NoAudioData,
    ZoomSDKError_NoShareData,
    ZoomSDKError_NoVideoDeviceFound,
    ZoomSDKError_DeviceError,
    ZoomSDKError_NotInMeeting,
    ZoomSDKError_initDevice,
    ZoomSDKError_CanNotChangeVirtualDevice,
    ZoomSDKError_PreprocessRawdataError,
    ZoomSDKError_NoLicense,
    ZoomSDKError_Malloc_Failed,
    ZoomSDKError_ShareCannotSubscribeMyself,
    ZoomSDKError_NeedUserConfirmRecordDisclaimer,
    ZoomSDKError_UnKnown,
    ZoomSDKError_NotJoinAudio,
    ZoomSDKError_HardwareDontSupport,
    ZoomSDKError_DomainDontSupport,
    ZoomSDKError_FileTransferError
}ZoomSDKError;

◆ ZoomSDKFaceMakeupType

enum ZoomSDKFaceMakeupType

Enumeration of the types of face makeup effects.

Enumerator
ZoomSDKFaceMakeupType_None	For initialization.
ZoomSDKFaceMakeupType_Mustache	A virtual mustache.
ZoomSDKFaceMakeupType_Eyebrow	Enhances or changes eyebrow appearance.
ZoomSDKFaceMakeupType_Lip	Applies lip makeup.

Definition at line 1955 of file ZoomSDKErrors.h.

{
    ZoomSDKFaceMakeupType_None,
    ZoomSDKFaceMakeupType_Mustache,
    ZoomSDKFaceMakeupType_Eyebrow,
    ZoomSDKFaceMakeupType_Lip
}ZoomSDKFaceMakeupType;

◆ ZoomSDKFaceRecognitionFailStrategy

enum ZoomSDKFaceRecognitionFailStrategy

Enumeration of face recognition failure strategies.

Enumerator
ZoomSDKFaceRecognitionFailStrategy_None	No use of the fail strategy.
ZoomSDKFaceRecognitionFailStrategy_Remain	After face recognition fails, do nothing until face recognition succeeds again.
ZoomSDKFaceRecognitionFailStrategy_Using_Center_Coordinates	After face recognition fails, use the video frame’s center point as the center for zoom in.
ZoomSDKFaceRecognitionFailStrategy_Using_Original_Video	After face recognition fails, use original video.

Definition at line 2171 of file ZoomSDKErrors.h.

{
    ZoomSDKFaceRecognitionFailStrategy_None,
    ZoomSDKFaceRecognitionFailStrategy_Remain,
    ZoomSDKFaceRecognitionFailStrategy_Using_Center_Coordinates,
    ZoomSDKFaceRecognitionFailStrategy_Using_Original_Video
}ZoomSDKFaceRecognitionFailStrategy;

◆ ZoomSDKFileTransferStatus

enum ZoomSDKFileTransferStatus

Enumeration of the status of a file transfer.

Enumerator
ZoomSDKFileTransferStatus_None	The file transfer has no state.
ZoomSDKFileTransferStatus_ReadyToTransfer	The file transfer is ready to start.
ZoomSDKFileTransferStatus_Transfering	The file transfer is currently in progress.
ZoomSDKFileTransferStatus_TransferFailed	The file transfer has failed.
ZoomSDKFileTransferStatus_TransferDone	The file transfer completed successfully.

Definition at line 2476 of file ZoomSDKErrors.h.

{
    ZoomSDKFileTransferStatus_None = 0,
    ZoomSDKFileTransferStatus_ReadyToTransfer,
    ZoomSDKFileTransferStatus_Transfering,
    ZoomSDKFileTransferStatus_TransferFailed,
    ZoomSDKFileTransferStatus_TransferDone
}ZoomSDKFileTransferStatus;

◆ ZoomSDKFocusModeShareType

enum ZoomSDKFocusModeShareType

Enumeration of the focus mode share type. For more information, please visit https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0063004.

Enumerator
ZoomSDKFocusModeShareType_None	For initialization.
ZoomSDKFocusModeShareType_HostOnly	Only the host can view share content in focus mode.
ZoomSDKFocusModeShareType_AllParticipants	All participants can view share content in focus mode.

Definition at line 2328 of file ZoomSDKErrors.h.

{
    ZoomSDKFocusModeShareType_None,
    ZoomSDKFocusModeShareType_HostOnly,
    ZoomSDKFocusModeShareType_AllParticipants
}ZoomSDKFocusModeShareType;

◆ ZoomSDKFPSValue

enum ZoomSDKFPSValue

Enumeration of limited FPS (frames per second) values.

Enumerator
ZoomSDKFPSValue_One	FPS value is 1.
ZoomSDKFPSValue_Two	FPS value is 2.
ZoomSDKFPSValue_Four	TFPS value is 4.
ZoomSDKFPSValue_Six	TFPS value is 6.
ZoomSDKFPSValue_Eight	FPS value is 8.
ZoomSDKFPSValue_Ten	FPS value is 10.
ZoomSDKFPSValue_Fifteen	FPS value is 15.

Definition at line 1276 of file ZoomSDKErrors.h.

             {
    ZoomSDKFPSValue_One,
    ZoomSDKFPSValue_Two,
    ZoomSDKFPSValue_Four,
    ZoomSDKFPSValue_Six,
    ZoomSDKFPSValue_Eight,
    ZoomSDKFPSValue_Ten,
    ZoomSDKFPSValue_Fifteen
}ZoomSDKFPSValue;

◆ ZoomSDKFrameDataFormat

enum ZoomSDKFrameDataFormat

Enumeration of video frame data format.

Enumerator
ZoomSDKFrameDataFormat_I420_Limited	I420 format with limited (TV) range color space.
ZoomSDKFrameDataFormat_I420_Full	I420 format with full (PC) range color space.

Definition at line 2047 of file ZoomSDKErrors.h.

{
    ZoomSDKFrameDataFormat_I420_Limited,
    ZoomSDKFrameDataFormat_I420_Full
}ZoomSDKFrameDataFormat;

◆ ZoomSDKGrantCoOwnerAssetsType

enum ZoomSDKGrantCoOwnerAssetsType

Enumeration of asset type.

Enumerator
ZoomSDKGrantCoOwnerAssetsType_None	For initialization.
ZoomSDKGrantCoOwnerAssetsType_Summary	Summary.
ZoomSDKGrantCoOwnerAssetsType_CloudRecording	CloudRecording.

Definition at line 2644 of file ZoomSDKErrors.h.

{
    ZoomSDKGrantCoOwnerAssetsType_None,
    ZoomSDKGrantCoOwnerAssetsType_Summary,
    ZoomSDKGrantCoOwnerAssetsType_CloudRecording
}ZoomSDKGrantCoOwnerAssetsType;

◆ ZoomSDKLiveTranscriptionOperationType

enum ZoomSDKLiveTranscriptionOperationType

Enumeration of live transcription operation types.

Enumerator
ZoomSDK_LiveTranscription_OperationType_None	No operation. Typically used for initialization.
ZoomSDK_LiveTranscription_OperationType_Add	Add a new live transcription entry.
ZoomSDK_LiveTranscription_OperationType_Update	Update an existing live transcription entry.
ZoomSDK_LiveTranscription_OperationType_Delete	Delete a live transcription entry.
ZoomSDK_LiveTranscription_OperationType_Complete	The transcription entry complete.
ZoomSDK_LiveTranscription_OperationType_NotSupported	The operation is not supported.

Definition at line 1815 of file ZoomSDKErrors.h.

{
    ZoomSDK_LiveTranscription_OperationType_None = 0,
    ZoomSDK_LiveTranscription_OperationType_Add,
    ZoomSDK_LiveTranscription_OperationType_Update,
    ZoomSDK_LiveTranscription_OperationType_Delete,
    ZoomSDK_LiveTranscription_OperationType_Complete,
    ZoomSDK_LiveTranscription_OperationType_NotSupported
}ZoomSDKLiveTranscriptionOperationType;

◆ ZoomSDKLiveTranscriptionStaus

enum ZoomSDKLiveTranscriptionStaus

Enumeration of live transcription status in a meeting.

Enumerator
ZoomSDK_LiveTranscription_Status_Stop	Live transcription has not started.
ZoomSDK_LiveTranscription_Status_Start	Live transcription is active.
ZoomSDK_LiveTranscription_Status_User_Sub	The user has subscribed to live transcription.
ZoomSDK_LiveTranscription_Status_Connecting	Live transcription service is connecting.

Definition at line 1800 of file ZoomSDKErrors.h.

{
    ZoomSDK_LiveTranscription_Status_Stop = 0,
    ZoomSDK_LiveTranscription_Status_Start = 1,
    ZoomSDK_LiveTranscription_Status_User_Sub = 2,
    ZoomSDK_LiveTranscription_Status_Connecting = 10
}ZoomSDKLiveTranscriptionStaus;

◆ ZoomSDKLocalRecordingRequestPrivilegeStatus

enum ZoomSDKLocalRecordingRequestPrivilegeStatus

Enumeration of local recording request privilege settings.

Enumerator
ZoomSDKLocalRecordingRequestPrivilege_None	For initialization.
ZoomSDKLocalRecordingRequestPrivilege_AllowRequest	Allow participants to send recording privilege requests.
ZoomSDKLocalRecordingRequestPrivilege_AutoGrant	Automatically grant all recording privilege requests.
ZoomSDKLocalRecordingRequestPrivilege_AutoDeny	Automatically deny all recording privilege requests.

Definition at line 2032 of file ZoomSDKErrors.h.

{
    ZoomSDKLocalRecordingRequestPrivilege_None = 0,
    ZoomSDKLocalRecordingRequestPrivilege_AllowRequest,
    ZoomSDKLocalRecordingRequestPrivilege_AutoGrant,
    ZoomSDKLocalRecordingRequestPrivilege_AutoDeny
}ZoomSDKLocalRecordingRequestPrivilegeStatus;

◆ ZoomSDKLocalVideoDeviceRotation

enum ZoomSDKLocalVideoDeviceRotation

Enumeration of local video device rotation actions.

Enumerator
ZoomSDKLOCAL_DEVICE_ROTATION_ACTION_UNKnown	For initialization.
ZoomSDKLOCAL_DEVICE_ROTATION_ACTION_0	Rotation 0 degrees.
ZoomSDKLOCAL_DEVICE_ROTATION_ACTION_CLOCK90	Rotation clockwise 90 degrees.
ZoomSDKLOCAL_DEVICE_ROTATION_ACTION_CLOCK180	Rotation clockwise 180 degrees.
ZoomSDKLOCAL_DEVICE_ROTATION_ACTION_ANTI_CLOCK90	Rotation counter-clockwise 90 degrees.

Definition at line 1340 of file ZoomSDKErrors.h.

{
    ZoomSDKLOCAL_DEVICE_ROTATION_ACTION_UNKnown,
    ZoomSDKLOCAL_DEVICE_ROTATION_ACTION_0,
    ZoomSDKLOCAL_DEVICE_ROTATION_ACTION_CLOCK90,
    ZoomSDKLOCAL_DEVICE_ROTATION_ACTION_CLOCK180,
    ZoomSDKLOCAL_DEVICE_ROTATION_ACTION_ANTI_CLOCK90
}ZoomSDKLocalVideoDeviceRotation;

◆ ZoomSDKLoginFailReason

enum ZoomSDKLoginFailReason

Enumeration of the login failure reasons.

Enumerator
ZoomSDKLoginFailReason_None	No login failure reason (success case).
ZoomSDKLoginFailReason_EmailLoginDisabled	Login failed: email login is disabled for the account.
ZoomSDKLoginFailReason_UserNotExist	Login failed: the user does not exist.
ZoomSDKLoginFailReason_WrongPassword	Login failed: the password is incorrect.
ZoomSDKLoginFailReason_AccountLocked	Login failed: the account is locked.
ZoomSDKLoginFailReason_SDKNeedUpdate	Login failed: the SDK needs to be updated to the new version.
ZoomSDKLoginFailReason_TooManyFailedAttempts	Login failed: too many failed login attempts.
ZoomSDKLoginFailReason_SMSCodeError	Login failed: the entered SMS code is incorrect.
ZoomSDKLoginFailReason_SMSCodeExpired	Login failed: the SMS code has expired.
ZoomSDKLoginFailReason_PhoneNumberFormatInValid	Login failed: the phone number format is invalid.
ZoomSDKLoginFailReason_LoginTokenInvalid	Login failed: the login token is invalid or expired.
ZoomSDKLoginFailReason_UserDisagreeLoginDisclaimer	Login failed: the user disagreed with the login disclaimer.
ZoomSDKLoginFailReason_MFARequired	Login failed: multi-factor authentication (MFA) is required.
ZoomSDKLoginFailReason_NeedBirthdayAsk	Login failed: requires the user to provide their birthday.
ZoomSDKLoginFailReason_Other_Issue	Login failed due to other unspecified reasons.

Definition at line 1653 of file ZoomSDKErrors.h.

{
    ZoomSDKLoginFailReason_None = 0,
    ZoomSDKLoginFailReason_EmailLoginDisabled,
    ZoomSDKLoginFailReason_UserNotExist,
    ZoomSDKLoginFailReason_WrongPassword,
    ZoomSDKLoginFailReason_AccountLocked,
    ZoomSDKLoginFailReason_SDKNeedUpdate,
    ZoomSDKLoginFailReason_TooManyFailedAttempts,
    ZoomSDKLoginFailReason_SMSCodeError,
    ZoomSDKLoginFailReason_SMSCodeExpired,
    ZoomSDKLoginFailReason_PhoneNumberFormatInValid,
    ZoomSDKLoginFailReason_LoginTokenInvalid,
    ZoomSDKLoginFailReason_UserDisagreeLoginDisclaimer,
    ZoomSDKLoginFailReason_MFARequired,
    ZoomSDKLoginFailReason_NeedBirthdayAsk,
    ZoomSDKLoginFailReason_Other_Issue = 100
}ZoomSDKLoginFailReason;

◆ ZoomSDKLoginStatus

enum ZoomSDKLoginStatus

Enumeration of ZOOM SDK login status.

Enumerator
ZoomSDKLoginStatus_Idle	User does not login.
ZoomSDKLoginStatus_Success	Login successfully.
ZoomSDKLoginStatus_Failed	Login failed.
ZoomSDKLoginStatus_Processing	Login in progress.

Definition at line 435 of file ZoomSDKErrors.h.

             {
    ZoomSDKLoginStatus_Idle = 0,
    ZoomSDKLoginStatus_Success = 1,
    ZoomSDKLoginStatus_Failed = 2,
    ZoomSDKLoginStatus_Processing = 3
}ZoomSDKLoginStatus;

◆ ZoomSDKMeetingError

enum ZoomSDKMeetingError

Enumeration of errors to start/join meeting.

Enumerator
ZoomSDKMeetingError_Success	Start/Join meeting successfully.
ZoomSDKMeetingError_ConnectionError	The connection with the backend service has errors.
ZoomSDKMeetingError_ReconnectFailed	Failed to reconnect the meeting.
ZoomSDKMeetingError_MMRError	MMR issue, please check MMR configuration.
ZoomSDKMeetingError_PasswordError	The meeting password is incorrect.
ZoomSDKMeetingError_SessionError	Failed to create video and audio data connection with MMR.
ZoomSDKMeetingError_MeetingOver	Meeting is over.
ZoomSDKMeetingError_MeetingNotStart	Meeting is not started.
ZoomSDKMeetingError_MeetingNotExist	The meeting does not exist.
ZoomSDKMeetingError_UserFull	The number of participants exceeds the upper limit. For users that can't join the meeting, they can go to watch the live stream with the interface ZoomSDKMeetingServiceDelegate::onMeetingFullToWatchLiveStream: if the host has started.
ZoomSDKMeetingError_ClientIncompatible	The ZOOM SDK version is incompatible.
ZoomSDKMeetingError_NoMMR	No MMR is valid.
ZoomSDKMeetingError_MeetingLocked	The meeting is locked by the host.
ZoomSDKMeetingError_MeetingRestricted	The meeting is restricted.
ZoomSDKMeetingError_MeetingJBHRestricted	The meeting is restricted to join before host.
ZoomSDKMeetingError_EmitWebRequestFailed	Failed to request the web server.
ZoomSDKMeetingError_StartTokenExpired	Failed to start meeting with expired token.
ZoomSDKMeetingError_VideoSessionError	The user's video does not work.
ZoomSDKMeetingError_AudioAutoStartError	The user's audio cannot auto-start.
ZoomSDKMeetingError_RegisterWebinarFull	The amount of webinar attendees reaches the upper limit.
ZoomSDKMeetingError_RegisterWebinarHostRegister	User needs to register a webinar account if he wants to start a webinar.
ZoomSDKMeetingError_RegisterWebinarPanelistRegister	User needs to register an account if he wants to join the webinar by the link.
ZoomSDKMeetingError_RegisterWebinarDeniedEmail	The host has denied your webinar registration.
ZoomSDKMeetingError_RegisterWebinarEnforceLogin	Sign in with the specified account to join webinar.
ZoomSDKMeetingError_ZCCertificateChanged	The certificate of ZC has been changed.
ZoomSDKMeetingError_vanityNotExist	Vanity conference ID does not exist.
ZoomSDKMeetingError_joinWebinarWithSameEmail	Join webinar with the same email.
ZoomSDKMeetingError_disallowHostMeeting	Meeting settings is not allowed to start a meeting.
ZoomSDKMeetingError_ConfigFileWriteFailed	Failed to write configure file.
ZoomSDKMeetingError_forbidToJoinInternalMeeting	Forbidden to join the internal meeting.
ZoomSDKMeetingError_RemovedByHost	User is removed from meeting by host.
ZoomSDKMeetingError_HostDisallowOutsideUserJoin	Host disallow outside user join.
ZoomSDKMeetingError_UnableToJoinExternalMeeting	To join a meeting hosted by an external Zoom account, your SDK app has to be published on Zoom Marketplace. You can refer to Section 6.1 of Zoom's API License Terms of Use.
ZoomSDKMeetingError_BlockedByAccountAdmin	Join failed because this Meeting SDK key is blocked by the host’s account admin.
ZoomSDKMeetingError_NeedSigninForPrivateMeeting	Need sign in using the same account as the meeting organizer.
ZoomSDKMeetingError_NeedConfirmPlink	Join meeting param vanityID is duplicated and needs to be confirmed. For more information about Vanity URLs, see https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0061540#multipleVanity.
ZoomSDKMeetingError_NeedInputPlink	Join meeting param vanityID does not exist in the current account. For more information about Vanity URLs, see https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0061540#multipleVanity.
ZoomSDKMeetingError_Unknown	Unknown error.
ZoomSDKMeetingError_None	No error.
ZoomSDKMeetingError_AppPrivilegeTokenError	App privilege token error.
ZoomSDKMeetingError_AuthorizedUserNotInMeeting	Authorized user not in meeting.
ZoomSDKMeetingError_OnBehalfTokenConflictLoginError	On-behalf token error: conflict with login credentials.
ZoomSDKMeetingError_UserLevelTokenNotHaveHostZakObf	User level privilege token not have host zak/obf.
ZoomSDKMeetingError_AppCanNotAnonymousJoinMeeting	App can not anonymous join meeting.
ZoomSDKMeetingError_OnBehalfTokenInvalid	On-behalf token invalid.
ZoomSDKMeetingError_OnBehalfTokenNotMatchMeeting	On-behalf token meeting number not match.
ZoomSDKMeetingError_JmakUserEmailNotMatch	Jmak user email not match.

Definition at line 331 of file ZoomSDKErrors.h.

             {
    ZoomSDKMeetingError_Success                         = 0,
    ZoomSDKMeetingError_ConnectionError                 = 1,
    ZoomSDKMeetingError_ReconnectFailed                 = 2,
    ZoomSDKMeetingError_MMRError                        = 3,
    ZoomSDKMeetingError_PasswordError                   = 4,
    ZoomSDKMeetingError_SessionError                    = 5,
    ZoomSDKMeetingError_MeetingOver                     = 6,
    ZoomSDKMeetingError_MeetingNotStart                 = 7,
    ZoomSDKMeetingError_MeetingNotExist                 = 8,
    ZoomSDKMeetingError_UserFull                        = 9,
    ZoomSDKMeetingError_ClientIncompatible              = 10,
    ZoomSDKMeetingError_NoMMR                           = 11,
    ZoomSDKMeetingError_MeetingLocked                   = 12,
    ZoomSDKMeetingError_MeetingRestricted               = 13,
    ZoomSDKMeetingError_MeetingJBHRestricted            = 14,
    ZoomSDKMeetingError_EmitWebRequestFailed            = 15,
    ZoomSDKMeetingError_StartTokenExpired               = 16,
    ZoomSDKMeetingError_VideoSessionError               = 17,
    ZoomSDKMeetingError_AudioAutoStartError             = 18,
    ZoomSDKMeetingError_RegisterWebinarFull             = 19,
    ZoomSDKMeetingError_RegisterWebinarHostRegister     = 20,
    ZoomSDKMeetingError_RegisterWebinarPanelistRegister = 21,
    ZoomSDKMeetingError_RegisterWebinarDeniedEmail      = 22,
    ZoomSDKMeetingError_RegisterWebinarEnforceLogin     = 23,
    ZoomSDKMeetingError_ZCCertificateChanged            = 24,
    ZoomSDKMeetingError_vanityNotExist                  = 27,
    ZoomSDKMeetingError_joinWebinarWithSameEmail        = 28,
    ZoomSDKMeetingError_disallowHostMeeting             = 29,
    ZoomSDKMeetingError_ConfigFileWriteFailed           = 50,
    ZoomSDKMeetingError_forbidToJoinInternalMeeting     = 60,
    ZoomSDKMeetingError_RemovedByHost                   = 61,
    ZoomSDKMeetingError_HostDisallowOutsideUserJoin     = 62,
    ZoomSDKMeetingError_UnableToJoinExternalMeeting     = 63,
    ZoomSDKMeetingError_BlockedByAccountAdmin           = 64,
    ZoomSDKMeetingError_NeedSigninForPrivateMeeting     = 82,
    ZoomSDKMeetingError_NeedConfirmPlink                = 88,
    ZoomSDKMeetingError_NeedInputPlink                  = 89,
    ZoomSDKMeetingError_Unknown                         = 100,
    ZoomSDKMeetingError_None                            = 101,
    ZoomSDKMeetingError_AppPrivilegeTokenError          = 500,
    ZoomSDKMeetingError_AuthorizedUserNotInMeeting      = 501,
    ZoomSDKMeetingError_OnBehalfTokenConflictLoginError = 502,
    ZoomSDKMeetingError_UserLevelTokenNotHaveHostZakObf = 503,
    ZoomSDKMeetingError_AppCanNotAnonymousJoinMeeting  = 504,
    ZoomSDKMeetingError_OnBehalfTokenInvalid                = 505,
    ZoomSDKMeetingError_OnBehalfTokenNotMatchMeeting         = 506,
    ZoomSDKMeetingError_JmakUserEmailNotMatch           = 1143
}ZoomSDKMeetingError;

◆ ZoomSDKMeetingFeatureEnableOption

enum ZoomSDKMeetingFeatureEnableOption

Enumeration of options to enable a specific meeting feature.

Enumerator
ZoomSDKMeetingFeatureEnableOption_None	Do not enable.
ZoomSDKMeetingFeatureEnableOption_Once	Enable the feature for the current meeting only.
ZoomSDKMeetingFeatureEnableOption_Always	Enable the feature for the current and all future meetings.

Definition at line 2386 of file ZoomSDKErrors.h.

{
    ZoomSDKMeetingFeatureEnableOption_None,
    ZoomSDKMeetingFeatureEnableOption_Once,
    ZoomSDKMeetingFeatureEnableOption_Always
}ZoomSDKMeetingFeatureEnableOption;

◆ ZoomSDKMeetingStatus

enum ZoomSDKMeetingStatus

Enumeration of meeting status.

Enumerator
ZoomSDKMeetingStatus_Idle	No meeting is running.
ZoomSDKMeetingStatus_Connecting	Connecting to the meeting server.
ZoomSDKMeetingStatus_WaitingForHost	Waiting for the host to start the meeting.
ZoomSDKMeetingStatus_InMeeting	Meeting is ready, in meeting status.
ZoomSDKMeetingStatus_Disconnecting	Disconnect the meeting server, leave meeting status.
ZoomSDKMeetingStatus_Reconnecting	Reconnecting meeting server status.
ZoomSDKMeetingStatus_Failed	Join/Start meeting failed.
ZoomSDKMeetingStatus_Ended	Meeting ends.
ZoomSDKMeetingStatus_AudioReady	Audio is connected.
ZoomSDKMeetingStatus_OtherMeetingInProgress	There is another ongoing meeting on the server.
ZoomSDKMeetingStatus_InWaitingRoom	Participants who join the meeting before the start are in the waiting room.
ZoomSDKMeetingStatus_Webinar_Promote	Promote the attendees to panelist in webinar.
ZoomSDKMeetingStatus_Webinar_Depromote	Demote the attendees from the panelist.
ZoomSDKMeetingStatus_Join_Breakout_Room	Join breakout room.
ZoomSDKMeetingStatus_Leave_Breakout_Room	Leave breakout room.

Definition at line 450 of file ZoomSDKErrors.h.

             {
    ZoomSDKMeetingStatus_Idle             = 0,
    ZoomSDKMeetingStatus_Connecting       = 1,
    ZoomSDKMeetingStatus_WaitingForHost   = 2,
    ZoomSDKMeetingStatus_InMeeting        = 3,
    ZoomSDKMeetingStatus_Disconnecting    = 4,
    ZoomSDKMeetingStatus_Reconnecting     = 5,
    ZoomSDKMeetingStatus_Failed           = 6,
    ZoomSDKMeetingStatus_Ended            = 7,
    ZoomSDKMeetingStatus_AudioReady       = 8, 
    ZoomSDKMeetingStatus_OtherMeetingInProgress = 9,
    ZoomSDKMeetingStatus_InWaitingRoom      = 10,
    ZoomSDKMeetingStatus_Webinar_Promote = 12,
    ZoomSDKMeetingStatus_Webinar_Depromote = 13,
    ZoomSDKMeetingStatus_Join_Breakout_Room = 14,
    ZoomSDKMeetingStatus_Leave_Breakout_Room = 15
}ZoomSDKMeetingStatus;

◆ ZoomSDKMeetingSupportAudioType

enum ZoomSDKMeetingSupportAudioType

Enumeration of supported audio types in a Zoom meeting. This is a bitmask enumeration; multiple values can be combined using bitwise OR.

Enumerator
ZoomSDKMeetingSupportAudioType_None	No audio support.
ZoomSDKMeetingSupportAudioType_Voip	VoIP (Voice over Internet Protocol) audio supported.
ZoomSDKMeetingSupportAudioType_Telephony	Telephony (phone dial-in/out) audio supported.

Definition at line 2019 of file ZoomSDKErrors.h.

{
    ZoomSDKMeetingSupportAudioType_None = 0,
    ZoomSDKMeetingSupportAudioType_Voip = 1,
    ZoomSDKMeetingSupportAudioType_Telephony = 1 << 1
}ZoomSDKMeetingSupportAudioType;

◆ ZoomSDKNotificationServiceError

enum ZoomSDKNotificationServiceError

Enumeration of notification service error codes.

Enumerator
ZoomSDKNotificationServiceError_Success	Operation completed successfully.
ZoomSDKNotificationServiceError_Unknown	Unknown error occurred.
ZoomSDKNotificationServiceError_Internal_Error	Internal error occurred. Retry may be required.
ZoomSDKNotificationServiceError_Invalid_Token	Token is invalid.
ZoomSDKNotificationServiceError_Multi_Connect	Multiple logins detected on the same device with the same user/resource. The previous login session will receive this error.
ZoomSDKNotificationServiceError_Network_Issue	Network connection issue encountered.
ZoomSDKNotificationServiceError_Max_Duration	Connection exceeded maximum allowed duration (24 hours). Client must reconnect or log in again.

Definition at line 1934 of file ZoomSDKErrors.h.

{
    ZoomSDKNotificationServiceError_Success = 0,
    ZoomSDKNotificationServiceError_Unknown,
    ZoomSDKNotificationServiceError_Internal_Error,
    ZoomSDKNotificationServiceError_Invalid_Token,
    ZoomSDKNotificationServiceError_Multi_Connect,
    ZoomSDKNotificationServiceError_Network_Issue,
    ZoomSDKNotificationServiceError_Max_Duration
}ZoomSDKNotificationServiceError;

◆ ZoomSDKNotificationServiceStatus

enum ZoomSDKNotificationServiceStatus

Enumeration of the status of the notification service.

Enumerator
ZoomSDKNotificationServiceStatus_None	For initialization.
ZoomSDKNotificationServiceStatus_Starting	Starting.
ZoomSDKNotificationServiceStatus_Started	Started.
ZoomSDKNotificationServiceStatus_StartFailed	Failed to start.
ZoomSDKNotificationServiceStatus_Closed

Definition at line 1918 of file ZoomSDKErrors.h.

{
    ZoomSDKNotificationServiceStatus_None = 0,
    ZoomSDKNotificationServiceStatus_Starting,
    ZoomSDKNotificationServiceStatus_Started,
    ZoomSDKNotificationServiceStatus_StartFailed,
    ZoomSDKNotificationServiceStatus_Closed
}ZoomSDKNotificationServiceStatus;

◆ ZoomSDKPanelistChatPrivilege

enum ZoomSDKPanelistChatPrivilege

Enumeration of the panelist chat privilege in webinar meeting.

Enumerator
ZoomSDKPanelistChatPrivilege_PanelistOnly	Allow panelists only to chat with each other.[for webinar].
ZoomSDKPanelistChatPrivilege_All	Allow panelist to chat with everyone.[for webinar].

Definition at line 1396 of file ZoomSDKErrors.h.

{
    ZoomSDKPanelistChatPrivilege_PanelistOnly,
    ZoomSDKPanelistChatPrivilege_All
}ZoomSDKPanelistChatPrivilege;

◆ ZoomSDKPinResult

enum ZoomSDKPinResult

Enumeration of the result of a pin operation.

Enumerator
ZoomSDKPinResult_Success	Pin operation succeeded.
ZoomSDKPinResult_Fail_NotEnoughUsers	Failed to pin: not enough users in the meeting (less than 2 users).
ZoomSDKPinResult_Fail_ToMuchPinnedUsers	Failed to pin: too many users already pinned (more than 9 users).
ZoomSDKPinResult_Fail_UserCannotBePinned	Failed to pin: the user is in view-only mode, silent mode, or active mode.
ZoomSDKPinResult_Fail_VideoModeDoNotSupport	Failed to pin: the current video mode does not support pinning (other unspecified reasons).
ZoomSDKPinResult_Fail_NoPrivilegeToPin	Failed to pin: the current user has no privilege to pin another user.
ZoomSDKPinResult_Fail_MeetingDoNotSupport	Failed to pin: the meeting type (e.g., webinar or view-only meeting) does not support pinning.
ZoomSDKPinResult_Fail_TooManyUsers	Too many users in the meeting to allow pinning.
ZoomSDKPinResult_Unknown	Unknown error occurred during the pin operation.

Definition at line 1628 of file ZoomSDKErrors.h.

{
    ZoomSDKPinResult_Success = 0,
    ZoomSDKPinResult_Fail_NotEnoughUsers,
    ZoomSDKPinResult_Fail_ToMuchPinnedUsers,
    ZoomSDKPinResult_Fail_UserCannotBePinned,
    ZoomSDKPinResult_Fail_VideoModeDoNotSupport, 
    ZoomSDKPinResult_Fail_NoPrivilegeToPin,
    ZoomSDKPinResult_Fail_MeetingDoNotSupport,
    ZoomSDKPinResult_Fail_TooManyUsers,
    ZoomSDKPinResult_Unknown = 100
}ZoomSDKPinResult;

◆ ZoomSDKPreAssignBODataStatus

enum ZoomSDKPreAssignBODataStatus

Enumeration of the pre-assign breakout room data download status.

Enumerator
ZoomSDKPreAssignBODataStatus_None	Initial status, no request was sent.
ZoomSDKPreAssignBODataStatus_Downloading	Download in progress.
ZoomSDKPreAssignBODataStatus_Download_Ok	Download success.
ZoomSDKPreAssignBODataStatus_Download_Fail	Download fail.

Definition at line 2142 of file ZoomSDKErrors.h.

{
    ZoomSDKPreAssignBODataStatus_None,
    ZoomSDKPreAssignBODataStatus_Downloading,
    ZoomSDKPreAssignBODataStatus_Download_Ok,
    ZoomSDKPreAssignBODataStatus_Download_Fail
}ZoomSDKPreAssignBODataStatus;

◆ ZoomSDKPremeetingError

enum ZoomSDKPremeetingError

Enumeration of SDK pre-meeting errors.

Enumerator
ZoomSDKPremeetingError_Success	Calls SDK successfully.
ZoomSDKPremeetingError_Failed	Calls SDK failed.
ZoomSDKPremeetingError_TimeOut	Timeout.
ZoomSDKPremeetingError_Unknown	Unknown errors.

Definition at line 317 of file ZoomSDKErrors.h.

             {
    ZoomSDKPremeetingError_Success,
    ZoomSDKPremeetingError_Failed,
    ZoomSDKPremeetingError_TimeOut,
    ZoomSDKPremeetingError_Unknown = 100
}ZoomSDKPremeetingError;

◆ ZoomSDKPresenceStatus

enum ZoomSDKPresenceStatus

Enumeration of user's presence status. For more information, please visit https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0065488.

Enumerator
ZoomSDKPresenceStatus_None	For initialization.
ZoomSDKPresenceStatus_Available	User is available.
ZoomSDKPresenceStatus_UnAvailable	User is offline or not available.
ZoomSDKPresenceStatus_InMeeting	User is currently in a meeting.
ZoomSDKPresenceStatus_Busy	User is marked as busy.
ZoomSDKPresenceStatus_DoNotDisturb	User does not want to be disturbed.
ZoomSDKPresenceStatus_Away	User is away from the device.
ZoomSDKPresenceStatus_PhoneCall	User is on a phone call.
ZoomSDKPresenceStatus_Presenting	User is currently presenting content.
ZoomSDKPresenceStatus_Calendar	User is in a calendar-scheduled event.
ZoomSDKPresenceStatus_OutOfOffice	User is marked as out of office.

Definition at line 2058 of file ZoomSDKErrors.h.

{
    ZoomSDKPresenceStatus_None,
    ZoomSDKPresenceStatus_Available,
    ZoomSDKPresenceStatus_UnAvailable,
    ZoomSDKPresenceStatus_InMeeting,
    ZoomSDKPresenceStatus_Busy,
    ZoomSDKPresenceStatus_DoNotDisturb,
    ZoomSDKPresenceStatus_Away,
    ZoomSDKPresenceStatus_PhoneCall,
    ZoomSDKPresenceStatus_Presenting,
    ZoomSDKPresenceStatus_Calendar,
    ZoomSDKPresenceStatus_OutOfOffice
}ZoomSDKPresenceStatus;

◆ ZoomSDKQAConnectStatus

enum ZoomSDKQAConnectStatus

Enumeration of Q&A connection statuses.

Enumerator
QAConnectStatus_Connecting	The Q&A is connecting.
QAConnectStatus_Connected	The Q&A is connected.
QAConnectStatus_Disconnected	The Q&A is disonnected.
QAConnectStatus_Disconnect_Conflict	The Q&A disconnected due to conflict.

Definition at line 1232 of file ZoomSDKErrors.h.

             {
    QAConnectStatus_Connecting = 0,
    QAConnectStatus_Connected,
    QAConnectStatus_Disconnected,
    QAConnectStatus_Disconnect_Conflict
}ZoomSDKQAConnectStatus;

◆ ZoomSDKQAQuestionState

enum ZoomSDKQAQuestionState

Enumeration of question status.

Deprecated: This enum is deprecated and will be removed in a future release.

Enumerator
QAQuestionState_Init	The question state is init.
QAQuestionState_Sent	The question is sent.
QAQuestionState_Received	The question is received.
QAQuestionState_SendFail	The question send fail.
QAQuestionState_Sending	The question is sending.
QAQuestionState_Unknown	The question state is unknown for init.

Definition at line 1214 of file ZoomSDKErrors.h.

             {
    QAQuestionState_Init = 0,
    QAQuestionState_Sent,
    QAQuestionState_Received,
    QAQuestionState_SendFail,
    QAQuestionState_Sending,
    QAQuestionState_Unknown
}ZoomSDKQAQuestionState;

◆ ZoomSDKRawDataMemoryMode

enum ZoomSDKRawDataMemoryMode

Enumeration of memory modes for raw data handling.

Enumerator
ZoomSDKRawDataMemoryMode_Stack	Use stack memory.
ZoomSDKRawDataMemoryMode_Heap	Use heap memory.

Definition at line 1310 of file ZoomSDKErrors.h.

{
    ZoomSDKRawDataMemoryMode_Stack,
    ZoomSDKRawDataMemoryMode_Heap
}ZoomSDKRawDataMemoryMode;

◆ ZoomSDKRawDataType

enum ZoomSDKRawDataType

Enumeration of raw data types.

Enumerator
ZoomSDKRawDataType_Video	Video raw data.
ZoomSDKRawDataType_Share	Share raw data.

Definition at line 1357 of file ZoomSDKErrors.h.

{
    ZoomSDKRawDataType_Video = 1,
    ZoomSDKRawDataType_Share
}ZoomSDKRawDataType;

◆ ZoomSDKRecordingStatus

enum ZoomSDKRecordingStatus

Enumeration of Recording status.

Enumerator
ZoomSDKRecordingStatus_None	For initialization.
ZoomSDKRecordingStatus_Start	Start recording.
ZoomSDKRecordingStatus_Stop	Stop recording.
ZoomSDKRecordingStatus_DiskFull	There is no more space to store recording.
ZoomSDKRecordingStatus_Pause	Pause recording.
ZoomSDKRecordingStatus_Connecting	Connecting, only for cloud recording.
ZoomSDKRecordingStatus_Fail	Saving the recording failed.

Definition at line 594 of file ZoomSDKErrors.h.

            {
    ZoomSDKRecordingStatus_None,
    ZoomSDKRecordingStatus_Start,
    ZoomSDKRecordingStatus_Stop,
    ZoomSDKRecordingStatus_DiskFull,
    ZoomSDKRecordingStatus_Pause,
    ZoomSDKRecordingStatus_Connecting,
    ZoomSDKRecordingStatus_Fail
}ZoomSDKRecordingStatus;

◆ ZoomSDKReminderActionType

enum ZoomSDKReminderActionType

Enumeration of the reminder action type.

Enumerator
ZoomSDKReminderActionType_None	No action required.
ZoomSDKReminderActionType_NeedSignin	User needs to sign in.
ZoomSDKReminderActionType_NeedSwitchAccount	User needs to switch accounts.

Definition at line 2314 of file ZoomSDKErrors.h.

{
    ZoomSDKReminderActionType_None,
    ZoomSDKReminderActionType_NeedSignin,
    ZoomSDKReminderActionType_NeedSwitchAccount
}ZoomSDKReminderActionType;

◆ ZoomSDKReminderType

enum ZoomSDKReminderType

Enumeration of reminder types.

Enumerator
ZoomSDKReminderType_LoginRequired	Reminder type of login.
ZoomSDKReminderType_StartOrJoinMeeting	Reminder type of start or join meeting.
ZoomSDKReminderType_RecordReminder	Reminder type of record reminder.
ZoomSDKReminderType_RecordDisclaimer	Reminder type of record reminder.
ZoomSDKReminderType_LiveStreamDisclaimer	Reminder type of live stream reminder.
ZoomSDKReminderType_ArchiveDisclaimer	Reminder type of archive reminder.
ZoomSDKReminderType_WebinarAsPanelistJoin	Reminder type of join webinar as panelist.
ZoomSDKReminderType_TermsService	Reminder type of terms of service or privacy statement changed.
ZoomSDKReminderType_SmartSummaryDisclaimer	Reminder type of smart summary.
ZoomSDKReminderType_SmartSummaryEnableRequestReminder	Deprecated This enum value is deprecated and will be removed in a future release.
ZoomSDKReminderType_QueryDisclaimer	Reminder type of query disclaimer.
ZoomSDKReminderType_QueryEnableRequestReminder	Deprecated This enum value is deprecated and will be removed in a future release.
ZoomSDKReminderType_EnableSmartSummaryReminder	Deprecated This enum value is deprecated and will be removed in a future release.
ZoomSDKReminderType_WebinarAttendeePromoteReminder	Reminder type of webinar promote attendee.
ZoomSDKReminderType_JoinMeetingPrivateModeReminder	Reminder type of join meeting with private mode.
ZoomSDKReminderType_SmartRecordingEnableRequestReminder	Deprecated This enum value is deprecated and will be removed in a future release.
ZoomSDKReminderType_EnableSmartRecordingReminder	Deprecated This enum value is deprecated and will be removed in a future release.
ZoomSDKReminderType_AICompanionPlusDisclaimer	Deprecated This enum value is deprecated and will be removed in a future release.
ZoomSDKReminderType_ClosedCaptionDisclamier	Reminder type of ClosedCaption disclaimer.
ZoomSDKReminderType_MultiDisclamier	Reminder type of disclaimers combination.
ZoomSDKReminderType_JoinMeetingConnectorAsGuestReminder	Reminder type for join meeting connector with guest mode.
ZoomSDKReminderType_CommonDisclaimer	Reminder type of common disclaimer.
ZoomSDKReminderType_CustomAICompanionDisclamier	Reminder type of custom AI Companion disclaimer.
ZoomSDKReminderType_AICRestrictNotifyDisclamier	Reminder type of AI Companion restrict notify disclaimer.

Definition at line 2087 of file ZoomSDKErrors.h.

{
    ZoomSDKReminderType_LoginRequired = 0,
    ZoomSDKReminderType_StartOrJoinMeeting,
    ZoomSDKReminderType_RecordReminder,
    ZoomSDKReminderType_RecordDisclaimer,
    ZoomSDKReminderType_LiveStreamDisclaimer,
    ZoomSDKReminderType_ArchiveDisclaimer,
    ZoomSDKReminderType_WebinarAsPanelistJoin,
    ZoomSDKReminderType_TermsService,
    ZoomSDKReminderType_SmartSummaryDisclaimer,
    ZoomSDKReminderType_SmartSummaryEnableRequestReminder,
    ZoomSDKReminderType_QueryDisclaimer,
    ZoomSDKReminderType_QueryEnableRequestReminder,
    ZoomSDKReminderType_EnableSmartSummaryReminder,
    ZoomSDKReminderType_WebinarAttendeePromoteReminder,
    ZoomSDKReminderType_JoinMeetingPrivateModeReminder,
    ZoomSDKReminderType_SmartRecordingEnableRequestReminder,
    ZoomSDKReminderType_EnableSmartRecordingReminder,
    ZoomSDKReminderType_AICompanionPlusDisclaimer,
    ZoomSDKReminderType_ClosedCaptionDisclamier,
    ZoomSDKReminderType_MultiDisclamier,
    ZoomSDKReminderType_JoinMeetingConnectorAsGuestReminder,
    ZoomSDKReminderType_CommonDisclaimer,
    ZoomSDKReminderType_CustomAICompanionDisclamier,
    ZoomSDKReminderType_AICRestrictNotifyDisclamier,
}ZoomSDKReminderType;

◆ ZoomSDKRemoteControlStatus

enum ZoomSDKRemoteControlStatus

Enumeration of status of remote control.

Enumerator
ZoomSDKRemoteControlStatus_None	For initialization.
ZoomSDKRemoteControlStatus_CanRequestFromWho	Viewer can request to control the sharer remotely.
ZoomSDKRemoteControlStatus_RequestFromWho	Sharer receives the request from viewer.
ZoomSDKRemoteControlStatus_DeclineByWho	Sharer declines your request to be remote controlled.
ZoomSDKRemoteControlStatus_RemoteControlledByWho	Sharer is remote controlled by viewer.
ZoomSDKRemoteControlStatus_StartRemoteControlWho	Notify user that controller of the shared content changes.
ZoomSDKRemoteControlStatus_EndRemoteControlWho	Remote control ends.
ZoomSDKRemoteControlStatus_HasPrivilegeFromWho	Viewer gets the privilege of remote control.
ZoomSDKRemoteControlStatus_LostPrivilegeFromWho	Viewer loses the privilege of remote control.
ZoomSDKRemoteControlStatus_WhoCanControlMe	The status of remote control. I can be controlled by whom.

Definition at line 568 of file ZoomSDKErrors.h.

            {
    ZoomSDKRemoteControlStatus_None,
    ZoomSDKRemoteControlStatus_CanRequestFromWho,
    ZoomSDKRemoteControlStatus_RequestFromWho,
    ZoomSDKRemoteControlStatus_DeclineByWho,
    ZoomSDKRemoteControlStatus_RemoteControlledByWho,
    ZoomSDKRemoteControlStatus_StartRemoteControlWho,
    ZoomSDKRemoteControlStatus_EndRemoteControlWho,
    ZoomSDKRemoteControlStatus_HasPrivilegeFromWho,
    ZoomSDKRemoteControlStatus_LostPrivilegeFromWho,
    ZoomSDKRemoteControlStatus_WhoCanControlMe
}ZoomSDKRemoteControlStatus;

◆ ZoomSDKRemoteSupportStatus

enum ZoomSDKRemoteSupportStatus

Enumeration of the remote support status.

Enumerator
ZoomSDKRemoteSupportStatus_RequestDeny	Request was denied by the other user.
ZoomSDKRemoteSupportStatus_RequestGrant	Request was granted by the other user.
ZoomSDKRemoteSupportStatus_StopBySupportedUser	The user stops the remote support.
ZoomSDKRemoteSupportStatus_StopBySupporter	The supporter stops the remote support.

Definition at line 2356 of file ZoomSDKErrors.h.

{
    ZoomSDKRemoteSupportStatus_RequestDeny,
    ZoomSDKRemoteSupportStatus_RequestGrant,
    ZoomSDKRemoteSupportStatus_StopBySupportedUser,
    ZoomSDKRemoteSupportStatus_StopBySupporter
}ZoomSDKRemoteSupportStatus;

◆ ZoomSDKRemoteSupportType

enum ZoomSDKRemoteSupportType

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

Enumerator
ZoomSDKRemoteSupportType_None	For initialization.
ZoomSDKRemoteSupportType_Desktop	Remote support for desktop, allowing control over the desktop.
ZoomSDKRemoteSupportType_Application	Remote support for application, allowing control over an application window.

Definition at line 2342 of file ZoomSDKErrors.h.

{
    ZoomSDKRemoteSupportType_None,
    ZoomSDKRemoteSupportType_Desktop,
    ZoomSDKRemoteSupportType_Application
}ZoomSDKRemoteSupportType;

◆ ZoomSDKRequest4HelpResult

enum ZoomSDKRequest4HelpResult

Enumeration of attendee request for help results.

Enumerator
ZoomSDKRequest4HelpResult_Busy	Host is handling other's request with the request dialog, no chance to show dialog for this request.
ZoomSDKRequest4HelpResult_Ignore	Host click "later" button or close the request dialog directly.
ZoomSDKRequest4HelpResult_HostAlreadyInBO	Host already in your breakout meeting.
ZoomSDKRequest4HelpResult_Idle	For initialization (Host receive the help request and there is no other one currently requesting for help).

Definition at line 1296 of file ZoomSDKErrors.h.

             {
    ZoomSDKRequest4HelpResult_Busy,
    ZoomSDKRequest4HelpResult_Ignore,
    ZoomSDKRequest4HelpResult_HostAlreadyInBO,
    ZoomSDKRequest4HelpResult_Idle
}ZoomSDKRequest4HelpResult;

◆ ZoomSDKRequestLocalRecordingStatus

enum ZoomSDKRequestLocalRecordingStatus

Enumeration of the status of a local recording permission request.

Enumerator
ZoomSDKRequestLocalRecordingStatus_Granted	The request for local recording permission was granted.
ZoomSDKRequestLocalRecordingStatus_Denied	The request for local recording permission was denied.
ZoomSDKRequestLocalRecordingStatus_Timeout	The request timed out without a response.

Definition at line 1970 of file ZoomSDKErrors.h.

{
    ZoomSDKRequestLocalRecordingStatus_Granted,
    ZoomSDKRequestLocalRecordingStatus_Denied,
    ZoomSDKRequestLocalRecordingStatus_Timeout
}ZoomSDKRequestLocalRecordingStatus;

◆ ZoomSDKRequestStartCloudRecordingStatus

enum ZoomSDKRequestStartCloudRecordingStatus

Enumeration of the response status when a participant requests the host to start cloud recording.

Enumerator
ZoomSDKRequestStartCloudRecordingStatus_Granted	The host approved the cloud recording request.
ZoomSDKRequestStartCloudRecordingStatus_Denied	The host denied the cloud recording request.
ZoomSDKRequestStartCloudRecordingStatus_TimedOut	The request timed out due to no response from the host.

Definition at line 2372 of file ZoomSDKErrors.h.

{
    ZoomSDKRequestStartCloudRecordingStatus_Granted,
    ZoomSDKRequestStartCloudRecordingStatus_Denied,
    ZoomSDKRequestStartCloudRecordingStatus_TimedOut
}ZoomSDKRequestStartCloudRecordingStatus;

◆ ZoomSDKResolution

enum ZoomSDKResolution

Enumeration of video resolution options.

Enumerator
ZoomSDKResolution_90P	Resolution 90P.
ZoomSDKResolution_180P	Resolution 180P.
ZoomSDKResolution_360P	Resolution 360P.
ZoomSDKResolution_720P	Resolution 720P. (Video resolution might be 1080P based on the user's network condition and device specs).
ZoomSDKResolution_1080P	Resolution 1080P (Video resolution might be 720P based on the user's network condition and device specs).
ZoomSDKResolution_NoUse	Not used.

Definition at line 1321 of file ZoomSDKErrors.h.

{
    ZoomSDKResolution_90P,
    ZoomSDKResolution_180P,
    ZoomSDKResolution_360P,
    ZoomSDKResolution_720P,
    ZoomSDKResolution_1080P,
    ZoomSDKResolution_NoUse = 100
}ZoomSDKResolution;

◆ ZoomSDKRichTextStyle

enum ZoomSDKRichTextStyle

Enumeration of the content font style type for chat message. For more information, please visit https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0064400.

Enumerator
ZoomSDKRichTextStyle_None	Chat message content font style normal.
ZoomSDKRichTextStyle_Bold	Chat message content font style bold.
ZoomSDKRichTextStyle_Italic	Chat message content font style italic.
ZoomSDKRichTextStyle_Strikethrough	Chat message content font style strikethrough.
ZoomSDKRichTextStyle_BulletedList	Chat message content font style bulletedlist.
ZoomSDKRichTextStyle_NumberedList	Chat message content font style numberedlist.
ZoomSDKRichTextStyle_Underline	The style is under line.
ZoomSDKRichTextStyle_FontSize	The font size.
ZoomSDKRichTextStyle_FontColor	The font color.
ZoomSDKRichTextStyle_BackgroundColor	Chat message content background color.
ZoomSDKRichTextStyle_Indent	Chat message content font style indent.
ZoomSDKRichTextStyle_Paragraph	Chat message content font style paragraph.
ZoomSDKRichTextStyle_Quote	Chat message content font style quote.
ZoomSDKRichTextStyle_InsertLink	Chat message content font style insert link.

Definition at line 2239 of file ZoomSDKErrors.h.

{
    ZoomSDKRichTextStyle_None,
    ZoomSDKRichTextStyle_Bold,
    ZoomSDKRichTextStyle_Italic,
    ZoomSDKRichTextStyle_Strikethrough,
    ZoomSDKRichTextStyle_BulletedList,
    ZoomSDKRichTextStyle_NumberedList,
    ZoomSDKRichTextStyle_Underline,
    ZoomSDKRichTextStyle_FontSize,
    ZoomSDKRichTextStyle_FontColor,
    ZoomSDKRichTextStyle_BackgroundColor,
    ZoomSDKRichTextStyle_Indent,
    ZoomSDKRichTextStyle_Paragraph,
    ZoomSDKRichTextStyle_Quote,
    ZoomSDKRichTextStyle_InsertLink
}ZoomSDKRichTextStyle;

◆ ZoomSDKScreenCaptureMode

enum ZoomSDKScreenCaptureMode

Enumeration of the mode for screen capture. For more information, please visit https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0063824.

Enumerator
ZoomSDKScreenCaptureMode_Auto	Automatically choose the best method to use for screen share.
ZoomSDKScreenCaptureMode_Legacy	This mode can be applicable if you are not on the latest operating systems, or don't have certain video drivers. If this option isn't enabled, a blank screen may appear on participants' screens while the host shares their screen.
ZoomSDKScreenCaptureMode_GPU_Copy_Filter	This mode will share your screen without showing windows from the app.
ZoomSDKScreenCaptureMode_ADA_Copy_Filter	This mode will share your screen, include motion detection (when you move a window or play a movie), and will not show windows from the app.
ZoomSDKScreenCaptureMode_ADA_Copy_Without_Filter	This mode will share your screen, include motion detection (when you move a window or play a movie), and will show windows from the app.

Definition at line 1443 of file ZoomSDKErrors.h.

{
    ZoomSDKScreenCaptureMode_Auto,
    ZoomSDKScreenCaptureMode_Legacy,
    ZoomSDKScreenCaptureMode_GPU_Copy_Filter,
    ZoomSDKScreenCaptureMode_ADA_Copy_Filter,
    ZoomSDKScreenCaptureMode_ADA_Copy_Without_Filter
}ZoomSDKScreenCaptureMode;

◆ ZoomSDKSettingPageURL

enum ZoomSDKSettingPageURL

Enumeration of setting page URLs.

Enumerator
ZoomSDKSettingPageURL_General_ViewMoreSetting	Deprecated This enum value is deprecated and will be removed in a future release.
ZoomSDKSettingPageURL_Audio_LearnMore	URL for the "Learn More" link on the Audio settings page.
ZoomSDKSettingPageURL_VB_LearnMore	URL for the "Learn More" link on the Virtual Background (VB) settings page.
ZoomSDKSettingPageURL_ShareScreen_LearnMore	URL for the "Learn More" link on the Share Screen settings page.

Definition at line 1690 of file ZoomSDKErrors.h.

            {
    ZoomSDKSettingPageURL_General_ViewMoreSetting,
    ZoomSDKSettingPageURL_Audio_LearnMore,
    ZoomSDKSettingPageURL_VB_LearnMore,
    ZoomSDKSettingPageURL_ShareScreen_LearnMore
} ZoomSDKSettingPageURL;

◆ ZoomSDKSettingShareScreenShareOption

enum ZoomSDKSettingShareScreenShareOption

Enumeration of screen sharing options when setting the page share screen item. For more information, please visit https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0060612.

Enumerator
ZoomSDKSettingShareScreenShareOption_IndividualWindow	Share individual Window. Only for set share application.
ZoomSDKSettingShareScreenShareOption_AllWindowFromApplication	Share all window from a specific application. Only for set share application.
ZoomSDKSettingShareScreenShareOption_AutoShareDesktop	Automatically share desktop. Applicable for meeting share or direct share.
ZoomSDKSettingShareScreenShareOption_AllOption	Show all sharing options. Applicable for meeting share or direct share.

Definition at line 1590 of file ZoomSDKErrors.h.

{
    ZoomSDKSettingShareScreenShareOption_IndividualWindow,
    ZoomSDKSettingShareScreenShareOption_AllWindowFromApplication,
    ZoomSDKSettingShareScreenShareOption_AutoShareDesktop,
    ZoomSDKSettingShareScreenShareOption_AllOption
}ZoomSDKSettingShareScreenShareOption;

◆ ZoomSDKSettingVBVideoError

enum ZoomSDKSettingVBVideoError

Enumeration of virtual background video errors.

Enumerator
ZoomSDKSettingVBVideoError_None
ZoomSDKSettingVBVideoError_UnknownFormat	Unsupported or unrecognized video format.
ZoomSDKSettingVBVideoError_ResolutionBig	Video resolution is too large to be used as a virtual background.
ZoomSDKSettingVBVideoError_ResolutionHigh720P	Video resolution exceeds 720p.
ZoomSDKSettingVBVideoError_ResolutionLow	Video resolution is too low for virtual background requirements.
ZoomSDKSettingVBVideoError_PlayError	Error occurred while trying to play the video.
ZoomSDKSettingVBVideoError_OpenError	Failed to open the video file.

Definition at line 1473 of file ZoomSDKErrors.h.

{
    ZoomSDKSettingVBVideoError_None = 0,
    ZoomSDKSettingVBVideoError_UnknownFormat,
    ZoomSDKSettingVBVideoError_ResolutionBig,
    ZoomSDKSettingVBVideoError_ResolutionHigh720P,
    ZoomSDKSettingVBVideoError_ResolutionLow,
    ZoomSDKSettingVBVideoError_PlayError,
    ZoomSDKSettingVBVideoError_OpenError
}ZoomSDKSettingVBVideoError;

◆ ZoomSDKSettingVideoLightAdaptionModel

enum ZoomSDKSettingVideoLightAdaptionModel

Enumeration of video light adjustment modes. For more information, please visit https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0060612.

Enumerator
ZoomSDKSettingVideoLightAdaptionModel_None	Light adaption is none.
ZoomSDKSettingVideoLightAdaptionModel_Auto	Light adjustment is performed automatically based on current lighting conditions.
ZoomSDKSettingVideoLightAdaptionModel_Manual	Light adjustment is controlled manually.

Definition at line 1460 of file ZoomSDKErrors.h.

{
    ZoomSDKSettingVideoLightAdaptionModel_None,
    ZoomSDKSettingVideoLightAdaptionModel_Auto,
    ZoomSDKSettingVideoLightAdaptionModel_Manual
}ZoomSDKSettingVideoLightAdaptionModel;

◆ ZoomSDKShareContentType

enum ZoomSDKShareContentType

Enumeration of types of shared content.

Enumerator
ZoomSDKShareContentType_UNKNOWN	Type unknown.
ZoomSDKShareContentType_AS	Type of sharing the application.
ZoomSDKShareContentType_DS	Type of sharing the desktop.
ZoomSDKShareContentType_WB	Type of sharing the white-board.
ZoomSDKShareContentType_AIRHOST	Type of sharing data from the device connected WIFI.
ZoomSDKShareContentType_CAMERA	Type of sharing the camera.
ZoomSDKShareContentType_DATA	Type of sharing the data.
ZoomSDKShareContentType_WIRED_DEVICE	Wired device, connect Mac and iPhone.
ZoomSDKShareContentType_FRAME	Share a portion of screen in the frame.
ZoomSDKShareContentType_DOCUMENT	Share a document.
ZoomSDKShareContentType_COMPUTER_AUDIO	Share only the audio sound of computer.
ZoomSDKShareContentType_VIDEO_FILE	Type of sharing video file.

Definition at line 814 of file ZoomSDKErrors.h.

{
    ZoomSDKShareContentType_UNKNOWN,
    ZoomSDKShareContentType_AS,
    ZoomSDKShareContentType_DS,
    ZoomSDKShareContentType_WB,
    ZoomSDKShareContentType_AIRHOST,
    ZoomSDKShareContentType_CAMERA,
    ZoomSDKShareContentType_DATA,
    ZoomSDKShareContentType_WIRED_DEVICE,
    ZoomSDKShareContentType_FRAME,
    ZoomSDKShareContentType_DOCUMENT,
    ZoomSDKShareContentType_COMPUTER_AUDIO,
    ZoomSDKShareContentType_VIDEO_FILE
}ZoomSDKShareContentType;

◆ ZoomSDKShareSettingType

enum ZoomSDKShareSettingType

Enumeration of sharing types.

Enumerator
ShareSettingType_OnlyHostCanGrab	Anyone can share, but only one can share at a moment, and only the host can start sharing when another user is sharing. The previous share will be ended once the host grabs the sharing. For more information, please visit https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0058730#h_01GCCD82NKKECQ6QJNH6F4CTWA.
ShareSettingType_OnlyHostCanShare	Only host can share.
ShareSettingType_AnyoneCanGrab	Only one participant can share at a time. And anyone can start sharing when someone else is sharing.
ShareSettingType_MultiShare	Multi participant can share at a moment.
ShareSettingType_None

Definition at line 1172 of file ZoomSDKErrors.h.

            {
    ShareSettingType_OnlyHostCanGrab = 0,
    ShareSettingType_OnlyHostCanShare = 1,
    ShareSettingType_AnyoneCanGrab = 2,
    ShareSettingType_MultiShare = 3,
    ShareSettingType_None = 4
}ZoomSDKShareSettingType;

◆ ZoomSDKShareStatus

enum ZoomSDKShareStatus

Enumeration of sharing status.

Enumerator
ZoomSDKShareStatus_None	For initialization.
ZoomSDKShareStatus_SelfBegin	The current user begins the share.
ZoomSDKShareStatus_SelfEnd	The current user ends the share.
ZoomSDKShareStatus_OtherBegin	Other user begins the share.
ZoomSDKShareStatus_OtherEnd	Other user ends the share.
ZoomSDKShareStatus_ViewOther	The current user is viewing the share by others.
ZoomSDKShareStatus_Pause	The share is paused.
ZoomSDKShareStatus_Resume	The share is resumed.
ZoomSDKShareStatus_ContentTypeChange	Deprecated This enum value is deprecated and will be removed in a future release.
ZoomSDKShareStatus_SelfStartAudioShare	The current user begins to share the sounds of computer audio.
ZoomSDKShareStatus_SelfStopAudioShare	The current user stops sharing the sounds of computer audio.
ZoomSDKShareStatus_OtherStartAudioShare	Other user begins to share the sounds of computer audio.
ZoomSDKShareStatus_OtherStopAudioShare	Other user stops sharing the sounds of computer audio.
ZoomSDKShareStatus_Disconnected	The share is disconnected.

Definition at line 486 of file ZoomSDKErrors.h.

            {
    ZoomSDKShareStatus_None,
    ZoomSDKShareStatus_SelfBegin,
    ZoomSDKShareStatus_SelfEnd,
    ZoomSDKShareStatus_OtherBegin,
    ZoomSDKShareStatus_OtherEnd,
    ZoomSDKShareStatus_ViewOther,
    ZoomSDKShareStatus_Pause,
    ZoomSDKShareStatus_Resume,
    ZoomSDKShareStatus_ContentTypeChange,
    ZoomSDKShareStatus_SelfStartAudioShare,
    ZoomSDKShareStatus_SelfStopAudioShare,
    ZoomSDKShareStatus_OtherStartAudioShare,
    ZoomSDKShareStatus_OtherStopAudioShare,
    ZoomSDKShareStatus_Disconnected
}ZoomSDKShareStatus;

◆ ZoomSDKShareViewZoomRatio

enum ZoomSDKShareViewZoomRatio

Enumeration of zoom ratios of the shared content view.

Enumerator
ZoomSDKShareViewZoomRatio_50	Zoom ratio set to 50%.
ZoomSDKShareViewZoomRatio_100	Zoom ratio set to 100% (actual size).
ZoomSDKShareViewZoomRatio_150	Zoom ratio set to 150%.
ZoomSDKShareViewZoomRatio_200	Zoom ratio set to 200%.
ZoomSDKShareViewZoomRatio_300	Zoom ratio set to 300%.

Definition at line 1834 of file ZoomSDKErrors.h.

{
    ZoomSDKShareViewZoomRatio_50 = 0,
    ZoomSDKShareViewZoomRatio_100,
    ZoomSDKShareViewZoomRatio_150,
    ZoomSDKShareViewZoomRatio_200,
    ZoomSDKShareViewZoomRatio_300
}ZoomSDKShareViewZoomRatio;

◆ ZoomSDKSignInterpretationStatus

enum ZoomSDKSignInterpretationStatus

Enumeration of the status of sign language interpretation.

Enumerator
ZoomSDKSignInterpretationStatus_Initial	The initial status.
ZoomSDKSignInterpretationStatus_Started	Sign language interpretation has started.
ZoomSDKSignInterpretationStatus_Stopped	Sign language interpretation has been stopped.

Definition at line 1905 of file ZoomSDKErrors.h.

{
    ZoomSDKSignInterpretationStatus_Initial,
    ZoomSDKSignInterpretationStatus_Started,
    ZoomSDKSignInterpretationStatus_Stopped
}ZoomSDKSignInterpretationStatus;

◆ ZoomSDKSpotlightResult

enum ZoomSDKSpotlightResult

Enumeration of the spotlight operation result.

Enumerator
ZoomSDKSpotlightResult_Success	Spotlight operation succeeded.
ZoomSDKSpotlightResult_Fail_NotEnoughUsers	Failed to spotlight: not enough users in the meeting (less than 2 users).
ZoomSDKSpotlightResult_Fail_ToMuchSpotlightedUsers	Failed to spotlight: too many users already spotlighted (more than 9 users).
ZoomSDKSpotlightResult_Fail_UserCannotBeSpotlighted	Failed to spotlight: the user is in view-only mode, silent mode, or currently active in some other capacity.
ZoomSDKSpotlightResult_Fail_UserWithoutVideo	Failed to spotlight: the user has not turned on their video.
ZoomSDKSpotlightResult_Fail_NoPrivilegeToSpotlight	Failed to spotlight: the current user has no privilege to spotlight another user.
ZoomSDKSpotlightResult_Fail_UserNotSpotlighted	Failed to spotlight: the user was not successfully spotlighted.
ZoomSDKSpotlightResult_Unknown	Unknown error occurred during the spotlight operation.

Definition at line 1605 of file ZoomSDKErrors.h.

{
    ZoomSDKSpotlightResult_Success = 0,
    ZoomSDKSpotlightResult_Fail_NotEnoughUsers,
    ZoomSDKSpotlightResult_Fail_ToMuchSpotlightedUsers,
    ZoomSDKSpotlightResult_Fail_UserCannotBeSpotlighted,
    ZoomSDKSpotlightResult_Fail_UserWithoutVideo,
    ZoomSDKSpotlightResult_Fail_NoPrivilegeToSpotlight,
    ZoomSDKSpotlightResult_Fail_UserNotSpotlighted,
    ZoomSDKSpotlightResult_Unknown = 100
}ZoomSDKSpotlightResult;

◆ ZoomSDKSuppressBackgroundNoiseLevel

enum ZoomSDKSuppressBackgroundNoiseLevel

Enumeration of background noise suppression levels. For more information, please visit https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0059985.

Enumerator
ZoomSDKSuppressBackgroundNoiseLevel_None	For initialize.
ZoomSDKSuppressBackgroundNoiseLevel_Auto	Automatically adjust noise suppression.
ZoomSDKSuppressBackgroundNoiseLevel_Low	Low level suppression. Allows faint background.
ZoomSDKSuppressBackgroundNoiseLevel_Medium	Medium level suppression. Filters out moderate noise like computer fan or desk taps.
ZoomSDKSuppressBackgroundNoiseLevel_High	High level suppression. Eliminates most background speech and persistent noise.

Definition at line 1426 of file ZoomSDKErrors.h.

{
    ZoomSDKSuppressBackgroundNoiseLevel_None,
    ZoomSDKSuppressBackgroundNoiseLevel_Auto,
    ZoomSDKSuppressBackgroundNoiseLevel_Low,
    ZoomSDKSuppressBackgroundNoiseLevel_Medium,
    ZoomSDKSuppressBackgroundNoiseLevel_High
}ZoomSDKSuppressBackgroundNoiseLevel;

◆ ZoomSDKTestMicStatus

enum ZoomSDKTestMicStatus

Enumeration of microphone test types.

Enumerator
testMic_Normal	Normal status.
testMic_Recording	Recording in progress.
testMic_RecrodingStopped	Recording has stopped.
testMic_Playing	Playing back the recorded audio.

Definition at line 1136 of file ZoomSDKErrors.h.

            {
    testMic_Normal = 0,
    testMic_Recording,
    testMic_RecrodingStopped,
    testMic_Playing
}ZoomSDKTestMicStatus;

◆ ZoomSDKTransferMeetingMode

enum ZoomSDKTransferMeetingMode

Enumeration of meeting transfer modes.

Enumerator
ZoomSDKTransferMeetingMode_None	For initialization.
ZoomSDKTransferMeetingMode_Transfer	Try to transfer meeting to current device.
ZoomSDKTransferMeetingMode_Companion	Try to join meeting with companion mode.If the meeting is successfully joined, both video and audio will be unavailable.

Definition at line 2552 of file ZoomSDKErrors.h.

{
    ZoomSDKTransferMeetingMode_None,
    ZoomSDKTransferMeetingMode_Transfer,
    ZoomSDKTransferMeetingMode_Companion
}ZoomSDKTransferMeetingMode;

◆ ZoomSDKUIAppearance

enum ZoomSDKUIAppearance

Enumeration of UI appearance modes.

Enumerator
ZoomSDKUIAppearance_System	Follow the system default appearance (light or dark mode).
ZoomSDKUIAppearance_Light	Force the UI to use light mode, regardless of system setting.
ZoomSDKUIAppearance_Dark	Force the UI to use dark mode, regardless of system setting.

Definition at line 1509 of file ZoomSDKErrors.h.

{
    ZoomSDKUIAppearance_System,
    ZoomSDKUIAppearance_Light,
    ZoomSDKUIAppearance_Dark
}ZoomSDKUIAppearance;

◆ ZoomSDKUITheme

enum ZoomSDKUITheme

Enumeration of available UI themes.

Enumerator
ZoomSDKUITheme_Bloom	Bloom theme.
ZoomSDKUITheme_Rose	Rose theme.
ZoomSDKUITheme_Agave	Agave theme.
ZoomSDKUITheme_Classic	Classic theme.

Definition at line 1522 of file ZoomSDKErrors.h.

{
    ZoomSDKUITheme_Bloom,
    ZoomSDKUITheme_Rose,
    ZoomSDKUITheme_Agave,
    ZoomSDKUITheme_Classic
}ZoomSDKUITheme;

◆ ZoomSDKUserType

enum ZoomSDKUserType

Enumeration of user types.

Enumerator
ZoomSDKUserType_ZoomUser	User logs in with working email.
ZoomSDKUserType_SSOUser	Single-sign-on user.
ZoomSDKUserType_WithoutLogin	Users who are not logged in.

Definition at line 15 of file ZoomSDKErrors.h.

             {
    ZoomSDKUserType_ZoomUser    = 100,
    ZoomSDKUserType_SSOUser     = 101,
    ZoomSDKUserType_WithoutLogin = 102
}ZoomSDKUserType;

◆ ZoomSDKVideoEffectType

enum ZoomSDKVideoEffectType

Enumeration of video effect types.

Enumerator
ZoomSDKVideoEffectType_None
ZoomSDKVideoEffectType_Filter	Filter effect.
ZoomSDKVideoEffectType_Frame	Decorative frame effect added around the video.
ZoomSDKVideoEffectType_CustomFilter	Custom video filter.
ZoomSDKVideoEffectType_Sticker	Fun or themed stickers overlaid on the video.

Definition at line 1493 of file ZoomSDKErrors.h.

{
    ZoomSDKVideoEffectType_None = 0,
    ZoomSDKVideoEffectType_Filter = 1,
    ZoomSDKVideoEffectType_Frame = 2,
    ZoomSDKVideoEffectType_CustomFilter = 3,
    ZoomSDKVideoEffectType_Sticker = 4
}ZoomSDKVideoEffectType;

◆ ZoomSDKVideoFileSharePlayError

enum ZoomSDKVideoFileSharePlayError

Enumeration of video file share play errors.

Enumerator
ZoomSDKVideoFileSharePlayError_None	No error.
ZoomSDKVideoFileSharePlayError_Not_Supported	Video file format not supported.
ZoomSDKVideoFileSharePlayError_Resolution_Too_High	Resolution is too high to play.
ZoomSDKVideoFileSharePlayError_Open_Fail	Failed to open the video file.
ZoomSDKVideoFileSharePlayError_Play_Fail	Failed to play the video file.
ZoomSDKVideoFileSharePlayError_Seek_Fail	Ailed to seek to the desired position in the video.

Definition at line 2207 of file ZoomSDKErrors.h.

{
    ZoomSDKVideoFileSharePlayError_None,
    ZoomSDKVideoFileSharePlayError_Not_Supported,
    ZoomSDKVideoFileSharePlayError_Resolution_Too_High,
    ZoomSDKVideoFileSharePlayError_Open_Fail,
    ZoomSDKVideoFileSharePlayError_Play_Fail,
    ZoomSDKVideoFileSharePlayError_Seek_Fail
}ZoomSDKVideoFileSharePlayError;

◆ ZoomSDKVideoPreferenceMode

enum ZoomSDKVideoPreferenceMode

Enumeration of video preference modes.

Enumerator
ZoomSDKVideoPreferenceMode_Balance	Balance (Default preference with no additional parameters needed): Zoom will do what is best under the current bandwidth situation and make adjustments as needed.
ZoomSDKVideoPreferenceMode_Sharpness	Sharpness: Prioritizes a smooth video frame transition by preserving the frame rate as much as possible.
ZoomSDKVideoPreferenceMode_Smoothness	Smoothness: Prioritizes a sharp video image by preserving the resolution as much as possible.
ZoomSDKVideoPreferenceMode_Custom	Custom: Allows customization by providing the minimum and maximum frame rate. Use this mode if you have an understanding of your network behavior and a clear idea on how to adjust the frame rate to achieve the desired video quality.

Definition at line 2536 of file ZoomSDKErrors.h.

{
    ZoomSDKVideoPreferenceMode_Balance,
    ZoomSDKVideoPreferenceMode_Sharpness,
    ZoomSDKVideoPreferenceMode_Smoothness,
    ZoomSDKVideoPreferenceMode_Custom
}ZoomSDKVideoPreferenceMode;

◆ ZoomSDKVideoQuality

enum ZoomSDKVideoQuality

Enumeration of video quality.

Enumerator
ZoomSDKVideoQuality_Unknown	Unknown video quality status.
ZoomSDKVideoQuality_Bad	The video quality is poor.
ZoomSDKVideoQuality_Normal	The video quality is normal.
ZoomSDKVideoQuality_Good	The video quality is good.

Definition at line 634 of file ZoomSDKErrors.h.

            {
    ZoomSDKVideoQuality_Unknown,
    ZoomSDKVideoQuality_Bad,
    ZoomSDKVideoQuality_Normal,
    ZoomSDKVideoQuality_Good
}ZoomSDKVideoQuality;

◆ ZoomSDKVideoRawdataColorspace

enum ZoomSDKVideoRawdataColorspace

The colorspace of video rawdata.

Enumerator
ZoomSDKVideoRawdataColorspace_BT601_L	For standard definition TV (SDTV) Y[16,235], Cb/Cr[16,240].
ZoomSDKVideoRawdataColorspace_BT601_F	For standard definition TV (SDTV) full range version: [0,255].
ZoomSDKVideoRawdataColorspace_BT709_L	For high definition TV (HDTV) Y[16,235], Cb/Cr[16,240]
ZoomSDKVideoRawdataColorspace_BT709_F	For high definition TV (HDTV) full range version: [0,255]

Definition at line 2657 of file ZoomSDKErrors.h.

{
    ZoomSDKVideoRawdataColorspace_BT601_L,
    ZoomSDKVideoRawdataColorspace_BT601_F,
    ZoomSDKVideoRawdataColorspace_BT709_L,
    ZoomSDKVideoRawdataColorspace_BT709_F
}ZoomSDKVideoRawdataColorspace;

◆ ZoomSDKVideoRenderResolution

enum ZoomSDKVideoRenderResolution

Enumeration of video render resolution.

Enumerator
ZoomSDKVideoRenderResolution_None	No resolution specified (typically used for initialization).
ZoomSDKVideoRenderResolution_90p
ZoomSDKVideoRenderResolution_180p
ZoomSDKVideoRenderResolution_360p
ZoomSDKVideoRenderResolution_720p
ZoomSDKVideoRenderResolution_1080p

Definition at line 1726 of file ZoomSDKErrors.h.

            {
    ZoomSDKVideoRenderResolution_None = 0,
    /* 90p resolution. */
    ZoomSDKVideoRenderResolution_90p,
    /* 180p resolution. */
    ZoomSDKVideoRenderResolution_180p,
    /* 360p resolution. */
    ZoomSDKVideoRenderResolution_360p,
    /* 720p resolution. */
    ZoomSDKVideoRenderResolution_720p,
    /* 1080p resolution. */
    ZoomSDKVideoRenderResolution_1080p
} ZoomSDKVideoRenderResolution;

◆ ZoomSDKVideoStatus

enum ZoomSDKVideoStatus

Enumeration of the status of a user's video.

Enumerator
ZoomSDKVideoStatus_Off	Video is turned off.
ZoomSDKVideoStatus_On	Video is turned on.
ZoomSDKVideoStatus_MutedByHost	Video is muted by the host.
ZoomSDKVideoStatus_None	Video status is unknown.

Definition at line 540 of file ZoomSDKErrors.h.

            {
    ZoomSDKVideoStatus_Off,
    ZoomSDKVideoStatus_On,
    ZoomSDKVideoStatus_MutedByHost,
    ZoomSDKVideoStatus_None
}ZoomSDKVideoStatus;

◆ ZoomSDKVideoSubscribeFailReason

enum ZoomSDKVideoSubscribeFailReason

Enumeration of the type for video subscribe failed reason.

Enumerator
ZoomSDKVideoSubscribe_Fail_None	No failure.
ZoomSDKVideoSubscribe_Fail_ViewOnly	The user is in view-only mode and cannot subscribe to video.
ZoomSDKVideoSubscribe_Fail_NotInMeeting	The user is not currently in the meeting.
ZoomSDKVideoSubscribe_Fail_HasSubscribe1080POr720P	Already subscribed to a 1080p or 720p video stream. Cannot subscribe to additional streams at that quality.
ZoomSDKVideoSubscribe_Fail_HasSubscribe720P	Already subscribed to a 720p video stream.
ZoomSDKVideoSubscribe_Fail_HasSubscribeTwo720P	Already subscribed to two 720p video streams. Maximum limit reached.
ZoomSDKVideoSubscribe_Fail_HasSubscribeExceededLimit	The number of video subscriptions has exceeded the allowed limit.
ZoomSDKVideoSubscribe_Fail_TooFrequentCall	The subscription requests were made too frequently in a short period of time.

Definition at line 1778 of file ZoomSDKErrors.h.

            {
    ZoomSDKVideoSubscribe_Fail_None = 0,
    ZoomSDKVideoSubscribe_Fail_ViewOnly,
    ZoomSDKVideoSubscribe_Fail_NotInMeeting,
    ZoomSDKVideoSubscribe_Fail_HasSubscribe1080POr720P,
    ZoomSDKVideoSubscribe_Fail_HasSubscribe720P,
    ZoomSDKVideoSubscribe_Fail_HasSubscribeTwo720P,
    ZoomSDKVideoSubscribe_Fail_HasSubscribeExceededLimit,
    ZoomSDKVideoSubscribe_Fail_TooFrequentCall
} ZoomSDKVideoSubscribeFailReason;

◆ ZoomSDKWaitingRoomLayoutType

enum ZoomSDKWaitingRoomLayoutType

Enumeration of waiting room layout type. For more information, please visit https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0059359.

Enumerator
ZoomSDKWaitingRoomLayoutType_Default	Default layout.
ZoomSDKWaitingRoomLayoutType_Logo	Layout displaying a logo.
ZoomSDKWaitingRoomLayoutType_Video	Layout displaying a video.

Definition at line 1877 of file ZoomSDKErrors.h.

{
    ZoomSDKWaitingRoomLayoutType_Default,
    ZoomSDKWaitingRoomLayoutType_Logo,
    ZoomSDKWaitingRoomLayoutType_Video
}ZoomSDKWaitingRoomLayoutType;

◆ ZoomSDKWallpaperLayoutMode

enum ZoomSDKWallpaperLayoutMode

Enumeration of wallpaper layout modes.

Enumerator
ZoomSDKWallpaperLayoutMode_None	For initialization.
ZoomSDKWallpaperLayoutMode_Fill	The wallpaper is scaled to completely fill the display area.
ZoomSDKWallpaperLayoutMode_Fit	The wallpaper is scaled to fit entirely within the display area.

Definition at line 2506 of file ZoomSDKErrors.h.

{
    ZoomSDKWallpaperLayoutMode_None,
    ZoomSDKWallpaperLayoutMode_Fill,
    ZoomSDKWallpaperLayoutMode_Fit
}ZoomSDKWallpaperLayoutMode;

◆ ZoomSDKWallpaperSettingStatus

enum ZoomSDKWallpaperSettingStatus

Enumeration of the wallpaper setting status.

Enumerator
ZoomSDKWallpaperSettingStatus_None	For initialization.
ZoomSDKWallpaperSettingStatus_Downloading	Wallpaper is currently being downloaded.
ZoomSDKWallpaperSettingStatus_Downloaded	Wallpaper was downloaded successfully.
ZoomSDKWallpaperSettingStatus_DownloadFail	Wallpaper download failed.

Definition at line 2520 of file ZoomSDKErrors.h.

{
    ZoomSDKWallpaperSettingStatus_None,
    ZoomSDKWallpaperSettingStatus_Downloading,
    ZoomSDKWallpaperSettingStatus_Downloaded,
    ZoomSDKWallpaperSettingStatus_DownloadFail
}ZoomSDKWallpaperSettingStatus;

◆ ZoomSDKWhiteboardCreateOption

enum ZoomSDKWhiteboardCreateOption

Enumeration of the whiteboard create options.

Enumerator
ZoomSDKWhiteboardCreateOption_HostOnly	Only the host can initiate a new whiteboard.
ZoomSDKWhiteboardCreateOption_AccountUsers	Users under the same account as the meeting owner can initiate a new whiteboard.
ZoomSDKWhiteboardCreateOption_All	All participants can initiate a new whiteboard.

Definition at line 2289 of file ZoomSDKErrors.h.

{
    ZoomSDKWhiteboardCreateOption_HostOnly,
    ZoomSDKWhiteboardCreateOption_AccountUsers,
    ZoomSDKWhiteboardCreateOption_All
}ZoomSDKWhiteboardCreateOption;

◆ ZoomSDKWhiteboardShareOption

enum ZoomSDKWhiteboardShareOption

Enumeration of the whiteboard share options.

Enumerator
ZoomSDKWhiteboardShareOption_HostShare	Only the host can share a whiteboard.
ZoomSDKWhiteboardShareOption_HostGrabShare	Anyone can share a whiteboard, but only one can share at a time, and only the host can take another's sharing role.
ZoomSDKWhiteboardShareOption_AllGrabShare	Anyone can share whiteboard, but one share at a time, and anyone can take another's sharing role.

Definition at line 2275 of file ZoomSDKErrors.h.

{
    ZoomSDKWhiteboardShareOption_HostShare,
    ZoomSDKWhiteboardShareOption_HostGrabShare,
    ZoomSDKWhiteboardShareOption_AllGrabShare
}ZoomSDKWhiteboardShareOption;

◆ ZoomSDKWhiteboardStatus

enum ZoomSDKWhiteboardStatus

Enumeration of the whiteboard status.

Enumerator
ZoomSDKWhiteboardStatus_Started	The user has started sharing their whiteboard.
ZoomSDKWhiteboardStatus_Stopped	The user has stopped sharing their whiteboard.

Definition at line 2303 of file ZoomSDKErrors.h.

{
    ZoomSDKWhiteboardStatus_Started,
    ZoomSDKWhiteboardStatus_Stopped
}ZoomSDKWhiteboardStatus;

Enumerations