ZMVideoSDKDef.h File Reference

This file defines the enumeration of Zoom Video SDK. More...

Go to the source code of this file.

Enumerations
enum	ZMVideoSDKErrors {   ZMVideoSDKErrors_Success = 0 , ZMVideoSDKErrors_Wrong_Usage , ZMVideoSDKErrors_Internal_Error , ZMVideoSDKErrors_Uninitialize ,   ZMVideoSDKErrors_Memory_Error , ZMVideoSDKErrors_Load_Module_Error , ZMVideoSDKErrors_UnLoad_Module_Error , ZMVideoSDKErrors_Invalid_Parameter ,   ZMVideoSDKErrors_Call_Too_Frequently , ZMVideoSDKErrors_No_Impl , ZMVideoSDKErrors_Dont_Support_Feature , ZMVideoSDKErrors_Unknown ,   ZMVideoSDKErrors_Remove_Folder_Fail , ZMVideoSDKErrors_Auth_Error = 1001 , ZMVideoSDKErrors_Auth_Empty_Key_or_Secret , ZMVideoSDKErrors_Auth_Wrong_Key_or_Secret ,   ZMVideoSDKErrors_Auth_DoesNot_Support_SDK , ZMVideoSDKErrors_Auth_Disable_SDK , ZMVideoSDKErrors_JoinSession_NoSessionName = 1500 , ZMVideoSDKErrors_JoinSession_NoSessionToken ,   ZMVideoSDKErrors_JoinSession_NoUserName , ZMVideoSDKErrors_JoinSession_Invalid_SessionName , ZMVideoSDKErrors_JoinSession_Invalid_Password , ZMVideoSDKErrors_JoinSession_Invalid_SessionToken ,   ZMVideoSDKErrors_JoinSession_SessionName_TooLong , ZMVideoSDKErrors_JoinSession_Token_MismatchedSessionName , ZMVideoSDKErrors_JoinSession_Token_NoSessionName , ZMVideoSDKErrors_JoinSession_Token_RoleType_EmptyOrWrong ,   ZMVideoSDKErrors_JoinSession_Token_UserIdentity_TooLong , ZMVideoSDKErrors_SessionModule_Not_Found = 2001 , ZMVideoSDKErrors_SessionService_Invalid , ZMVideoSDKErrors_Session_Join_Failed ,   ZMVideoSDKErrors_Session_No_Rights , ZMVideoSDKErrors_Session_Already_In_Progress , ZMVideoSDKErrors_Session_Dont_Support_SessionType , ZMVideoSDKErrors_Session_Reconnecting ,   ZMVideoSDKErrors_Session_Disconnecting , ZMVideoSDKErrors_Session_Not_Started , ZMVideoSDKErrors_Session_Need_Password , ZMVideoSDKErrors_Session_Password_Wrong ,   ZMVideoSDKErrors_Session_Remote_DB_Error , ZMVideoSDKErrors_Session_Invalid_Param , ZMVideoSDKErrors_Session_Client_Incompatible , ZMVideoSDKErrors_Session_Account_FreeMinutesExceeded ,   ZMVideoSDKErrors_Session_Account_FreeCreditExceeded , ZMVideoSDKErrors_Session_Audio_Error = 3000 , ZMVideoSDKErrors_Session_Audio_No_Microphone , ZMVideoSDKErrors_Session_Audio_No_Speaker ,   ZMVideoSDKErrors_Session_Bluetooth_SCO_Connection_Failed , ZMVideoSDKErrors_Session_Video_Error = 4000 , ZMVideoSDKErrors_Session_Video_Device_Error , ZMVideoSDKErrors_Session_Live_Stream_Error = 5000 ,   ZMVideoSDKErrors_Session_Phone_Error = 5500 , ZMVideoSDKErrors_RAWDATA_MALLOC_FAILED = 6001 , ZMVideoSDKErrors_RAWDATA_NOT_IN_Session , ZMVideoSDKErrors_RAWDATA_NO_LICENSE ,   ZMVideoSDKErrors_RAWDATA_VIDEO_MODULE_NOT_READY , ZMVideoSDKErrors_RAWDATA_VIDEO_MODULE_ERROR , ZMVideoSDKErrors_RAWDATA_VIDEO_DEVICE_ERROR , ZMVideoSDKErrors_RAWDATA_NO_VIDEO_DATA ,   ZMVideoSDKErrors_RAWDATA_SHARE_MODULE_NOT_READY , ZMVideoSDKErrors_RAWDATA_SHARE_MODULE_ERROR , ZMVideoSDKErrors_RAWDATA_NO_SHARE_DATA , ZMVideoSDKErrors_RAWDATA_AUDIO_MODULE_NOT_READY ,   ZMVideoSDKErrors_RAWDATA_AUDIO_MODULE_ERROR , ZMVideoSDKErrors_RAWDATA_NO_AUDIO_DATA , ZMVideoSDKErrors_RAWDATA_PREPROCESS_RAWDATA_ERROR , ZMVideoSDKErrors_RAWDATA_NO_DEVICE_RUNNING ,   ZMVideoSDKErrors_RAWDATA_INIT_DEVICE , ZMVideoSDKErrors_RAWDATA_VIRTUAL_DEVICE , ZMVideoSDKErrors_RAWDATA_CANNOT_CHANGE_VIRTUAL_DEVICE_IN_PREVIEW , ZMVideoSDKErrors_RAWDATA_INTERNAL_ERROR ,   ZMVideoSDKErrors_RAWDATA_SEND_TOO_MUCH_DATA_IN_SINGLE_TIME , ZMVideoSDKErrors_RAWDATA_SEND_TOO_FREQUENTLY , ZMVideoSDKErrors_RAWDATA_VIRTUAL_MIC_IS_TERMINATE , ZMVideoSDKErrors_Rawdata_Invalid_Share_Preprocessing_Data_Object ,   ZMVideoSDKErrors_Rawdata_Share_Preprocessing_Is_Stopped , ZMVideoSDKErrors_Session_Share_Error = 7001 , ZMVideoSDKErrors_Session_Share_Module_Not_Ready , ZMVideoSDKErrors_Session_Share_You_Are_Not_Sharing ,   ZMVideoSDKErrors_Session_Share_Type_Is_Not_Support , ZMVideoSDKErrors_Session_Share_Internal_Error , ZMVideoSDKErrors_Dont_Support_Multi_Stream_Video_User , ZMVideoSDKErrors_Fail_Assign_User_Privilege ,   ZMVideoSDKErrors_No_Recording_In_Process , ZMVideoSDKErrors_Recording_Is_Connecting , ZMVideoSDKErrors_Set_Virtual_Background_Fail , ZMVideoSDKErrors_Session_Share_Camera_Video_Not_Start ,   ZMVideoSDKErrors_Session_Share_Camera_Conflict_With_Video_Effects , ZMVideoSDKErrors_Session_Share_Conflict_With_Whiteboard , ZMVideoSDKErrors_Filetransfer_UnknowError = 7500 , ZMVideoSDKErrors_Filetransfer_FileTypeBlocked ,   ZMVideoSDKErrors_Filetransfer_FileSizelimited , ZMVideoSDKErrors_Spotlight_NotEnoughUsers = 7600 , ZMVideoSDKErrors_Spotlight_ToMuchSpotlightedUsers , ZMVideoSDKErrors_Spotlight_UserCannotBeSpotlighted ,   ZMVideoSDKErrors_Spotlight_UserWithoutVideo , ZMVideoSDKErrors_Spotlight_UserNotSpotlighted }
	Enumerates all errors in the VideoSDK. More...
enum	ZMVideoSDKShareStatus {   ZMVideoSDKShareStatus_None , ZMVideoSDKShareStatus_Start , ZMVideoSDKShareStatus_Pause , ZMVideoSDKShareStatus_Resume ,   ZMVideoSDKShareStatus_Stop }
	Enumerates the status of sharing. More...
enum	ZMVideoSDKLiveStreamStatus {   ZMVideoSDKLiveStreamStatus_None , ZMVideoSDKLiveStreamStatus_InProgress , ZMVideoSDKLiveStreamStatus_Connecting , ZMVideoSDKLiveStreamStatus_FailedTimeout ,   ZMVideoSDKLiveStreamStatus_StartFailed , ZMVideoSDKLiveStreamStatus_Ended }
	Enumerates the statuses of live streaming. More...
enum	ZMVideoSDKRawDataType { ZMVideoSDKRawDataType_Video = 0 , ZMVideoSDKRawDataType_Share }
	Enumeration of raw data types. More...
enum	ZMVideoSDKResolution {   ZMVideoSDKResolution_90P = 0 , ZMVideoSDKResolution_180P , ZMVideoSDKResolution_360P , ZMVideoSDKResolution_720P ,   ZMVideoSDKResolution_1080P , ZMVideoSDKResolution_Auto = 100 }
	Enumeration of render resolution. More...
enum	ZMVideoSDKRawDataMemoryMode { ZMVideoSDKRawDataMemoryMode_Stack , ZMVideoSDKRawDataMemoryMode_Heap }
	Enumeration of memory modes for raw data handling. More...
enum	ZMVideoSDKRawDataStatus { ZMVideoSDKRawData_On , ZMVideoSDKRawData_Off }
	Enumeration the statuses of raw data. More...
enum	ZMVideoSDKAudioType { ZMVideoSDKAudioType_VOIP , ZMVideoSDKAudioType_TELEPHONY , ZMVideoSDKAudioType_None }
	Enumerates the types of audio. More...
enum	ZMVideoRotation { ZMVideoRotation_0 , ZMVideoRotation_90 , ZMVideoRotation_180 , ZMVideoRotation_270 }
	Enumerates the video rotation angles. More...
enum	ZMVideoSDKVideoPreferenceMode { ZMVideoSDKVideoPreferenceMode_Balance , ZMVideoSDKVideoPreferenceMode_Sharpness , ZMVideoSDKVideoPreferenceMode_Smoothness , ZMVideoSDKVideoPreferenceMode_Custom }
	Enumerates the video preference modes. More...
enum	ZMRecordingStatus {   ZMRecording_Start , ZMRecording_Stop , ZMRecording_DiskFull , ZMRecording_Pause ,   ZMRecording_Connecting }
	Enumerates the statuses of recording. More...
enum	ZMVideoSDKCameraControlRequestType { ZMVideoSDKCameraControlRequestType_RequestControl = 0 , ZMVideoSDKCameraControlRequestType_GiveUpControl }
	Enumerates the types of remote camera control requests. More...
enum	ZMPhoneStatus {   ZMPhoneStatus_None , ZMPhoneStatus_Calling , ZMPhoneStatus_Ringing , ZMPhoneStatus_Accepted ,   ZMPhoneStatus_Success , ZMPhoneStatus_Failed , ZMPhoneStatus_Canceling , ZMPhoneStatus_Canceled ,   ZMPhoneStatus_Cancel_Failed , ZMPhoneStatus_Timeout }
	Enumerates the statuses of a phone call. More...
enum	ZMPhoneFailedReason {   ZMPhoneFailedReason_None , ZMPhoneFailedReason_Busy , ZMPhoneFailedReason_Not_Available , ZMPhoneFailedReason_User_Hangup ,   ZMPhoneFailedReason_Other_Fail , ZMPhoneFailedReason_No_Answer , ZMPhoneFailedReason_Block_No_Host , ZMPhoneFailedReason_Block_High_Rate ,   ZMPhoneFailedReason_Block_Too_Frequent }
	Enumerates the various reasons for a phone call failure. More...
enum	ZMVideoSDKSuppressBackgroundNoiseLevel { ZMVideoSDKSuppressBackgroundNoiseLevel_Auto = 0 , ZMVideoSDKSuppressBackgroundNoiseLevel_Low , ZMVideoSDKSuppressBackgroundNoiseLevel_Medium , ZMVideoSDKSuppressBackgroundNoiseLevel_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	ZMVideoSDKEchoCancellationLevel { ZMVideoSDKEchoCancellationLevel_Default = 0 , ZMVideoSDKEchoCancellationLevel_Low , ZMVideoSDKEchoCancellationLevel_High }
	Enumeration of echo cancellation level. For more information, please visit https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0066398. More...
enum	ZMVideoSDKMultiCameraStreamStatus {   ZMVideoSDKMultiCameraStreamStatus_JoinStart , ZMVideoSDKMultiCameraStreamStatus_JoinFail , ZMVideoSDKMultiCameraStreamStatus_Joined , ZMVideoSDKMultiCameraStreamStatus_Left ,   ZMVideoSDKMultiCameraStreamStatus_VideoOn , ZMVideoSDKMultiCameraStreamStatus_VideoOff }
	Enumerates the status of multi-camera streams. More...
enum	ZMVideoSDKMicTestStatus { ZMVideoSDKMicTestStatus_CanTest = 0 , ZMVideoSDKMicTestStatus_Recording , ZMVideoSDKMicTestStatus_CanPlay }
	Enumerates the microphone test statuses. More...
enum	ZMVideoSDKAudioDeviceType { ZMVideoSDKAudioDeviceType_Microphone = 0 , ZMVideoSDKAudioDeviceType_Speaker }
	Enumerates the types of audio devices. More...
enum	ZMVideoSDKAudioDeviceStatus {   ZMVideoSDKAudioDeviceStatus_Device_Error_Unknow = 0 , ZMVideoSDKAudioDeviceStatus_No_Device , ZMVideoSDKAudioDeviceStatus_Device_List_Update , ZMVideoSDKAudioDeviceStatus_Audio_No_Input ,   ZMVideoSDKAudioDeviceStatus_Audio_Disconnect_As_Detected_Echo , ZMVideoSDKAudioDeviceStatus_Audio_Talk_While_Muted }
	Enumerates the statuses related to audio device state and availability. More...
enum	ZMVideoSDKShareType { ZMVideoSDKShareType_None , ZMVideoSDKShareType_Normal , ZMVideoSDKShareType_PureAudio , ZMVideoSDKShareType_Camera }
	Enumerates the types of content that can be shared in a session. More...
enum	ZMVideoSDKShareCapturePauseReason { ZMVideoSDKShare_Capture_Pause_None , ZMVideoSDKShare_Capture_Pause_WindowMoving , ZMVideoSDKShare_Capture_Pause_WindowCovered , ZMVideoSDKShare_Capture_Pause_WindowMinimized }
	Enumeration of reasons why screen sharing capture is paused in the Zoom Video SDK. More...
enum	ZMVideoSDKVideoSourceDataMode { ZMVideoSDKVideoSourceDataMode_None = 0 , ZMVideoSDKVideoSourceDataMode_Horizontal , ZMVideoSDKVideoSourceDataMode_Vertical }
	Enumerates the data modes for video source frames. More...
enum	ZMVideoSDKLiveTranscriptionStatus { ZMVideoSDKLiveTranscription_Status_Stop = 0 , ZMVideoSDKLiveTranscription_Status_Start = 1 }
	Enumerates the status of live transcription. More...
enum	ZMVideoSDKLiveTranscriptionOperationType {   ZMVideoSDKLiveTranscription_OperationType_None = 0 , ZMVideoSDKLiveTranscription_OperationType_Add , ZMVideoSDKLiveTranscription_OperationType_Update , ZMVideoSDKLiveTranscription_OperationType_Delete ,   ZMVideoSDKLiveTranscription_OperationType_Complete , ZMVideoSDKLiveTranscription_OperationType_NotSupported }
	Enumerates the types of operations related to live transcription. More...
enum	ZMVideoSDKChatMessageDeleteType { ZMVideoSDKChatMessageDeleteType_None = 0 , ZMVideoSDKChatMessageDeleteType_BySelf , ZMVideoSDKChatMessageDeleteType_ByHost , ZMVideoSDKChatMessageDeleteType_ByDlp }
	The chat message delete type are sent in the ZMVideoSDKDelegate#onChatMsgDeleteNotification callback. More...
enum	ZMVideoSDKVirtualBackgroundDataType { ZMVideoSDKVirtualBackgroundDataType_None , ZMVideoSDKVirtualBackgroundDataType_Image , ZMVideoSDKVirtualBackgroundDataType_Blur }
	Enumerates the types of virtual backgrounds. More...
enum	ZMVideoSDKDialInNumType { ZMVideoSDKDialInNumType_None , ZMVideoSDKDialInNumType_Toll , ZMVideoSDKDialInNumType_TollFree }
	Enumeration of the number types for calling to join the audio into a meeting. More...
enum	ZMVideoSDKNetworkStatus { ZMVideoSDKNetworkStatus_None , ZMVideoSDKNetworkStatus_Bad , ZMVideoSDKNetworkStatus_Normal , ZMVideoSDKNetworkStatus_Good }
	Enumerates the network statuses. More...
enum	ZMVideoSDKConsentType { ZMVideoSDKConsentType_Invalid , ZMVideoSDKConsentType_Traditional , ZMVideoSDKConsentType_Individual }
	Enumerates the types of consent for cloud recording. More...
enum	ZMVideoSDKScreenCaptureMode {   ZMVideoSDKScreenCaptureMode_Auto , ZMVideoSDKScreenCaptureMode_Legacy , ZMVideoSDKScreenCaptureMode_Filtering , ZMVideoSDKScreenCaptureMode_ADA_Filtering ,   ZMVideoSDKScreenCaptureMode_ADA_Without_Filtering }
	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	ZMVideoSDKVideoAspect { ZMVideoSDKVideoAspect_Original , ZMVideoSDKVideoAspect_Full_Filled , ZMVideoSDKVideoAspect_LetterBox , ZMVideoSDKVideoAspect_PanAndScan }
	Enumeration of the video aspect ratio. More...
enum	ZMVideoSDKCanvasType { ZMVideoSDKCanvasType_VideoData = 1 , ZMVideoSDKCanvasType_ShareData }
	Enumeration of the zoom render type. More...
enum	ZMVideoSDKFrameDataFormat { ZMVideoSDKFrameDataFormat_I420_Limited , ZMVideoSDKFrameDataFormat_I420_Full }
	Enumeration of raw data formats. Defines the color space format and color range for video frames. More...
enum	ZMVideoSDKCRCProtocol { ZMVideoSDKCRCProtocol_H323 , ZMVideoSDKCRCProtocol_SIP }
	Enumerates the types of Call CRC (Circuit-Reliable Communication). More...
enum	ZMVideoSDKCRCCallStatus {   ZMVideoSDKCRCCallStatus_Success = 0 , ZMVideoSDKCRCCallStatus_Ring , ZMVideoSDKCRCCallStatus_Timeout , ZMVideoSDKCRCCallStatus_Busy ,   ZMVideoSDKCRCCallStatus_Decline , ZMVideoSDKCRCCallStatus_Failed }
	Enumerates the statuses of a CRC call. More...
enum	ZMVideoSDKSubscribeFailReason {   ZMVideoSDKSubscribeFailReason_None = 0 , ZMVideoSDKSubscribeFailReason_HasSubscribe1080POr720P , ZMVideoSDKSubscribeFailReason_HasSubscribeTwo720P , ZMVideoSDKSubscribeFailReason_HasSubscribeExceededLimit ,   ZMVideoSDKSubscribeFailReason_HasSubscribeTwoShare , ZMVideoSDKSubscribeFailReason_HasSubscribeVideo1080POr720PAndOneShare , ZMVideoSDKSubscribeFailReason_TooFrequentCall }
	Enumerates the reasons for a failed video subscription attempt. More...
enum	ZMVideoSDKChatPrivilegeType { ZMVideoSDKChatPrivilegeType_Unknown = 0 , ZMVideoSDKChatPrivilegeType_Publicly_And_Privately , ZMVideoSDKChatPrivilegeType_No_One , ZMVideoSDKChatPrivilegeType_Publicly }
	Enumerates the types of chat privileges. More...
enum	ZMVideoSDKAnnotationToolType {   ZMVideoSDKAnnotationToolType_None , ZMVideoSDKAnnotationToolType_Pen , ZMVideoSDKAnnotationToolType_HighLighter , ZMVideoSDKAnnotationToolType_AutoLine ,   ZMVideoSDKAnnotationToolType_AutoRectangle , ZMVideoSDKAnnotationToolType_AutoEllipse , ZMVideoSDKAnnotationToolType_AutoArrow , ZMVideoSDKAnnotationToolType_AutoRectangleFill ,   ZMVideoSDKAnnotationToolType_AutoEllipseFill , ZMVideoSDKAnnotationToolType_SpotLight , ZMVideoSDKAnnotationToolType_Arrow , ZMVideoSDKAnnotationToolType_ERASER ,   ZMVideoSDKAnnotationToolType_Textbox , ZMVideoSDKAnnotationToolType_Picker , ZMVideoSDKAnnotationToolType_AutoRectangleSemiFill , ZMVideoSDKAnnotationToolType_AutoEllipseSemiFill ,   ZMVideoSDKAnnotationToolType_AutoDoubleArrow , ZMVideoSDKAnnotationToolType_AutoDiamond , ZMVideoSDKAnnotationToolType_AutoStampArrow , ZMVideoSDKAnnotationToolType_AutoStampCheck ,   ZMVideoSDKAnnotationToolType_AutoStampX , ZMVideoSDKAnnotationToolType_AutoStampStar , ZMVideoSDKAnnotationToolType_AutoStampHeart , ZMVideoSDKAnnotationToolType_AutoStampQm ,   ZMVideoSDKAnnotationToolType_VanishingPen , ZMVideoSDKAnnotationToolType_VanishingArrow , ZMVideoSDKAnnotationToolType_VanishingDoubleArrow , ZMVideoSDKAnnotationToolType_VanishingDiamond ,   ZMVideoSDKAnnotationToolType_VanishingEllipse , ZMVideoSDKAnnotationToolType_VanishingRectangle }
	Enumeration of the type for annotation tool. For more information, please visit https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0067931. More...
enum	ZMVideoSDKAnnotationClearType { ZMVideoSDKAnnotationClearType_All , ZMVideoSDKAnnotationClearType_Others , ZMVideoSDKAnnotationClearType_My }
	Enumeration of the type for clear annotation. More...
enum	ZMVideoSDKFileTransferStatus {   ZMVideoSDKFileTransferStatus_None = 0 , ZMVideoSDKFileTransferStatus_ReadyToTransfer , ZMVideoSDKFileTransferStatus_Transfering , ZMVideoSDKFileTransferStatus_TransferFailed ,   ZMVideoSDKFileTransferStatus_TransferDone }
	Enumeration of file transfer status. More...
enum	ZMVideoSDKAudioChannel { ZMVideoSDKAudioChannel_Mono = 0 , ZMVideoSDKAudioChannel_Stereo }
	Enumeration of audio channel types. More...
enum	ZMVideoSDKSessionLeaveReason {   ZMVideoSDKSessionLeaveReason_Unknown = 0 , ZMVideoSDKSessionLeaveReason_BySelf , ZMVideoSDKSessionLeaveReason_KickByHost , ZMVideoSDKSessionLeaveReason_EndByHost ,   ZMVideoSDKSessionLeaveReason_NetworkError }
	Enumerates the possible reasons for leaving a session. More...
enum	ZMVideoSDKRemoteControlStatus {   ZMVideoSDKRemoteControlStatus_None = 0 , ZMVideoSDKRemoteControlStatus_CanRequestControl , ZMVideoSDKRemoteControlStatus_RequestDenied , ZMVideoSDKRemoteControlStatus_GotControl ,   ZMVideoSDKRemoteControlStatus_LostControl , ZMVideoSDKRemoteControlStatus_ControlStart , ZMVideoSDKRemoteControlStatus_ControlStop , ZMVideoSDKRemoteControlStatus_GiveControlTo ,   ZMVideoSDKRemoteControlStatus_ControlRevoked , ZMVideoSDKRemoteControlStatus_ControlledBy , ZMVideoSDKRemoteControlStatus_NotControlled }
	Enumerates the statuses for remote control. More...
enum	ZMVideoSDKSubSessionStatus {   ZMVideoSDKSubSessionStatus_None , ZMVideoSDKSubSessionStatus_Committed , ZMVideoSDKSubSessionStatus_Withdrawn , ZMVideoSDKSubSessionStatus_Started ,   ZMVideoSDKSubSessionStatus_Stopping , ZMVideoSDKSubSessionStatus_Stopped , ZMVideoSDKSubSessionStatus_CommitFailed , ZMVideoSDKSubSessionStatus_WithdrawFailed ,   ZMVideoSDKSubSessionStatus_StartFailed , ZMVideoSDKSubSessionStatus_StopFailed }
	Enumeration of subsession statuses. More...
enum	ZMVideoSDKSessionType { ZMVideoSDKSessionType_MainSession = 0 , ZMVideoSDKSessionType_SubSession }
	Enumeration of session type. More...
enum	ZMVideoSDKUserHelpRequestResult { ZMVideoSDKUserHelpRequestResult_Idle , ZMVideoSDKUserHelpRequestResult_Busy , ZMVideoSDKUserHelpRequestResult_Ignore , ZMVideoSDKUserHelpRequestResult_HostAlreadyInSubSession }
	Enumeration of subsession user help request results. More...
enum	ZMVideoSDKSharePreprocessType { ZMVideoSDKSharePreprocessType_None = 0 , ZMVideoSDKSharePreprocessType_Screen , ZMVideoSDKSharePreprocessType_View , ZMVideoSDKSharePreprocessType_Process }
	Enumeration of share preprocess types. More...
enum	ZMVideoSDKShareSetting { ZMVideoSDKShareSetting_None = 0 , ZMVideoSDKShareSetting_LockedShare , ZMVideoSDKShareSetting_SingleShare , ZMVideoSDKShareSetting_MultiShare }
	Enumeration of Zoom Video SDK share setting types. More...
enum	ZMVideoSDKPreferVideoResolution { ZMVideoSDKPreferVideoResolution_None , ZMVideoSDKPreferVideoResolution_360P , ZMVideoSDKPreferVideoResolution_720P , ZMVideoSDKPreferVideoResolution_1080P }
	Enumeration of preferred video resolution in Zoom Video SDK. More...
enum	ZMVideoSDKWhiteboardStatus { ZMVideoSDKWhiteboardStatus_Started , ZMVideoSDKWhiteboardStatus_Stopped }
	Enumeration of the status of whiteboard sharing. More...
enum	ZMVideoSDKExportFormat { ZMVideoSDKExportFormat_PDF }
	Enumeration of supported export formats for content, like whiteboard. More...
enum	ZMVideoSDKBroadcastControlStatus {   ZMVideoSDKBroadcastControlStatus_None , ZMVideoSDKBroadcastControlStatus_Starting , ZMVideoSDKBroadcastControlStatus_Started , ZMVideoSDKBroadcastControlStatus_Stopping ,   ZMVideoSDKBroadcastControlStatus_Stopped }
	Enumerations of broadcast control status. More...
enum	ZMVideoSDKStreamingJoinStatus {   ZMVideoSDKStreamingJoinStatus_None , ZMVideoSDKStreamingJoinStatus_Connecting , ZMVideoSDKStreamingJoinStatus_Joined , ZMVideoSDKStreamingJoinStatus_Disconnecting ,   ZMVideoSDKStreamingJoinStatus_Reconnecting , ZMVideoSDKStreamingJoinStatus_Failed , ZMVideoSDKStreamingJoinStatus_Left }
	Enumerations of streaming join status. More...
enum	ZMVideoSDKLiveStreamLayout { ZMVideoSDKLiveStreamLayout_SpeakerView , ZMVideoSDKLiveStreamLayout_GalleryView }
	Enumeration of live stream layout types. More...
enum	ZMVideoSDKLiveStreamCloseCaption { ZMVideoSDKLiveStreamCloseCaption_OFF , ZMVideoSDKLiveStreamCloseCaption_BurntIn , ZMVideoSDKLiveStreamCloseCaption_Embedded }
	Enumeration of live stream close caption options. More...
enum	ZMVideoSDKDataType { ZMVideoSDKDataType_Unknown , ZMVideoSDKDataType_Audio , ZMVideoSDKDataType_Video , ZMVideoSDKDataType_Share }
	Enumeration of the data type for network quality monitoring. More...
enum	ZMVideoSDKRealTimeMediaStreamsStatus { ZMVideoSDKRealTimeMediaStreamsStatus_None = 0 , ZMVideoSDKRealTimeMediaStreamsStatus_Start , ZMVideoSDKRealTimeMediaStreamsStatus_Pause , ZMVideoSDKRealTimeMediaStreamsStatus_Stop }
	real-time media streams status. Here are more detailed structural descriptions. More...
enum	ZMVideoSDKRealTimeMediaStreamsFailReason { ZMVideoSDKRealTimeMediaStreamsFailReason_None = 0 , ZMVideoSDKRealTimeMediaStreamsFailReason_NoSubscription , ZMVideoSDKRealTimeMediaStreamsFailReason_StartFail }
	Failure reasons for RealTimeMediaStreams. Here are more detailed structural descriptions. More...

Detailed Description

This file defines the enumeration of Zoom Video SDK.

Definition in file ZMVideoSDKDef.h.

Enumeration Type Documentation

ZMPhoneFailedReason

enum ZMPhoneFailedReason

Enumerates the various reasons for a phone call failure.

Enumerator
ZMPhoneFailedReason_None	For initialization.
ZMPhoneFailedReason_Busy	The telephone number is currently busy.
ZMPhoneFailedReason_Not_Available	The telephone number is out of service.
ZMPhoneFailedReason_User_Hangup	The user manually hung up the call.
ZMPhoneFailedReason_Other_Fail	Other reasons.
ZMPhoneFailedReason_No_Answer	The user did not answer the call within the allowed time.
ZMPhoneFailedReason_Block_No_Host	The call invitation was blocked by the system due to an absent host.
ZMPhoneFailedReason_Block_High_Rate	The call-out attempt was blocked by the system due to the high rates or cost.
ZMPhoneFailedReason_Block_Too_Frequent	To join the session, the invitee would press one on the phone. An invitee who fails to respond will encounter a timeout. If there are too many invitee timeouts, the call invitation feature for this session will be blocked.

Definition at line 422 of file ZMVideoSDKDef.h.

{
    ZMPhoneFailedReason_None,
    ZMPhoneFailedReason_Busy,
    ZMPhoneFailedReason_Not_Available,
    ZMPhoneFailedReason_User_Hangup,
    ZMPhoneFailedReason_Other_Fail,
    ZMPhoneFailedReason_No_Answer,
    ZMPhoneFailedReason_Block_No_Host,
    ZMPhoneFailedReason_Block_High_Rate,
  
    ZMPhoneFailedReason_Block_Too_Frequent
}ZMPhoneFailedReason;

ZMPhoneStatus

enum ZMPhoneStatus

Enumerates the statuses of a phone call.

Enumerator
ZMPhoneStatus_None	For initialization.
ZMPhoneStatus_Calling	In the process of calling out.
ZMPhoneStatus_Ringing	In the process of ringing.
ZMPhoneStatus_Accepted	Call has been accepted.
ZMPhoneStatus_Success	Call was successful.
ZMPhoneStatus_Failed	Call failed.
ZMPhoneStatus_Canceling	In process of canceling the response to the previous state.
ZMPhoneStatus_Canceled	The call has been successfully canceled.
ZMPhoneStatus_Cancel_Failed	The attempt to cancel the call has failed.
ZMPhoneStatus_Timeout	The call attempt has timed out.

Definition at line 395 of file ZMVideoSDKDef.h.

{
    ZMPhoneStatus_None,
    ZMPhoneStatus_Calling,
    ZMPhoneStatus_Ringing,
    ZMPhoneStatus_Accepted,
    ZMPhoneStatus_Success,
    ZMPhoneStatus_Failed,
    ZMPhoneStatus_Canceling,
    ZMPhoneStatus_Canceled,
    ZMPhoneStatus_Cancel_Failed,
    ZMPhoneStatus_Timeout
}ZMPhoneStatus;

ZMRecordingStatus

enum ZMRecordingStatus

Enumerates the statuses of recording.

Enumerator
ZMRecording_Start	The recording has successfully started or successfully resumed.
ZMRecording_Stop	The recording has stopped.
ZMRecording_DiskFull	Recording is unsuccessful due to insufficient storage space. Please try to free up storage space or purchase additional storage space.
ZMRecording_Pause	The recording has paused.
ZMRecording_Connecting	The recording is connecting.

Definition at line 365 of file ZMVideoSDKDef.h.

{
    ZMRecording_Start,
    ZMRecording_Stop,
    ZMRecording_DiskFull,
    ZMRecording_Pause,
    ZMRecording_Connecting
}ZMRecordingStatus;

ZMVideoRotation

enum ZMVideoRotation

Enumerates the video rotation angles.

Enumerator
ZMVideoRotation_0	Video rotation is 0 degrees.
ZMVideoRotation_90	Video rotation is 90 degrees.
ZMVideoRotation_180	Video rotation is 180 degrees.
ZMVideoRotation_270	Video rotation is 270 degrees.

Definition at line 334 of file ZMVideoSDKDef.h.

{
    ZMVideoRotation_0,
    ZMVideoRotation_90,
    ZMVideoRotation_180,
    ZMVideoRotation_270
}ZMVideoRotation;

ZMVideoSDKAnnotationClearType

enum ZMVideoSDKAnnotationClearType

Enumeration of the type for clear annotation.

Enumerator
ZMVideoSDKAnnotationClearType_All	Clear all annotations. Hosts, managers and shared meeting owners can use.
ZMVideoSDKAnnotationClearType_Others	Clear only the others' annotations. Only shared meeting owners can use.
ZMVideoSDKAnnotationClearType_My	Clear only your own annotations. Everyone can use.

Definition at line 869 of file ZMVideoSDKDef.h.

            {
    ZMVideoSDKAnnotationClearType_All,
    ZMVideoSDKAnnotationClearType_Others,
    ZMVideoSDKAnnotationClearType_My
}ZMVideoSDKAnnotationClearType;

ZMVideoSDKAnnotationToolType

enum ZMVideoSDKAnnotationToolType

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

Enumerator
ZMVideoSDKAnnotationToolType_None	Switch to mouse cursor. For initialization.
ZMVideoSDKAnnotationToolType_Pen	Pen
ZMVideoSDKAnnotationToolType_HighLighter	Highlighter.
ZMVideoSDKAnnotationToolType_AutoLine	A straight line changes automatically in pace with the mouse cursor.
ZMVideoSDKAnnotationToolType_AutoRectangle	A rectangle changes automatically in pace with the mouse cursor.
ZMVideoSDKAnnotationToolType_AutoEllipse	An ellipse changes automatically in pace with the mouse cursor.
ZMVideoSDKAnnotationToolType_AutoArrow	An arrow changes automatically in pace with the mouse cursor.
ZMVideoSDKAnnotationToolType_AutoRectangleFill	A filled rectangle.
ZMVideoSDKAnnotationToolType_AutoEllipseFill	A filled ellipse.
ZMVideoSDKAnnotationToolType_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.
ZMVideoSDKAnnotationToolType_Arrow	Displays a small arrow instead of your mouse pointer. Each subsequent click will remove the previous arrow placed.
ZMVideoSDKAnnotationToolType_ERASER	Erase parts of your annotation.
ZMVideoSDKAnnotationToolType_Textbox	Insert a textbox to input letters.
ZMVideoSDKAnnotationToolType_Picker	Only available if you started the shared screen or whiteboard. Select , move, or resize your annotations.
ZMVideoSDKAnnotationToolType_AutoRectangleSemiFill	A fair rectangle changes automatically in pace with the mouse cursor.
ZMVideoSDKAnnotationToolType_AutoEllipseSemiFill	A fair ellipse changes automatically in pace with the mouse cursor.
ZMVideoSDKAnnotationToolType_AutoDoubleArrow	A line with a double-arrow.
ZMVideoSDKAnnotationToolType_AutoDiamond	An unfilled rhombus.
ZMVideoSDKAnnotationToolType_AutoStampArrow	A fixed-size arrow for marking.
ZMVideoSDKAnnotationToolType_AutoStampCheck	A sign marking that something is correct.
ZMVideoSDKAnnotationToolType_AutoStampX	A sign marking that something is incorrect.
ZMVideoSDKAnnotationToolType_AutoStampStar	A star for marking.
ZMVideoSDKAnnotationToolType_AutoStampHeart	A heart for marking.
ZMVideoSDKAnnotationToolType_AutoStampQm	A sign for interrogation.
ZMVideoSDKAnnotationToolType_VanishingPen	Vanishing pen.
ZMVideoSDKAnnotationToolType_VanishingArrow	Vanishing arrow.
ZMVideoSDKAnnotationToolType_VanishingDoubleArrow	Vanishing double arrow.
ZMVideoSDKAnnotationToolType_VanishingDiamond	Vanishing diamond.
ZMVideoSDKAnnotationToolType_VanishingEllipse	Vanishing ellipse.
ZMVideoSDKAnnotationToolType_VanishingRectangle	Vanishing rectangle.

Definition at line 803 of file ZMVideoSDKDef.h.

            {
    ZMVideoSDKAnnotationToolType_None,
    ZMVideoSDKAnnotationToolType_Pen,
    ZMVideoSDKAnnotationToolType_HighLighter,
    ZMVideoSDKAnnotationToolType_AutoLine,
    ZMVideoSDKAnnotationToolType_AutoRectangle,
    ZMVideoSDKAnnotationToolType_AutoEllipse,
    ZMVideoSDKAnnotationToolType_AutoArrow,
    ZMVideoSDKAnnotationToolType_AutoRectangleFill,
    ZMVideoSDKAnnotationToolType_AutoEllipseFill,
    ZMVideoSDKAnnotationToolType_SpotLight,
    ZMVideoSDKAnnotationToolType_Arrow,
    ZMVideoSDKAnnotationToolType_ERASER,
    ZMVideoSDKAnnotationToolType_Textbox,
    ZMVideoSDKAnnotationToolType_Picker,
    ZMVideoSDKAnnotationToolType_AutoRectangleSemiFill,
    ZMVideoSDKAnnotationToolType_AutoEllipseSemiFill,
    ZMVideoSDKAnnotationToolType_AutoDoubleArrow,
    ZMVideoSDKAnnotationToolType_AutoDiamond,
    ZMVideoSDKAnnotationToolType_AutoStampArrow,
    ZMVideoSDKAnnotationToolType_AutoStampCheck,
    ZMVideoSDKAnnotationToolType_AutoStampX,
    ZMVideoSDKAnnotationToolType_AutoStampStar,
    ZMVideoSDKAnnotationToolType_AutoStampHeart,
    ZMVideoSDKAnnotationToolType_AutoStampQm,
    ZMVideoSDKAnnotationToolType_VanishingPen,
    ZMVideoSDKAnnotationToolType_VanishingArrow,
    ZMVideoSDKAnnotationToolType_VanishingDoubleArrow,
    ZMVideoSDKAnnotationToolType_VanishingDiamond,
    ZMVideoSDKAnnotationToolType_VanishingEllipse,
    ZMVideoSDKAnnotationToolType_VanishingRectangle
}ZMVideoSDKAnnotationToolType;

ZMVideoSDKAudioChannel

enum ZMVideoSDKAudioChannel

Enumeration of audio channel types.

Enumerator
ZMVideoSDKAudioChannel_Mono	Mono audio channel.
ZMVideoSDKAudioChannel_Stereo	Stereo audio channel.

Definition at line 899 of file ZMVideoSDKDef.h.

{
    ZMVideoSDKAudioChannel_Mono = 0,
    ZMVideoSDKAudioChannel_Stereo
}ZMVideoSDKAudioChannel;

ZMVideoSDKAudioDeviceStatus

enum ZMVideoSDKAudioDeviceStatus

Enumerates the statuses related to audio device state and availability.

Enumerator
ZMVideoSDKAudioDeviceStatus_Device_Error_Unknow	An unknown device error has occurred.
ZMVideoSDKAudioDeviceStatus_No_Device	No audio device is currently available.
ZMVideoSDKAudioDeviceStatus_Device_List_Update	The list of available audio devices has been updated.
ZMVideoSDKAudioDeviceStatus_Audio_No_Input	No audio input is being detected from the current device.
ZMVideoSDKAudioDeviceStatus_Audio_Disconnect_As_Detected_Echo	Audio was disconnected automatically due to detected echo.
ZMVideoSDKAudioDeviceStatus_Audio_Talk_While_Muted	User is talking while muted.

Definition at line 522 of file ZMVideoSDKDef.h.

             {
    ZMVideoSDKAudioDeviceStatus_Device_Error_Unknow = 0,
    ZMVideoSDKAudioDeviceStatus_No_Device,
    ZMVideoSDKAudioDeviceStatus_Device_List_Update,
    ZMVideoSDKAudioDeviceStatus_Audio_No_Input,
    ZMVideoSDKAudioDeviceStatus_Audio_Disconnect_As_Detected_Echo,
    ZMVideoSDKAudioDeviceStatus_Audio_Talk_While_Muted
}ZMVideoSDKAudioDeviceStatus;

ZMVideoSDKAudioDeviceType

enum ZMVideoSDKAudioDeviceType

Enumerates the types of audio devices.

Enumerator
ZMVideoSDKAudioDeviceType_Microphone	Represents a microphone device used for audio input.
ZMVideoSDKAudioDeviceType_Speaker	Represents a speaker device used for audio output.

Definition at line 511 of file ZMVideoSDKDef.h.

{
    ZMVideoSDKAudioDeviceType_Microphone = 0,
    ZMVideoSDKAudioDeviceType_Speaker
}ZMVideoSDKAudioDeviceType;

ZMVideoSDKAudioType

enum ZMVideoSDKAudioType

Enumerates the types of audio.

Enumerator
ZMVideoSDKAudioType_VOIP	Audio type is VOIP (Voice over IP).
ZMVideoSDKAudioType_TELEPHONY	Audio type is telephony.
ZMVideoSDKAudioType_None	No audio type.

Definition at line 322 of file ZMVideoSDKDef.h.

             {
    ZMVideoSDKAudioType_VOIP,
    ZMVideoSDKAudioType_TELEPHONY,
    ZMVideoSDKAudioType_None
}ZMVideoSDKAudioType;

ZMVideoSDKBroadcastControlStatus

enum ZMVideoSDKBroadcastControlStatus

Enumerations of broadcast control status.

Enumerator
ZMVideoSDKBroadcastControlStatus_None	Initialized status.
ZMVideoSDKBroadcastControlStatus_Starting	Broadcast is starting.
ZMVideoSDKBroadcastControlStatus_Started	Broadcast is started.
ZMVideoSDKBroadcastControlStatus_Stopping	Broadcast is stopping.
ZMVideoSDKBroadcastControlStatus_Stopped	Broadcast is stopped.

Definition at line 1074 of file ZMVideoSDKDef.h.

{
    ZMVideoSDKBroadcastControlStatus_None,
    ZMVideoSDKBroadcastControlStatus_Starting,
    ZMVideoSDKBroadcastControlStatus_Started,
    ZMVideoSDKBroadcastControlStatus_Stopping,
    ZMVideoSDKBroadcastControlStatus_Stopped
}ZMVideoSDKBroadcastControlStatus;

ZMVideoSDKCameraControlRequestType

enum ZMVideoSDKCameraControlRequestType

Enumerates the types of remote camera control requests.

Enumerator
ZMVideoSDKCameraControlRequestType_RequestControl	Request remote camera control.
ZMVideoSDKCameraControlRequestType_GiveUpControl	Give up remote camera control.

Definition at line 383 of file ZMVideoSDKDef.h.

{
    ZMVideoSDKCameraControlRequestType_RequestControl = 0,
    ZMVideoSDKCameraControlRequestType_GiveUpControl
}ZMVideoSDKCameraControlRequestType;

ZMVideoSDKCanvasType

enum ZMVideoSDKCanvasType

Enumeration of the zoom render type.

Enumerator
ZMVideoSDKCanvasType_VideoData	Video Camera data. This type represents video data captured from the camera.
ZMVideoSDKCanvasType_ShareData	Share data.

Definition at line 717 of file ZMVideoSDKDef.h.

{
    ZMVideoSDKCanvasType_VideoData = 1,
    ZMVideoSDKCanvasType_ShareData,
}ZMVideoSDKCanvasType;

ZMVideoSDKChatMessageDeleteType

enum ZMVideoSDKChatMessageDeleteType

The chat message delete type are sent in the ZMVideoSDKDelegate#onChatMsgDeleteNotification callback.

Enumerator
ZMVideoSDKChatMessageDeleteType_None	For initialization.
ZMVideoSDKChatMessageDeleteType_BySelf	Message is deleted by the sender (self deletion).
ZMVideoSDKChatMessageDeleteType_ByHost	Message is deleted by the session host.
ZMVideoSDKChatMessageDeleteType_ByDlp	Message is deleted by Data Loss Prevention (DLP) system for violating compliance policies.

Definition at line 613 of file ZMVideoSDKDef.h.

{
    ZMVideoSDKChatMessageDeleteType_None = 0,
    ZMVideoSDKChatMessageDeleteType_BySelf,
    ZMVideoSDKChatMessageDeleteType_ByHost,
    ZMVideoSDKChatMessageDeleteType_ByDlp
}ZMVideoSDKChatMessageDeleteType;

ZMVideoSDKChatPrivilegeType

enum ZMVideoSDKChatPrivilegeType

Enumerates the types of chat privileges.

Enumerator
ZMVideoSDKChatPrivilegeType_Unknown	Unknown.
ZMVideoSDKChatPrivilegeType_Publicly_And_Privately	The user has the privilege to chat both publicly and privately.
ZMVideoSDKChatPrivilegeType_No_One	The user has no chat privileges.
ZMVideoSDKChatPrivilegeType_Publicly	The user has the privilege to chat publicly only.

Definition at line 789 of file ZMVideoSDKDef.h.

            {
    ZMVideoSDKChatPrivilegeType_Unknown = 0,
    ZMVideoSDKChatPrivilegeType_Publicly_And_Privately,
    ZMVideoSDKChatPrivilegeType_No_One,
    ZMVideoSDKChatPrivilegeType_Publicly,
} ZMVideoSDKChatPrivilegeType;

ZMVideoSDKConsentType

enum ZMVideoSDKConsentType

Enumerates the types of consent for cloud recording.

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

Definition at line 670 of file ZMVideoSDKDef.h.

{
    ZMVideoSDKConsentType_Invalid,
    ZMVideoSDKConsentType_Traditional,
    ZMVideoSDKConsentType_Individual
}ZMVideoSDKConsentType;

ZMVideoSDKCRCCallStatus

enum ZMVideoSDKCRCCallStatus

Enumerates the statuses of a CRC call.

Enumerator
ZMVideoSDKCRCCallStatus_Success	The call was successfully established.
ZMVideoSDKCRCCallStatus_Ring	The call is ringing (waiting to be answered).
ZMVideoSDKCRCCallStatus_Timeout	The call has timed out.
ZMVideoSDKCRCCallStatus_Busy	The line is busy.
ZMVideoSDKCRCCallStatus_Decline	The call was declined by the recipient.
ZMVideoSDKCRCCallStatus_Failed	The call failed.

Definition at line 750 of file ZMVideoSDKDef.h.

{
    ZMVideoSDKCRCCallStatus_Success = 0,
    ZMVideoSDKCRCCallStatus_Ring,
    ZMVideoSDKCRCCallStatus_Timeout,
    ZMVideoSDKCRCCallStatus_Busy,
    ZMVideoSDKCRCCallStatus_Decline,
    ZMVideoSDKCRCCallStatus_Failed
}ZMVideoSDKCRCCallStatus;

ZMVideoSDKCRCProtocol

enum ZMVideoSDKCRCProtocol

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

Enumerator
ZMVideoSDKCRCProtocol_H323	H.323 type.
ZMVideoSDKCRCProtocol_SIP	SIP type.

Definition at line 739 of file ZMVideoSDKDef.h.

{
    ZMVideoSDKCRCProtocol_H323,
    ZMVideoSDKCRCProtocol_SIP
}ZMVideoSDKCRCProtocol;

ZMVideoSDKDataType

enum ZMVideoSDKDataType

Enumeration of the data type for network quality monitoring.

Enumerator
ZMVideoSDKDataType_Unknown	Unknown data type.
ZMVideoSDKDataType_Audio	Audio data type.
ZMVideoSDKDataType_Video	Video data type.
ZMVideoSDKDataType_Share	Share data type.

Definition at line 1136 of file ZMVideoSDKDef.h.

{
    ZMVideoSDKDataType_Unknown,
    ZMVideoSDKDataType_Audio,
    ZMVideoSDKDataType_Video,
    ZMVideoSDKDataType_Share
}ZMVideoSDKDataType;

ZMVideoSDKDialInNumType

enum ZMVideoSDKDialInNumType

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

Enumerator
ZMVideoSDKDialInNumType_None	For initialization.
ZMVideoSDKDialInNumType_Toll	Paid (toll) number.
ZMVideoSDKDialInNumType_TollFree	Toll-free number.

Definition at line 641 of file ZMVideoSDKDef.h.

{
    ZMVideoSDKDialInNumType_None,
    ZMVideoSDKDialInNumType_Toll,
    ZMVideoSDKDialInNumType_TollFree
}ZMVideoSDKDialInNumType;

ZMVideoSDKEchoCancellationLevel

enum ZMVideoSDKEchoCancellationLevel

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

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

Definition at line 466 of file ZMVideoSDKDef.h.

             {
    ZMVideoSDKEchoCancellationLevel_Default = 0,
    ZMVideoSDKEchoCancellationLevel_Low,
    ZMVideoSDKEchoCancellationLevel_High
}ZMVideoSDKEchoCancellationLevel;

ZMVideoSDKErrors

enum ZMVideoSDKErrors

Enumerates all errors in the VideoSDK.

Enumerator
ZMVideoSDKErrors_Success	Success.
ZMVideoSDKErrors_Wrong_Usage	Wrong usage.
ZMVideoSDKErrors_Internal_Error	Internal error.
ZMVideoSDKErrors_Uninitialize	SDK is not initialized.
ZMVideoSDKErrors_Memory_Error	Memory allocation error.
ZMVideoSDKErrors_Load_Module_Error	Failed to load module.
ZMVideoSDKErrors_UnLoad_Module_Error	Failed to unload module.
ZMVideoSDKErrors_Invalid_Parameter	One or more parameters are invalid.
ZMVideoSDKErrors_Call_Too_Frequently	API called too frequently.
ZMVideoSDKErrors_No_Impl	Function not implemented.
ZMVideoSDKErrors_Dont_Support_Feature	Feature not supported.
ZMVideoSDKErrors_Unknown	Unknown error.
ZMVideoSDKErrors_Remove_Folder_Fail	Failed to remove folder.
ZMVideoSDKErrors_Auth_Error	Authorization related errors Authorization failure.
ZMVideoSDKErrors_Auth_Empty_Key_or_Secret	App key or secret is empty.
ZMVideoSDKErrors_Auth_Wrong_Key_or_Secret	App key or secret is incorrect.
ZMVideoSDKErrors_Auth_DoesNot_Support_SDK	Not support SDK.
ZMVideoSDKErrors_Auth_Disable_SDK	SDK is disabled.
ZMVideoSDKErrors_JoinSession_NoSessionName	Join session errors Session name is missing.
ZMVideoSDKErrors_JoinSession_NoSessionToken	Session token is missing.
ZMVideoSDKErrors_JoinSession_NoUserName	Username is missing.
ZMVideoSDKErrors_JoinSession_Invalid_SessionName	Session name is invalid.
ZMVideoSDKErrors_JoinSession_Invalid_Password	Password is incorrect.
ZMVideoSDKErrors_JoinSession_Invalid_SessionToken	Session token is invalid.
ZMVideoSDKErrors_JoinSession_SessionName_TooLong	Session name is too long.
ZMVideoSDKErrors_JoinSession_Token_MismatchedSessionName	Token does not match session name.
ZMVideoSDKErrors_JoinSession_Token_NoSessionName	Token does not contain a session name.
ZMVideoSDKErrors_JoinSession_Token_RoleType_EmptyOrWrong	Role type in token is empty or incorrect.
ZMVideoSDKErrors_JoinSession_Token_UserIdentity_TooLong	User identity in token is too long.
ZMVideoSDKErrors_SessionModule_Not_Found	Session-related errors Session module not found.
ZMVideoSDKErrors_SessionService_Invalid	Invalid session service.
ZMVideoSDKErrors_Session_Join_Failed	Failed to join session.
ZMVideoSDKErrors_Session_No_Rights	No permission to join session.
ZMVideoSDKErrors_Session_Already_In_Progress	Already in progress.
ZMVideoSDKErrors_Session_Dont_Support_SessionType	Unsupported session type.
ZMVideoSDKErrors_Session_Reconnecting	Session is reconnecting.
ZMVideoSDKErrors_Session_Disconnecting	Session is disconnecting.
ZMVideoSDKErrors_Session_Not_Started	Session has not started.
ZMVideoSDKErrors_Session_Need_Password	Password is required to join.
ZMVideoSDKErrors_Session_Password_Wrong	Incorrect session password.
ZMVideoSDKErrors_Session_Remote_DB_Error	Remote database error.
ZMVideoSDKErrors_Session_Invalid_Param	Invalid parameter.
ZMVideoSDKErrors_Session_Client_Incompatible	Client version is incompatible.
ZMVideoSDKErrors_Session_Account_FreeMinutesExceeded	Free minutes exceeded.
ZMVideoSDKErrors_Session_Account_FreeCreditExceeded	Join session failed because the account's free credit has been exceeded.
ZMVideoSDKErrors_Session_Audio_Error	Audio errors General audio error.
ZMVideoSDKErrors_Session_Audio_No_Microphone	No microphone detected.
ZMVideoSDKErrors_Session_Audio_No_Speaker	No speaker detected.
ZMVideoSDKErrors_Session_Bluetooth_SCO_Connection_Failed	Bluetooth sco connect fail. Android Only.
ZMVideoSDKErrors_Session_Video_Error	Video errors. General video error.
ZMVideoSDKErrors_Session_Video_Device_Error	Video device error.
ZMVideoSDKErrors_Session_Live_Stream_Error	Live stream error.
ZMVideoSDKErrors_Session_Phone_Error	Phone error.
ZMVideoSDKErrors_RAWDATA_MALLOC_FAILED	Raw data errors Memory allocation for raw data failed.
ZMVideoSDKErrors_RAWDATA_NOT_IN_Session	Not in session.
ZMVideoSDKErrors_RAWDATA_NO_LICENSE	No raw data license.
ZMVideoSDKErrors_RAWDATA_VIDEO_MODULE_NOT_READY	Video module not ready.
ZMVideoSDKErrors_RAWDATA_VIDEO_MODULE_ERROR	Video module error.
ZMVideoSDKErrors_RAWDATA_VIDEO_DEVICE_ERROR	Video device error.
ZMVideoSDKErrors_RAWDATA_NO_VIDEO_DATA	No video data available.
ZMVideoSDKErrors_RAWDATA_SHARE_MODULE_NOT_READY	Share module not ready.
ZMVideoSDKErrors_RAWDATA_SHARE_MODULE_ERROR	Share module error.
ZMVideoSDKErrors_RAWDATA_NO_SHARE_DATA	No shared data available.
ZMVideoSDKErrors_RAWDATA_AUDIO_MODULE_NOT_READY	Audio module not ready.
ZMVideoSDKErrors_RAWDATA_AUDIO_MODULE_ERROR	Audio module error.
ZMVideoSDKErrors_RAWDATA_NO_AUDIO_DATA	No audio data available.
ZMVideoSDKErrors_RAWDATA_PREPROCESS_RAWDATA_ERROR	Raw data pre-processing failed.
ZMVideoSDKErrors_RAWDATA_NO_DEVICE_RUNNING	No device is running.
ZMVideoSDKErrors_RAWDATA_INIT_DEVICE	Failed to initialize media device.
ZMVideoSDKErrors_RAWDATA_VIRTUAL_DEVICE	Virtual device error.
ZMVideoSDKErrors_RAWDATA_CANNOT_CHANGE_VIRTUAL_DEVICE_IN_PREVIEW	Cannot change virtual device during preview.
ZMVideoSDKErrors_RAWDATA_INTERNAL_ERROR	Internal raw data error.
ZMVideoSDKErrors_RAWDATA_SEND_TOO_MUCH_DATA_IN_SINGLE_TIME	Too much data sent at once.
ZMVideoSDKErrors_RAWDATA_SEND_TOO_FREQUENTLY	Data sent too frequently.
ZMVideoSDKErrors_RAWDATA_VIRTUAL_MIC_IS_TERMINATE	Virtual microphone has been terminated.
ZMVideoSDKErrors_Rawdata_Invalid_Share_Preprocessing_Data_Object	The share preprocessing data object is invalid.
ZMVideoSDKErrors_Rawdata_Share_Preprocessing_Is_Stopped	Share preprocessing has stopped.
ZMVideoSDKErrors_Session_Share_Error	Session sharing errors General sharing error.
ZMVideoSDKErrors_Session_Share_Module_Not_Ready	Share module not ready.
ZMVideoSDKErrors_Session_Share_You_Are_Not_Sharing	You are not sharing.
ZMVideoSDKErrors_Session_Share_Type_Is_Not_Support	Unsupported share type.
ZMVideoSDKErrors_Session_Share_Internal_Error	Internal share error.
ZMVideoSDKErrors_Dont_Support_Multi_Stream_Video_User	Multi-stream video not supported for user.
ZMVideoSDKErrors_Fail_Assign_User_Privilege	Failed to assign user privilege.
ZMVideoSDKErrors_No_Recording_In_Process	No recording in progress.
ZMVideoSDKErrors_Recording_Is_Connecting	Recording is connecting.
ZMVideoSDKErrors_Set_Virtual_Background_Fail	Failed to set virtual background.
ZMVideoSDKErrors_Session_Share_Camera_Video_Not_Start	Camera video not started for share.
ZMVideoSDKErrors_Session_Share_Camera_Conflict_With_Video_Effects	Camera conflicts with video effects.
ZMVideoSDKErrors_Session_Share_Conflict_With_Whiteboard	Share conflicts with whiteboard share.
ZMVideoSDKErrors_Filetransfer_UnknowError	File transfer errors. Unknown file transfer error.
ZMVideoSDKErrors_Filetransfer_FileTypeBlocked	File type is blocked.
ZMVideoSDKErrors_Filetransfer_FileSizelimited	File size exceeds limit.
ZMVideoSDKErrors_Spotlight_NotEnoughUsers	Spotlight errors Not enough users to spotlight.
ZMVideoSDKErrors_Spotlight_ToMuchSpotlightedUsers	Too many spotlighted users.
ZMVideoSDKErrors_Spotlight_UserCannotBeSpotlighted	User cannot be spotlighted.
ZMVideoSDKErrors_Spotlight_UserWithoutVideo	User has no video to spotlight.
ZMVideoSDKErrors_Spotlight_UserNotSpotlighted	User is not spotlighted.

Definition at line 9 of file ZMVideoSDKDef.h.

{
    ZMVideoSDKErrors_Success = 0,
    ZMVideoSDKErrors_Wrong_Usage,
    ZMVideoSDKErrors_Internal_Error,
    ZMVideoSDKErrors_Uninitialize,
    ZMVideoSDKErrors_Memory_Error,
    ZMVideoSDKErrors_Load_Module_Error,
    ZMVideoSDKErrors_UnLoad_Module_Error,
    ZMVideoSDKErrors_Invalid_Parameter,
    ZMVideoSDKErrors_Call_Too_Frequently,
    ZMVideoSDKErrors_No_Impl,
    ZMVideoSDKErrors_Dont_Support_Feature,
    ZMVideoSDKErrors_Unknown,
    ZMVideoSDKErrors_Remove_Folder_Fail,
    
    ZMVideoSDKErrors_Auth_Error = 1001,
    ZMVideoSDKErrors_Auth_Empty_Key_or_Secret,
    ZMVideoSDKErrors_Auth_Wrong_Key_or_Secret,
    ZMVideoSDKErrors_Auth_DoesNot_Support_SDK,
    ZMVideoSDKErrors_Auth_Disable_SDK,
    
    ZMVideoSDKErrors_JoinSession_NoSessionName = 1500,
    ZMVideoSDKErrors_JoinSession_NoSessionToken,
    ZMVideoSDKErrors_JoinSession_NoUserName,
    ZMVideoSDKErrors_JoinSession_Invalid_SessionName,
    ZMVideoSDKErrors_JoinSession_Invalid_Password,
    ZMVideoSDKErrors_JoinSession_Invalid_SessionToken,
    ZMVideoSDKErrors_JoinSession_SessionName_TooLong,
    ZMVideoSDKErrors_JoinSession_Token_MismatchedSessionName,
    ZMVideoSDKErrors_JoinSession_Token_NoSessionName,
    ZMVideoSDKErrors_JoinSession_Token_RoleType_EmptyOrWrong,
    ZMVideoSDKErrors_JoinSession_Token_UserIdentity_TooLong,
    
    ZMVideoSDKErrors_SessionModule_Not_Found = 2001,
    ZMVideoSDKErrors_SessionService_Invalid,
    ZMVideoSDKErrors_Session_Join_Failed,
    ZMVideoSDKErrors_Session_No_Rights,
    ZMVideoSDKErrors_Session_Already_In_Progress,
    ZMVideoSDKErrors_Session_Dont_Support_SessionType,
    ZMVideoSDKErrors_Session_Reconnecting,
    ZMVideoSDKErrors_Session_Disconnecting,
    ZMVideoSDKErrors_Session_Not_Started,
    ZMVideoSDKErrors_Session_Need_Password,
    ZMVideoSDKErrors_Session_Password_Wrong,
    ZMVideoSDKErrors_Session_Remote_DB_Error,
    ZMVideoSDKErrors_Session_Invalid_Param,
    ZMVideoSDKErrors_Session_Client_Incompatible,
    ZMVideoSDKErrors_Session_Account_FreeMinutesExceeded,
    ZMVideoSDKErrors_Session_Account_FreeCreditExceeded,
    
    ZMVideoSDKErrors_Session_Audio_Error = 3000,
    ZMVideoSDKErrors_Session_Audio_No_Microphone,
    ZMVideoSDKErrors_Session_Audio_No_Speaker,
    ZMVideoSDKErrors_Session_Bluetooth_SCO_Connection_Failed,
    
    ZMVideoSDKErrors_Session_Video_Error = 4000,
    ZMVideoSDKErrors_Session_Video_Device_Error,
    
    ZMVideoSDKErrors_Session_Live_Stream_Error = 5000,
    
    ZMVideoSDKErrors_Session_Phone_Error = 5500,
    
    ZMVideoSDKErrors_RAWDATA_MALLOC_FAILED = 6001,
    ZMVideoSDKErrors_RAWDATA_NOT_IN_Session,
    ZMVideoSDKErrors_RAWDATA_NO_LICENSE,
    ZMVideoSDKErrors_RAWDATA_VIDEO_MODULE_NOT_READY,
    ZMVideoSDKErrors_RAWDATA_VIDEO_MODULE_ERROR,
    ZMVideoSDKErrors_RAWDATA_VIDEO_DEVICE_ERROR,
    ZMVideoSDKErrors_RAWDATA_NO_VIDEO_DATA,
    ZMVideoSDKErrors_RAWDATA_SHARE_MODULE_NOT_READY,
    ZMVideoSDKErrors_RAWDATA_SHARE_MODULE_ERROR,
    ZMVideoSDKErrors_RAWDATA_NO_SHARE_DATA,
    ZMVideoSDKErrors_RAWDATA_AUDIO_MODULE_NOT_READY,
    ZMVideoSDKErrors_RAWDATA_AUDIO_MODULE_ERROR,
    ZMVideoSDKErrors_RAWDATA_NO_AUDIO_DATA,
    ZMVideoSDKErrors_RAWDATA_PREPROCESS_RAWDATA_ERROR,
    ZMVideoSDKErrors_RAWDATA_NO_DEVICE_RUNNING,
    ZMVideoSDKErrors_RAWDATA_INIT_DEVICE,
    ZMVideoSDKErrors_RAWDATA_VIRTUAL_DEVICE,
    ZMVideoSDKErrors_RAWDATA_CANNOT_CHANGE_VIRTUAL_DEVICE_IN_PREVIEW,
    ZMVideoSDKErrors_RAWDATA_INTERNAL_ERROR,
    ZMVideoSDKErrors_RAWDATA_SEND_TOO_MUCH_DATA_IN_SINGLE_TIME,
    ZMVideoSDKErrors_RAWDATA_SEND_TOO_FREQUENTLY,
    ZMVideoSDKErrors_RAWDATA_VIRTUAL_MIC_IS_TERMINATE,
    ZMVideoSDKErrors_Rawdata_Invalid_Share_Preprocessing_Data_Object,
    ZMVideoSDKErrors_Rawdata_Share_Preprocessing_Is_Stopped,
    
    
    ZMVideoSDKErrors_Session_Share_Error = 7001,
    ZMVideoSDKErrors_Session_Share_Module_Not_Ready,
    ZMVideoSDKErrors_Session_Share_You_Are_Not_Sharing,
    ZMVideoSDKErrors_Session_Share_Type_Is_Not_Support,
    ZMVideoSDKErrors_Session_Share_Internal_Error,
    ZMVideoSDKErrors_Dont_Support_Multi_Stream_Video_User,
    ZMVideoSDKErrors_Fail_Assign_User_Privilege,
    ZMVideoSDKErrors_No_Recording_In_Process,
    ZMVideoSDKErrors_Recording_Is_Connecting,
    ZMVideoSDKErrors_Set_Virtual_Background_Fail,
    ZMVideoSDKErrors_Session_Share_Camera_Video_Not_Start,
    ZMVideoSDKErrors_Session_Share_Camera_Conflict_With_Video_Effects,
    ZMVideoSDKErrors_Session_Share_Conflict_With_Whiteboard,
 
    ZMVideoSDKErrors_Filetransfer_UnknowError = 7500,
    ZMVideoSDKErrors_Filetransfer_FileTypeBlocked,
    ZMVideoSDKErrors_Filetransfer_FileSizelimited,
    
    ZMVideoSDKErrors_Spotlight_NotEnoughUsers = 7600,
    ZMVideoSDKErrors_Spotlight_ToMuchSpotlightedUsers,
    ZMVideoSDKErrors_Spotlight_UserCannotBeSpotlighted,
    ZMVideoSDKErrors_Spotlight_UserWithoutVideo,
    ZMVideoSDKErrors_Spotlight_UserNotSpotlighted
}ZMVideoSDKErrors;

ZMVideoSDKExportFormat

enum ZMVideoSDKExportFormat

Enumeration of supported export formats for content, like whiteboard.

Enumerator
ZMVideoSDKExportFormat_PDF	Export the content as a PDF document.

Definition at line 1065 of file ZMVideoSDKDef.h.

{
    ZMVideoSDKExportFormat_PDF,
}ZMVideoSDKExportFormat;

ZMVideoSDKFileTransferStatus

enum ZMVideoSDKFileTransferStatus

Enumeration of file transfer status.

Enumerator
ZMVideoSDKFileTransferStatus_None	The file transfer has no state.
ZMVideoSDKFileTransferStatus_ReadyToTransfer	The file transfer is ready to start.
ZMVideoSDKFileTransferStatus_Transfering	The file transfer is in progress.
ZMVideoSDKFileTransferStatus_TransferFailed	The file transfer failed.
ZMVideoSDKFileTransferStatus_TransferDone	The file transfer completed successfully.

Definition at line 882 of file ZMVideoSDKDef.h.

{
    ZMVideoSDKFileTransferStatus_None = 0,
    ZMVideoSDKFileTransferStatus_ReadyToTransfer,
    ZMVideoSDKFileTransferStatus_Transfering,
    ZMVideoSDKFileTransferStatus_TransferFailed,
    ZMVideoSDKFileTransferStatus_TransferDone
}ZMVideoSDKFileTransferStatus;

ZMVideoSDKFrameDataFormat

enum ZMVideoSDKFrameDataFormat

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

Enumerator
ZMVideoSDKFrameDataFormat_I420_Limited	I420 format with Limited color range.
ZMVideoSDKFrameDataFormat_I420_Full	I420 format with Full color range.

Definition at line 728 of file ZMVideoSDKDef.h.

{
    ZMVideoSDKFrameDataFormat_I420_Limited,
    ZMVideoSDKFrameDataFormat_I420_Full,
}ZMVideoSDKFrameDataFormat;

ZMVideoSDKLiveStreamCloseCaption

enum ZMVideoSDKLiveStreamCloseCaption

Enumeration of live stream close caption options.

Enumerator
ZMVideoSDKLiveStreamCloseCaption_OFF	Close caption is disabled.
ZMVideoSDKLiveStreamCloseCaption_BurntIn	Close caption is burnt into the video stream.
ZMVideoSDKLiveStreamCloseCaption_Embedded	Close caption is embedded in the stream data.

Definition at line 1123 of file ZMVideoSDKDef.h.

{
    ZMVideoSDKLiveStreamCloseCaption_OFF,
    ZMVideoSDKLiveStreamCloseCaption_BurntIn,
    ZMVideoSDKLiveStreamCloseCaption_Embedded
}ZMVideoSDKLiveStreamCloseCaption;

ZMVideoSDKLiveStreamLayout

enum ZMVideoSDKLiveStreamLayout

Enumeration of live stream layout types.

Enumerator
ZMVideoSDKLiveStreamLayout_SpeakerView	Speaker view layout for live stream.
ZMVideoSDKLiveStreamLayout_GalleryView	Gallery view layout for live stream.

Definition at line 1112 of file ZMVideoSDKDef.h.

{
    ZMVideoSDKLiveStreamLayout_SpeakerView,
    ZMVideoSDKLiveStreamLayout_GalleryView
}ZMVideoSDKLiveStreamLayout;

ZMVideoSDKLiveStreamStatus

enum ZMVideoSDKLiveStreamStatus

Enumerates the statuses of live streaming.

Enumerator
ZMVideoSDKLiveStreamStatus_None	The live stream status is none
ZMVideoSDKLiveStreamStatus_InProgress	The live stream status is currently in progress
ZMVideoSDKLiveStreamStatus_Connecting	The live stream status is in the process of connecting
ZMVideoSDKLiveStreamStatus_FailedTimeout	The live stream failed due to a timeout.
ZMVideoSDKLiveStreamStatus_StartFailed	The live stream failed to start.
ZMVideoSDKLiveStreamStatus_Ended	The live stream has ended.

Definition at line 251 of file ZMVideoSDKDef.h.

{
    ZMVideoSDKLiveStreamStatus_None,
    ZMVideoSDKLiveStreamStatus_InProgress,
    ZMVideoSDKLiveStreamStatus_Connecting,
    ZMVideoSDKLiveStreamStatus_FailedTimeout,
    ZMVideoSDKLiveStreamStatus_StartFailed,
    ZMVideoSDKLiveStreamStatus_Ended
}ZMVideoSDKLiveStreamStatus;

ZMVideoSDKLiveTranscriptionOperationType

enum ZMVideoSDKLiveTranscriptionOperationType

Enumerates the types of operations related to live transcription.

Enumerator
ZMVideoSDKLiveTranscription_OperationType_None	No operation specified.
ZMVideoSDKLiveTranscription_OperationType_Add	Live transcription operation type is added.
ZMVideoSDKLiveTranscription_OperationType_Update	Live transcription operation type is updated.
ZMVideoSDKLiveTranscription_OperationType_Delete	Live transcription operation type is deleted.
ZMVideoSDKLiveTranscription_OperationType_Complete	Live transcription operation type is marked as complete.
ZMVideoSDKLiveTranscription_OperationType_NotSupported	Live transcription operation type is not supported.

Definition at line 594 of file ZMVideoSDKDef.h.

{
    ZMVideoSDKLiveTranscription_OperationType_None = 0,
    ZMVideoSDKLiveTranscription_OperationType_Add,
    ZMVideoSDKLiveTranscription_OperationType_Update,
    ZMVideoSDKLiveTranscription_OperationType_Delete,
    ZMVideoSDKLiveTranscription_OperationType_Complete,
    ZMVideoSDKLiveTranscription_OperationType_NotSupported
}ZMVideoSDKLiveTranscriptionOperationType;

ZMVideoSDKLiveTranscriptionStatus

enum ZMVideoSDKLiveTranscriptionStatus

Enumerates the status of live transcription.

Enumerator
ZMVideoSDKLiveTranscription_Status_Stop	Live transcription is currently stopped.
ZMVideoSDKLiveTranscription_Status_Start	Live transcription is currently active.

Definition at line 583 of file ZMVideoSDKDef.h.

{
    ZMVideoSDKLiveTranscription_Status_Stop = 0,
    ZMVideoSDKLiveTranscription_Status_Start = 1
}ZMVideoSDKLiveTranscriptionStatus;

ZMVideoSDKMicTestStatus

enum ZMVideoSDKMicTestStatus

Enumerates the microphone test statuses.

Enumerator
ZMVideoSDKMicTestStatus_CanTest	The microphone is ready to start a test.
ZMVideoSDKMicTestStatus_Recording	The microphone is currently recording audio for the test.
ZMVideoSDKMicTestStatus_CanPlay	The recorded audio is ready for playback.

Definition at line 498 of file ZMVideoSDKDef.h.

            {
    ZMVideoSDKMicTestStatus_CanTest = 0,
    ZMVideoSDKMicTestStatus_Recording,
    ZMVideoSDKMicTestStatus_CanPlay
}ZMVideoSDKMicTestStatus;

ZMVideoSDKMultiCameraStreamStatus

enum ZMVideoSDKMultiCameraStreamStatus

Enumerates the status of multi-camera streams.

Enumerator
ZMVideoSDKMultiCameraStreamStatus_JoinStart	Current user only. Sent when the current user attempts to use multiple cameras in the session.
ZMVideoSDKMultiCameraStreamStatus_JoinFail	Current user only. Sent when the current user fails to use multiple cameras in the session.
ZMVideoSDKMultiCameraStreamStatus_Joined	Broadcast to all users. Sent when a new camera has been successfully added to the session as the multiple cameras.
ZMVideoSDKMultiCameraStreamStatus_Left	Broadcast to all users. Sent after a camera that is being used as the multiple cameras leaves the session.
ZMVideoSDKMultiCameraStreamStatus_VideoOn	Broadcast to all users. Sent when a multiple camera is started.
ZMVideoSDKMultiCameraStreamStatus_VideoOff	Broadcast to all users. Sent when a multiple camera is stopped.

Definition at line 479 of file ZMVideoSDKDef.h.

            {
    ZMVideoSDKMultiCameraStreamStatus_JoinStart,
    ZMVideoSDKMultiCameraStreamStatus_JoinFail,
    ZMVideoSDKMultiCameraStreamStatus_Joined,
    ZMVideoSDKMultiCameraStreamStatus_Left,
    ZMVideoSDKMultiCameraStreamStatus_VideoOn,
    ZMVideoSDKMultiCameraStreamStatus_VideoOff
}ZMVideoSDKMultiCameraStreamStatus;

ZMVideoSDKNetworkStatus

enum ZMVideoSDKNetworkStatus

Enumerates the network statuses.

Enumerator
ZMVideoSDKNetworkStatus_None	For initialization.
ZMVideoSDKNetworkStatus_Bad	The network connection is poor, affecting video quality.
ZMVideoSDKNetworkStatus_Normal	The network connection is stable with typical performance.
ZMVideoSDKNetworkStatus_Good	The network connection is strong and stable, providing optimal performance.

Definition at line 654 of file ZMVideoSDKDef.h.

{
    ZMVideoSDKNetworkStatus_None,
    ZMVideoSDKNetworkStatus_Bad,
    ZMVideoSDKNetworkStatus_Normal,
    ZMVideoSDKNetworkStatus_Good
}ZMVideoSDKNetworkStatus;

ZMVideoSDKPreferVideoResolution

enum ZMVideoSDKPreferVideoResolution

Enumeration of preferred video resolution in Zoom Video SDK.

Enumerator
ZMVideoSDKPreferVideoResolution_None	Invalid value.
ZMVideoSDKPreferVideoResolution_360P	The camera opens in 360p by default.
ZMVideoSDKPreferVideoResolution_720P	The camera opens in 720p by default.
ZMVideoSDKPreferVideoResolution_1080P	The camera opens in 1080p by default.

Definition at line 1039 of file ZMVideoSDKDef.h.

{
    ZMVideoSDKPreferVideoResolution_None,
    ZMVideoSDKPreferVideoResolution_360P,
    ZMVideoSDKPreferVideoResolution_720P,
    ZMVideoSDKPreferVideoResolution_1080P
}ZMVideoSDKPreferVideoResolution;

ZMVideoSDKRawDataMemoryMode

enum ZMVideoSDKRawDataMemoryMode

Enumeration of memory modes for raw data handling.

Enumerator
ZMVideoSDKRawDataMemoryMode_Stack	The memory mode is srack.
ZMVideoSDKRawDataMemoryMode_Heap	The memory mode is heap.

Definition at line 300 of file ZMVideoSDKDef.h.

{
    ZMVideoSDKRawDataMemoryMode_Stack,
    ZMVideoSDKRawDataMemoryMode_Heap
}ZMVideoSDKRawDataMemoryMode;

ZMVideoSDKRawDataStatus

enum ZMVideoSDKRawDataStatus

Enumeration the statuses of raw data.

Enumerator
ZMVideoSDKRawData_On	The raw data status is on.
ZMVideoSDKRawData_Off	The raw data status if off.

Definition at line 311 of file ZMVideoSDKDef.h.

{
    ZMVideoSDKRawData_On,
    ZMVideoSDKRawData_Off
}ZMVideoSDKRawDataStatus;

ZMVideoSDKRawDataType

enum ZMVideoSDKRawDataType

Enumeration of raw data types.

Enumerator
ZMVideoSDKRawDataType_Video	Video raw data.
ZMVideoSDKRawDataType_Share	Share raw data.

Definition at line 270 of file ZMVideoSDKDef.h.

{
    ZMVideoSDKRawDataType_Video = 0,
    ZMVideoSDKRawDataType_Share
}ZMVideoSDKRawDataType;

ZMVideoSDKRealTimeMediaStreamsFailReason

enum ZMVideoSDKRealTimeMediaStreamsFailReason

Failure reasons for RealTimeMediaStreams. Here are more detailed structural descriptions.

Enumerator
ZMVideoSDKRealTimeMediaStreamsFailReason_None	Default value, no error (initial state)
ZMVideoSDKRealTimeMediaStreamsFailReason_NoSubscription	No one subscribed to the RTMS stream
ZMVideoSDKRealTimeMediaStreamsFailReason_StartFail	Failed to start the RTMS stream

Definition at line 1168 of file ZMVideoSDKDef.h.

{
    ZMVideoSDKRealTimeMediaStreamsFailReason_None = 0,
    ZMVideoSDKRealTimeMediaStreamsFailReason_NoSubscription,
    ZMVideoSDKRealTimeMediaStreamsFailReason_StartFail
}ZMVideoSDKRealTimeMediaStreamsFailReason;

ZMVideoSDKRealTimeMediaStreamsStatus

enum ZMVideoSDKRealTimeMediaStreamsStatus

real-time media streams status. Here are more detailed structural descriptions.

Enumerator
ZMVideoSDKRealTimeMediaStreamsStatus_None	No real-time media streams activity.
ZMVideoSDKRealTimeMediaStreamsStatus_Start	Real-time media streams has started.
ZMVideoSDKRealTimeMediaStreamsStatus_Pause	Real-time media streams has been paused.
ZMVideoSDKRealTimeMediaStreamsStatus_Stop	Real-time media streams has been stopped.

Definition at line 1152 of file ZMVideoSDKDef.h.

{
    ZMVideoSDKRealTimeMediaStreamsStatus_None = 0,
    ZMVideoSDKRealTimeMediaStreamsStatus_Start,
    ZMVideoSDKRealTimeMediaStreamsStatus_Pause,
    ZMVideoSDKRealTimeMediaStreamsStatus_Stop
}ZMVideoSDKRealTimeMediaStreamsStatus;

ZMVideoSDKRemoteControlStatus

enum ZMVideoSDKRemoteControlStatus

Enumerates the statuses for remote control.

Enumerator
ZMVideoSDKRemoteControlStatus_None	For initialization.
ZMVideoSDKRemoteControlStatus_CanRequestControl	Remote control information. I can enable the remote control.
ZMVideoSDKRemoteControlStatus_RequestDenied	Remote control information. I have received a refused information of remote control.
ZMVideoSDKRemoteControlStatus_GotControl	The authority of remote control. I get control when remote control begins.
ZMVideoSDKRemoteControlStatus_LostControl	The authority of remote control. I lose control when remote control ends.
ZMVideoSDKRemoteControlStatus_ControlStart	The status of remote control. I am remotely controlling another.
ZMVideoSDKRemoteControlStatus_ControlStop	The status of remote control. I am not remotely controlling another.
ZMVideoSDKRemoteControlStatus_GiveControlTo	The status of remote control. I can be controlled by the specified user.
ZMVideoSDKRemoteControlStatus_ControlRevoked	The status of remote control. I have revoked remote control.
ZMVideoSDKRemoteControlStatus_ControlledBy	The status of remote control. I am being controlled by the specified user.
ZMVideoSDKRemoteControlStatus_NotControlled	The status of remote control. I am not being controlled.

Definition at line 927 of file ZMVideoSDKDef.h.

{
    ZMVideoSDKRemoteControlStatus_None = 0,
    ZMVideoSDKRemoteControlStatus_CanRequestControl,
    ZMVideoSDKRemoteControlStatus_RequestDenied,
    ZMVideoSDKRemoteControlStatus_GotControl,
    ZMVideoSDKRemoteControlStatus_LostControl,
    ZMVideoSDKRemoteControlStatus_ControlStart,
    ZMVideoSDKRemoteControlStatus_ControlStop,
    ZMVideoSDKRemoteControlStatus_GiveControlTo,
    ZMVideoSDKRemoteControlStatus_ControlRevoked,
    ZMVideoSDKRemoteControlStatus_ControlledBy,
    ZMVideoSDKRemoteControlStatus_NotControlled
}ZMVideoSDKRemoteControlStatus;

ZMVideoSDKResolution

enum ZMVideoSDKResolution

Enumeration of render resolution.

Enumerator
ZMVideoSDKResolution_90P	The resolution is 90p.
ZMVideoSDKResolution_180P	The resolution is 180p.
ZMVideoSDKResolution_360P	The resolution is 360p.
ZMVideoSDKResolution_720P	The resolution is 720p. Video resolution might be 1080p based on the user's network condition and device specs.
ZMVideoSDKResolution_1080P	The resolution is 1080p. Video resolution might be 720p based on the user's network condition and device specs.
ZMVideoSDKResolution_Auto	The resolution is changed automatically according to the size of the view, only avaliable for video canvas.

Definition at line 281 of file ZMVideoSDKDef.h.

{
    ZMVideoSDKResolution_90P = 0,
    ZMVideoSDKResolution_180P,
    ZMVideoSDKResolution_360P,
    ZMVideoSDKResolution_720P,
    ZMVideoSDKResolution_1080P,
    ZMVideoSDKResolution_Auto = 100
}ZMVideoSDKResolution;

ZMVideoSDKScreenCaptureMode

enum ZMVideoSDKScreenCaptureMode

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
ZMVideoSDKScreenCaptureMode_Auto	Automatically choose the best method to use for screen share.
ZMVideoSDKScreenCaptureMode_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.
ZMVideoSDKScreenCaptureMode_Filtering	This mode will share your screen without showing windows from the app.
ZMVideoSDKScreenCaptureMode_ADA_Filtering	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.
ZMVideoSDKScreenCaptureMode_ADA_Without_Filtering	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 684 of file ZMVideoSDKDef.h.

{
    ZMVideoSDKScreenCaptureMode_Auto,
    ZMVideoSDKScreenCaptureMode_Legacy,
    ZMVideoSDKScreenCaptureMode_Filtering,
    ZMVideoSDKScreenCaptureMode_ADA_Filtering,
    ZMVideoSDKScreenCaptureMode_ADA_Without_Filtering
}ZMVideoSDKScreenCaptureMode;

ZMVideoSDKSessionLeaveReason

enum ZMVideoSDKSessionLeaveReason

Enumerates the possible reasons for leaving a session.

Enumerator
ZMVideoSDKSessionLeaveReason_Unknown	Unknown
ZMVideoSDKSessionLeaveReason_BySelf	Leave session by self.
ZMVideoSDKSessionLeaveReason_KickByHost	Kicked by host.
ZMVideoSDKSessionLeaveReason_EndByHost	Ended by host.
ZMVideoSDKSessionLeaveReason_NetworkError	Network is broken.

Definition at line 910 of file ZMVideoSDKDef.h.

{
    ZMVideoSDKSessionLeaveReason_Unknown = 0,
    ZMVideoSDKSessionLeaveReason_BySelf,
    ZMVideoSDKSessionLeaveReason_KickByHost,
    ZMVideoSDKSessionLeaveReason_EndByHost,
    ZMVideoSDKSessionLeaveReason_NetworkError
}ZMVideoSDKSessionLeaveReason;

ZMVideoSDKSessionType

enum ZMVideoSDKSessionType

Enumeration of session type.

Enumerator
ZMVideoSDKSessionType_MainSession	The session type is main session.
ZMVideoSDKSessionType_SubSession	The session type is subsession.

Definition at line 983 of file ZMVideoSDKDef.h.

{
    ZMVideoSDKSessionType_MainSession = 0,
    ZMVideoSDKSessionType_SubSession
}ZMVideoSDKSessionType;

ZMVideoSDKShareCapturePauseReason

enum ZMVideoSDKShareCapturePauseReason

Enumeration of reasons why screen sharing capture is paused in the Zoom Video SDK.

Enumerator
ZMVideoSDKShare_Capture_Pause_None	No pause reason; used for initialization.
ZMVideoSDKShare_Capture_Pause_WindowMoving	Sharing is paused because the shared window is being moved.
ZMVideoSDKShare_Capture_Pause_WindowCovered	Sharing is paused because the shared window is covered by another window.
ZMVideoSDKShare_Capture_Pause_WindowMinimized	Sharing is paused because the shared window is minimized.

Definition at line 555 of file ZMVideoSDKDef.h.

{
    ZMVideoSDKShare_Capture_Pause_None,
    ZMVideoSDKShare_Capture_Pause_WindowMoving,
    ZMVideoSDKShare_Capture_Pause_WindowCovered,
    ZMVideoSDKShare_Capture_Pause_WindowMinimized
}ZMVideoSDKShareCapturePauseReason;

ZMVideoSDKSharePreprocessType

enum ZMVideoSDKSharePreprocessType

Enumeration of share preprocess types.

Enumerator
ZMVideoSDKSharePreprocessType_None	For initialization.
ZMVideoSDKSharePreprocessType_Screen	For share screen(monitor).
ZMVideoSDKSharePreprocessType_View	For share view(application window).
ZMVideoSDKSharePreprocessType_Process	For share process(application).

Definition at line 1009 of file ZMVideoSDKDef.h.

{
    ZMVideoSDKSharePreprocessType_None = 0,
    ZMVideoSDKSharePreprocessType_Screen,
    ZMVideoSDKSharePreprocessType_View,
    ZMVideoSDKSharePreprocessType_Process
}ZMVideoSDKSharePreprocessType;

ZMVideoSDKShareSetting

enum ZMVideoSDKShareSetting

Enumeration of Zoom Video SDK share setting types.

Enumerator
ZMVideoSDKShareSetting_None	For initialization.
ZMVideoSDKShareSetting_LockedShare	Only host and manager can share.
ZMVideoSDKShareSetting_SingleShare	Anyone can share, but only one at a time. Only host and manager can take over.
ZMVideoSDKShareSetting_MultiShare	Multiple participants can share simultaneously.

Definition at line 1024 of file ZMVideoSDKDef.h.

{
    ZMVideoSDKShareSetting_None = 0,
    ZMVideoSDKShareSetting_LockedShare,
    ZMVideoSDKShareSetting_SingleShare,
    ZMVideoSDKShareSetting_MultiShare
}ZMVideoSDKShareSetting;

ZMVideoSDKShareStatus

enum ZMVideoSDKShareStatus

Enumerates the status of sharing.

Enumerator
ZMVideoSDKShareStatus_None	No view or screen share available.
ZMVideoSDKShareStatus_Start	User started sharing.
ZMVideoSDKShareStatus_Pause	User paused sharing.
ZMVideoSDKShareStatus_Resume	User resumed sharing.
ZMVideoSDKShareStatus_Stop	User stopped sharing.

Definition at line 234 of file ZMVideoSDKDef.h.

{
    ZMVideoSDKShareStatus_None,
    ZMVideoSDKShareStatus_Start,
    ZMVideoSDKShareStatus_Pause,
    ZMVideoSDKShareStatus_Resume,
    ZMVideoSDKShareStatus_Stop
}ZMVideoSDKShareStatus;

ZMVideoSDKShareType

enum ZMVideoSDKShareType

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

Enumerator
ZMVideoSDKShareType_None
ZMVideoSDKShareType_Normal	Application or desktop share.
ZMVideoSDKShareType_PureAudio	Pure computer audio share.
ZMVideoSDKShareType_Camera	Camera share.

Definition at line 541 of file ZMVideoSDKDef.h.

{
    ZMVideoSDKShareType_None,
    ZMVideoSDKShareType_Normal,
    ZMVideoSDKShareType_PureAudio,
    ZMVideoSDKShareType_Camera
}ZMVideoSDKShareType;

ZMVideoSDKStreamingJoinStatus

enum ZMVideoSDKStreamingJoinStatus

Enumerations of streaming join status.

Enumerator
ZMVideoSDKStreamingJoinStatus_None	Initialized status.
ZMVideoSDKStreamingJoinStatus_Connecting	Connecting to streaming.
ZMVideoSDKStreamingJoinStatus_Joined	Joined streaming.
ZMVideoSDKStreamingJoinStatus_Disconnecting	Disconnecting from streaming.
ZMVideoSDKStreamingJoinStatus_Reconnecting	Reconnecting to streaming.
ZMVideoSDKStreamingJoinStatus_Failed	Join failed.
ZMVideoSDKStreamingJoinStatus_Left	Left streaming.

Definition at line 1091 of file ZMVideoSDKDef.h.

{
    ZMVideoSDKStreamingJoinStatus_None,
    ZMVideoSDKStreamingJoinStatus_Connecting,
    ZMVideoSDKStreamingJoinStatus_Joined,
    ZMVideoSDKStreamingJoinStatus_Disconnecting,
    ZMVideoSDKStreamingJoinStatus_Reconnecting,
    ZMVideoSDKStreamingJoinStatus_Failed,
    ZMVideoSDKStreamingJoinStatus_Left
}ZMVideoSDKStreamingJoinStatus;

ZMVideoSDKSubscribeFailReason

enum ZMVideoSDKSubscribeFailReason

Enumerates the reasons for a failed video subscription attempt.

Enumerator
ZMVideoSDKSubscribeFailReason_None	No subscription failure (initial state).
ZMVideoSDKSubscribeFailReason_HasSubscribe1080POr720P	The subscription attempt failed because has already subscribed to a 1080P or 720P video stream.
ZMVideoSDKSubscribeFailReason_HasSubscribeTwo720P	The subscription attempt failed because has already subscribed to two 720P video streams.
ZMVideoSDKSubscribeFailReason_HasSubscribeExceededLimit	The subscription attempt failed because has exceeded the maximum allowed subscription limit.
ZMVideoSDKSubscribeFailReason_HasSubscribeTwoShare	The subscription attempt failed because has already subscribed to two shared video streams.
ZMVideoSDKSubscribeFailReason_HasSubscribeVideo1080POr720PAndOneShare	The subscription attempt failed because has already subscribed to one 1080P or 720P video stream and one shared video stream.
ZMVideoSDKSubscribeFailReason_TooFrequentCall	The subscription attempt failed because subscription requests were made too frequently in a short period of time.

Definition at line 769 of file ZMVideoSDKDef.h.

            {
    ZMVideoSDKSubscribeFailReason_None = 0,
    ZMVideoSDKSubscribeFailReason_HasSubscribe1080POr720P,
    ZMVideoSDKSubscribeFailReason_HasSubscribeTwo720P,
    ZMVideoSDKSubscribeFailReason_HasSubscribeExceededLimit,
    ZMVideoSDKSubscribeFailReason_HasSubscribeTwoShare,
    ZMVideoSDKSubscribeFailReason_HasSubscribeVideo1080POr720PAndOneShare,
    ZMVideoSDKSubscribeFailReason_TooFrequentCall
} ZMVideoSDKSubscribeFailReason;

ZMVideoSDKSubSessionStatus

enum ZMVideoSDKSubSessionStatus

Enumeration of subsession statuses.

Enumerator
ZMVideoSDKSubSessionStatus_None	The Initialized status.
ZMVideoSDKSubSessionStatus_Committed	When a subsession is committed.
ZMVideoSDKSubSessionStatus_Withdrawn	When a subsession is withdrawn.
ZMVideoSDKSubSessionStatus_Started	When the subsession is started.
ZMVideoSDKSubSessionStatus_Stopping	When the subsession is stopping.
ZMVideoSDKSubSessionStatus_Stopped	When the subsession is stopped.
ZMVideoSDKSubSessionStatus_CommitFailed	When commit subsession failed.
ZMVideoSDKSubSessionStatus_WithdrawFailed	When withdraw subsession failed.
ZMVideoSDKSubSessionStatus_StartFailed	When start subsession failed.
ZMVideoSDKSubSessionStatus_StopFailed	When stop subsession failed.

Definition at line 956 of file ZMVideoSDKDef.h.

{
    ZMVideoSDKSubSessionStatus_None,
    ZMVideoSDKSubSessionStatus_Committed,
    ZMVideoSDKSubSessionStatus_Withdrawn,
    ZMVideoSDKSubSessionStatus_Started,
    ZMVideoSDKSubSessionStatus_Stopping,
    ZMVideoSDKSubSessionStatus_Stopped,
    ZMVideoSDKSubSessionStatus_CommitFailed,
    ZMVideoSDKSubSessionStatus_WithdrawFailed,
    ZMVideoSDKSubSessionStatus_StartFailed,
    ZMVideoSDKSubSessionStatus_StopFailed
}ZMVideoSDKSubSessionStatus;

ZMVideoSDKSuppressBackgroundNoiseLevel

enum ZMVideoSDKSuppressBackgroundNoiseLevel

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
ZMVideoSDKSuppressBackgroundNoiseLevel_Auto	Automatically adjust noise suppression.
ZMVideoSDKSuppressBackgroundNoiseLevel_Low	Low level suppression. Allows faint background.
ZMVideoSDKSuppressBackgroundNoiseLevel_Medium	Medium level suppression. Filters out moderate noise like computer fan or desk taps.
ZMVideoSDKSuppressBackgroundNoiseLevel_High	High level suppression. Eliminates most background speech and persistent noise.

Definition at line 451 of file ZMVideoSDKDef.h.

{
    ZMVideoSDKSuppressBackgroundNoiseLevel_Auto = 0,
    ZMVideoSDKSuppressBackgroundNoiseLevel_Low,
    ZMVideoSDKSuppressBackgroundNoiseLevel_Medium,
    ZMVideoSDKSuppressBackgroundNoiseLevel_High
}ZMVideoSDKSuppressBackgroundNoiseLevel;

ZMVideoSDKUserHelpRequestResult

enum ZMVideoSDKUserHelpRequestResult

Enumeration of subsession user help request results.

Enumerator
ZMVideoSDKUserHelpRequestResult_Idle	The host has received the help request, and no one else is currently requesting help.
ZMVideoSDKUserHelpRequestResult_Busy	The host is handling another user's request with the request dialog.
ZMVideoSDKUserHelpRequestResult_Ignore	The host is handling another user's request.
ZMVideoSDKUserHelpRequestResult_HostAlreadyInSubSession	The host is already in this subsession.

Definition at line 994 of file ZMVideoSDKDef.h.

{
    ZMVideoSDKUserHelpRequestResult_Idle,
    ZMVideoSDKUserHelpRequestResult_Busy,
    ZMVideoSDKUserHelpRequestResult_Ignore,
    ZMVideoSDKUserHelpRequestResult_HostAlreadyInSubSession
}ZMVideoSDKUserHelpRequestResult;

ZMVideoSDKVideoAspect

enum ZMVideoSDKVideoAspect

Enumeration of the video aspect ratio.

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

Definition at line 702 of file ZMVideoSDKDef.h.

{
    ZMVideoSDKVideoAspect_Original,
    ZMVideoSDKVideoAspect_Full_Filled,
    ZMVideoSDKVideoAspect_LetterBox,
    ZMVideoSDKVideoAspect_PanAndScan,
}ZMVideoSDKVideoAspect;

ZMVideoSDKVideoPreferenceMode

enum ZMVideoSDKVideoPreferenceMode

Enumerates the video preference modes.

Enumerator
ZMVideoSDKVideoPreferenceMode_Balance	Balance mode.
ZMVideoSDKVideoPreferenceMode_Sharpness	Sharpness mode, prioritizing video clarity.
ZMVideoSDKVideoPreferenceMode_Smoothness	Smoothness mode, focusing on a smooth video experience.
ZMVideoSDKVideoPreferenceMode_Custom	Custom mode, allowing user-defined video preferences.

Definition at line 349 of file ZMVideoSDKDef.h.

{
    ZMVideoSDKVideoPreferenceMode_Balance,
    ZMVideoSDKVideoPreferenceMode_Sharpness,
    ZMVideoSDKVideoPreferenceMode_Smoothness,
    ZMVideoSDKVideoPreferenceMode_Custom
}ZMVideoSDKVideoPreferenceMode;

ZMVideoSDKVideoSourceDataMode

enum ZMVideoSDKVideoSourceDataMode

Enumerates the data modes for video source frames.

Enumerator
ZMVideoSDKVideoSourceDataMode_None	Default mode for general use cases (single image per frame).
ZMVideoSDKVideoSourceDataMode_Horizontal	Special mode where each video frame consists of two horizontally arranged images.
ZMVideoSDKVideoSourceDataMode_Vertical	Special mode where each video frame consists of two vertically stacked images.

Definition at line 570 of file ZMVideoSDKDef.h.

{
    ZMVideoSDKVideoSourceDataMode_None = 0,
    ZMVideoSDKVideoSourceDataMode_Horizontal,
    ZMVideoSDKVideoSourceDataMode_Vertical
}ZMVideoSDKVideoSourceDataMode;

ZMVideoSDKVirtualBackgroundDataType

enum ZMVideoSDKVirtualBackgroundDataType

Enumerates the types of virtual backgrounds.

Enumerator
ZMVideoSDKVirtualBackgroundDataType_None	No virtual background is applied.
ZMVideoSDKVirtualBackgroundDataType_Image	An image is used as the virtual background.
ZMVideoSDKVirtualBackgroundDataType_Blur	A blur effect is applied to the background.

Definition at line 628 of file ZMVideoSDKDef.h.

{
    ZMVideoSDKVirtualBackgroundDataType_None,
    ZMVideoSDKVirtualBackgroundDataType_Image,
    ZMVideoSDKVirtualBackgroundDataType_Blur
}ZMVideoSDKVirtualBackgroundDataType;

ZMVideoSDKWhiteboardStatus

enum ZMVideoSDKWhiteboardStatus

Enumeration of the status of whiteboard sharing.

Enumerator
ZMVideoSDKWhiteboardStatus_Started	The whiteboard has started.
ZMVideoSDKWhiteboardStatus_Stopped	The whiteboard has stopped.

Definition at line 1054 of file ZMVideoSDKDef.h.

{
    ZMVideoSDKWhiteboardStatus_Started,
    ZMVideoSDKWhiteboardStatus_Stopped
}ZMVideoSDKWhiteboardStatus;