Video SDK for iOS API Reference
Loading...
Searching...
No Matches
ZoomVideoSDKConstants.h
Go to the documentation of this file.
1
5#ifndef ZoomVideoSDKConstants_h
6#define ZoomVideoSDKConstants_h
7
11typedef NS_ENUM(NSUInteger,ZoomVideoSDKError)
12{
39
52
76
113
123
129
130
133
146
196
221
233};
234
245
259
273
283
299
317
327
341
357
367
377
403
404
430
448
462
480
490
508
518
533
546
547
562
575
588
598
616
620typedef NS_ENUM(NSUInteger,ZoomVideoSDKAnnotationToolType) {
679};
680
692
710
724
725
739
749
761
777
793
805
815
842
857
867
882
908
928
937
938
950
964
976
977
987
999
1013
1025
1026
1027#endif /* ZoomVideoSDKConstants_h */
ZoomVideoSDKLiveStreamStatus
Enumeration of live streaming statuses.
@ ZoomVideoSDKLiveStreamStatus_None
@ ZoomVideoSDKLiveStreamStatus_InProgress
@ ZoomVideoSDKLiveStreamStatus_StartFailed
@ ZoomVideoSDKLiveStreamStatus_Ended
@ ZoomVideoSDKLiveStreamStatus_FailedTimeout
@ ZoomVideoSDKLiveStreamStatus_Connecting
ZoomVideoSDKAnnotationClearType
Enumeration of the type for clear annotation.
@ ZoomVideoSDKAnnotationClearType_All
@ ZoomVideoSDKAnnotationClearType_Others
@ ZoomVideoSDKAnnotationClearType_My
ZoomVideoSDKWhiteboardExportFormatType
Enumeration of supported export formats for content, like whiteboard.
@ ZoomVideoSDKWhiteboardExport_Format_PDF
ZoomVideoSDKPhoneFailedReason
Enumeration of phone call failure reasons.
@ ZoomVideoSDKPhoneFailedReason_None
@ ZoomVideoSDKPhoneFailedReason_Block_High_Rate
@ ZoomVideoSDKPhoneFailedReason_User_Hangup
@ ZoomVideoSDKPhoneFailedReason_Other_Fail
@ ZoomVideoSDKPhoneFailedReason_Block_Too_Frequent
@ ZoomVideoSDKPhoneFailedReason_Not_Available
@ ZoomVideoSDKPhoneFailedReason_Busy
@ ZoomVideoSDKPhoneFailedReason_No_Answer
@ ZoomVideoSDKPhoneFailedReason_Block_No_Host
ZoomVideoSDKVirtualBackgroundDataType
Enumeration of virtual background types.
@ ZoomVideoSDKVirtualBackgroundDataType_Image
@ ZoomVideoSDKVirtualBackgroundDataType_Blur
@ ZoomVideoSDKVirtualBackgroundDataType_None
ZoomVideoSDKDataType
Enumeration of data types for network quality monitoring.
@ ZoomVideoSDKDataType_Share
@ ZoomVideoSDKDataType_Unknown
@ ZoomVideoSDKDataType_Audio
@ ZoomVideoSDKDataType_Video
ZoomVideoSDKSubscribeFailReason
Enumeration of video subscription failure reasons.
@ ZoomVideoSDKSubscribeFailReason_None
@ ZoomVideoSDKSubscribeFailReason_TooFrequentCall
@ ZoomVideoSDKSubscribeFailReason_HasSubscribeOneShare
@ ZoomVideoSDKSubscribeFailReason_HasSubscribeShare
@ ZoomVideoSDKSubscribeFailReason_HasSubscribe1080POr720P
@ ZoomVideoSDKSubscribeFailReason_HasSubscribeExceededLimit
ZoomVideoSDKAudioChannel
Enumeration of audio channel types.
@ ZoomVideoSDKAudioChannel_Mono
@ ZoomVideoSDKAudioChannel_Stereo
ZoomVideoSDKRecordAgreementType
Enumeration of cloud recording consent types.
@ ZoomVideoSDKRecordAgreementType_Invalid
@ ZoomVideoSDKRecordAgreementType_Traditional
@ ZoomVideoSDKRecordAgreementType_Individual_Only
ZoomVideoSDKCRCProtocol
Enumeration of Call CRC (Circuit-Reliable Communication) types.
@ ZoomVideoSDKCRCProtocol_H323
@ ZoomVideoSDKCRCProtocol_SIP
ZoomVideoSDKWhiteboardStatus
Enumeration of the status of the whiteboard sharing.
@ ZoomVideoSDKWhiteboardStatus_Started
@ ZoomVideoSDKWhiteboardStatus_Stopped
ZoomVideoSDKSharePreprocessType
Enumeration of share preprocess types.
@ ZoomVideoSDKSharePreprocessType_view
@ ZoomVideoSDKSharePreprocessType_none
ZoomVideoSDKAudioType
Enumeration of audio types.
@ ZoomVideoSDKAudioType_TELEPHONY
@ ZoomVideoSDKAudioType_VOIP
@ ZoomVideoSDKAudioType_Unknown
@ ZoomVideoSDKAudioType_None
ZoomVideoSDKUVCCameraStatus
Enumeration of the UVC camera status.
@ ZoomVideoSDKUVCCameraStatus_Attached
@ ZoomVideoSDKUVCCameraStatus_Detached
ZoomVideoSDKBroadcastControlStatus
Enumeration of the broadcast control status.
@ ZoomVideoSDKBroadcastControlStatus_Starting
@ ZoomVideoSDKBroadcastControlStatus_None
@ ZoomVideoSDKBroadcastControlStatus_Started
@ ZoomVideoSDKBroadcastControlStatus_Stopped
@ ZoomVideoSDKBroadcastControlStatus_Stopping
ZoomVideoSDKSubSessionStatus
Enumeration of subsession statuses.
@ ZoomVideoSDKSubSessionStatus_CommitFailed
@ ZoomVideoSDKSubSessionStatus_Started
@ ZoomVideoSDKSubSessionStatus_Stopping
@ ZoomVideoSDKSubSessionStatus_WithdrawFailed
@ ZoomVideoSDKSubSessionStatus_StopFailed
@ ZoomVideoSDKSubSessionStatus_StartFailed
@ ZoomVideoSDKSubSessionStatus_Withdrawn
@ ZoomVideoSDKSubSessionStatus_Stopped
@ ZoomVideoSDKSubSessionStatus_Committed
@ ZoomVideoSDKSubSessionStatus_None
ZoomVideoSDKFileTransferStatus
Enumeration of the file transfer status.
@ FileTransferState_TransferFailed
@ FileTransferState_ReadyToTransfer
@ FileTransferState_Transfering
@ FileTransferState_TransferDone
@ FileTransferState_None
ZoomVideoSDKMultiCameraStreamStatus
Enumeration of multi-camera stream statuses.
@ ZoomVideoSDKMultiCameraStreamStatus_JoinFail
@ ZoomVideoSDKMultiCameraStreamStatus_VideoOn
@ ZoomVideoSDKMultiCameraStreamStatus_Joined
@ ZoomVideoSDKMultiCameraStreamStatus_VideoOff
@ ZoomVideoSDKMultiCameraStreamStatus_Left
@ ZoomVideoSDKMultiCameraStreamStatus_JoinStart
ZoomVideoSDKVideoRawDataRotation
Enumeration of the directions of video raw data rotation.
@ ZoomVideoSDKVideoRawDataRotationNone
@ ZoomVideoSDKVideoRawDataRotation180
@ ZoomVideoSDKVideoRawDataRotation90
@ ZoomVideoSDKVideoRawDataRotation270
ZoomVideoSDKAnnotationToolType
Enumeration of the type for annotation tool. For more information, please visit https://support....
@ ZoomVideoSDKAnnotationToolType_AutoRectangleSemiFill
@ ZoomVideoSDKAnnotationToolType_VanishingArrow
@ ZoomVideoSDKAnnotationToolType_AutoEllipse
@ ZoomVideoSDKAnnotationToolType_ERASER
@ ZoomVideoSDKAnnotationToolType_Pen
@ ZoomVideoSDKAnnotationToolType_AutoEllipseSemiFill
@ ZoomVideoSDKAnnotationToolType_Arrow
@ ZoomVideoSDKAnnotationToolType_None
@ ZoomVideoSDKAnnotationToolType_AutoStampQm
@ ZoomVideoSDKAnnotationToolType_Picker
@ ZoomVideoSDKAnnotationToolType_AutoArrow
@ ZoomVideoSDKAnnotationToolType_AutoEllipseFill
@ ZoomVideoSDKAnnotationToolType_VanishingDiamond
@ ZoomVideoSDKAnnotationToolType_AutoStampArrow
@ ZoomVideoSDKAnnotationToolType_VanishingDoubleArrow
@ ZoomVideoSDKAnnotationToolType_AutoRectangle
@ ZoomVideoSDKAnnotationToolType_SpotLight
@ ZoomVideoSDKAnnotationToolType_AutoDiamond
@ ZoomVideoSDKAnnotationToolType_AutoLine
@ ZoomVideoSDKAnnotationToolType_AutoStampStar
@ ZoomVideoSDKAnnotationToolType_AutoRectangleFill
@ ZoomVideoSDKAnnotationToolType_VanishingEllipse
@ ZoomVideoSDKAnnotationToolType_VanishingRectangle
@ ZoomVideoSDKAnnotationToolType_AutoStampX
@ ZoomVideoSDKAnnotationToolType_VanishingPen
@ ZoomVideoSDKAnnotationToolType_HighLighter
@ ZoomVideoSDKAnnotationToolType_AutoDoubleArrow
@ ZoomVideoSDKAnnotationToolType_AutoStampHeart
@ ZoomVideoSDKAnnotationToolType_AutoStampCheck
ZoomVideoSDKUserHelpRequestResult
Enumeration of the subsession user help request results.
@ ZoomVideoSDKUserHelpRequestResult_Ignore
@ ZoomVideoSDKUserHelpRequestResult_Idle
@ ZoomVideoSDKUserHelpRequestResult_Busy
@ ZoomVideoSDKUserHelpRequestResult_HostAlreadyInSubSession
ZoomVideoSDKLiveStreamCloseCaption
Enumeration of the live stream close caption options.
@ ZoomVideoSDKLiveStreamCloseCaption_BurntIn
@ ZoomVideoSDKLiveStreamCloseCaption_OFF
@ ZoomVideoSDKLiveStreamCloseCaption_Embedded
ZoomVideoSDKChatPrivilegeType
Enumeration of chat privilege types.
@ ZoomVideoSDKChatPrivilege_Unknown
@ ZoomVideoSDKChatPrivilege_No_One
@ ZoomVideoSDKChatPrivilege_Everyone_Publicly
@ ZoomVideoSDKChatPrivilege_Everyone_Publicly_And_Privately
ZoomVideoSDKRealTimeMediaStreamsStatus
Enumeration of the real-time media streams status.
@ ZoomVideoSDKRealTimeMediaStreams_Pause
@ ZoomVideoSDKRealTimeMediaStreams_None
@ ZoomVideoSDKRealTimeMediaStreams_Stop
@ ZoomVideoSDKRealTimeMediaStreams_Start
ZoomVideoSDKPreferVideoResolution
Enumeration of the preferred video resolution in Zoom Video SDK.
@ ZoomVideoSDKPreferVideoResolution_None
@ ZoomVideoSDKPreferVideoResolution_720P
@ ZoomVideoSDKPreferVideoResolution_360P
ZoomVideoSDKSystemPermissionType
Enumeration of device permission types.
@ ZoomVideoSDKSystemPermissionType_Camera
@ ZoomVideoSDKSystemPermissionType_Microphone
ZoomVideoSDKRawDataMemoryMode
Enumeration of the memory modes for raw data handling.
@ ZoomVideoSDKRawDataMemoryModeStack
@ ZoomVideoSDKRawDataMemoryModeHeap
ZoomVideoSDKChatMsgDeleteBy
Enumeration of chat message delete types. The chat message delete types are sent in the onChatMsgDele...
@ ZoomVideoSDKChatMsgDeleteBy_HOST
@ ZoomVideoSDKChatMsgDeleteBy_DLP
@ ZoomVideoSDKChatMsgDeleteBy_SELF
@ ZoomVideoSDKChatMsgDeleteBy_NONE
ZoomVideoSDKLiveStreamLayout
Enumeration of live stream layout types.
@ ZoomVideoSDKLiveStreamLayout_GalleryView
@ ZoomVideoSDKLiveStreamLayout_SpeakerView
ZoomVideoSDKReceiveSharingStatus
Enumeration of the sharing status.
@ ZoomVideoSDKReceiveSharingStatus_None
@ ZoomVideoSDKReceiveSharingStatus_Resume
@ ZoomVideoSDKReceiveSharingStatus_Pause
@ ZoomVideoSDKReceiveSharingStatus_Start
@ ZoomVideoSDKReceiveSharingStatus_Stop
ZoomVideoSDKSessionLeaveReason
Enumeration of session leave reasons.
@ ZoomVideoSDKSessionLeaveReason_Unknown
@ ZoomVideoSDKSessionLeaveReason_BySelf
@ ZoomVideoSDKSessionLeaveReason_KickByHost
@ ZoomVideoSDKSessionLeaveReason_NetworkError
@ ZoomVideoSDKSessionLeaveReason_EndByHost
ZoomVideoSDKFrameDataFormat
Enumeration of the raw data formats. Defines the color space format and color range for video frames.
@ ZoomVideoSDKFrameDataFormat_I420
@ ZoomVideoSDKFrameDataFormat_I420_Limit
ZoomVideoSDKVideoPreferenceMode
Enumeration of video preference modes.
@ ZoomVideoSDKVideoPreferenceMode_Smoothness
@ ZoomVideoSDKVideoPreferenceMode_Custom
@ ZoomVideoSDKVideoPreferenceMode_Sharpness
@ ZoomVideoSDKVideoPreferenceMode_Balance
ZoomVideoSDKShareType
Enumeration of content types that can be shared in a session.
@ ZoomVideoSDKShareType_Camera
@ ZoomVideoSDKShareType_Normal
@ ZoomVideoSDKShareType_PureAudio
@ ZoomVideoSDKShareType_None
ZoomVideoSDKVideoResolution
Enumeration of the render resolution.
@ ZoomVideoSDKVideoResolution_180
@ ZoomVideoSDKVideoResolution_720
@ ZoomVideoSDKVideoResolution_Auto
@ ZoomVideoSDKVideoResolution_90
@ ZoomVideoSDKVideoResolution_360
ZoomVideoSDKVideoType
Enumeration of the video type.
@ ZoomVideoSDKVideoType_VideoData
@ ZoomVideoSDKVideoType_ShareData
ZoomVideoSDKLiveTranscriptionOperationType
Enumeration of live transcription operation types.
@ ZoomVideoSDKLiveTranscriptionOperationType_Delete
@ ZoomVideoSDKLiveTranscriptionOperationType_Update
@ ZoomVideoSDKLiveTranscriptionOperationType_Complete
@ ZoomVideoSDKLiveTranscriptionOperationType_NotSupported
@ ZoomVideoSDKLiveTranscriptionOperationType_Add
@ ZoomVideoSDKLiveTranscriptionOperationType_None
ZoomVideoSDKSessionType
Enumeration of the session type.
@ ZoomVideoSDKSessionType_MainSession
@ ZoomVideoSDKSessionType_SubSession
ZoomVideoSDKError
Enumeration of all the errors in the VideoSDK.
@ Errors_Unknown
@ Errors_Session_Video_Device_Error
@ Errors_JoinSession_Invalid_Password
@ Errors_Fail_Assign_User_Privilege
@ Errors_Share_Module_Error
@ Errors_Session_Phone_Error
@ Errors_Rawdata_Virtual_Mic_Is_Terminate
@ Errors_Dont_Support_Feature
@ Errors_JoinSession_Token_UserIdentity_TooLong
@ Errors_Malloc_Failed
@ Errors_Session_Service_Invalid
@ Errors_Rawdata_Share_Preprocessing_Is_Stopped
@ Errors_Rawdata_Virtual_Device
@ Errors_UnLoad_Module_Error
@ Errors_No_Audio_Data
@ Errors_Session_Filetransfer_FileSizelimited
@ Errors_No_Video_Data
@ Errors_Session_Share_Camera_Conflict_With_Video_Effects
@ Errors_Success
@ Errors_Session_Disconnecting
@ Errors_Recording_Is_Connecting
@ Errors_Not_In_Session
@ Errors_Session_Share_Module_Not_Ready
@ Errors_Rawdata_Send_Too_Much_Data_In_Single_Time
@ Errors_Session_Remote_DB_Error
@ Errors_Set_Virtual_Background_Fail
@ Errors_Session_Base
@ Errors_Spotlight_UserNotSpotlighted
@ Errors_Uninitialize
@ Errors_JoinSession_NoSessionName
@ Errors_Session_Dont_Support_SessionType
@ Errors_Session_Account_FreeMinutesExceeded
@ Errors_Session_Audio_No_Speaker
@ Errors_Auth_Disable_SDK
@ Errors_Session_You_Have_No_Share
@ Errors_JoinSession_Token_RoleType_EmptyOrWrong
@ Errors_Session_Share_Camera_Video_Not_Start
@ Errors_Session_Share_Conflict_With_Whiteboard
@ Errors_Session_Client_Incompatible
@ Errors_Session_No_Rights
@ Errors_Call_Too_Frequently
@ Errors_Session_Live_Stream_Error
@ Errors_Session_Need_Password
@ Errors_JoinSession_SessionName_TooLong
@ Errors_Session_Filetransfer_UnknownError
@ Errors_Load_Module_Error
@ Errors_Session_Share_Internal_Error
@ Errors_Share_Module_Not_Ready
@ Errors_Rawdata_No_Device_Running
@ Errors_Rawdata_Internal_Error
@ Errors_JoinSession_Token_NoSessionName
@ Errors_Rawdata_Invalid_Share_Preprocessing_Data_Object
@ Errors_Auth_DoesNot_Support_SDK
@ Errors_Session_Bluetooth_SCO_Connection_Failed
@ Errors_Session_Not_Started
@ Errors_Session_Audio_Error
@ Errors_Audio_Module_Error
@ Errors_Session_Join_Failed
@ Errors_Session_Share_Type_Is_Not_Support
@ Errors_Memory_Error
@ Errors_Rawdata_Send_Too_Frequently
@ Errors_Internal_Error
@ Errors_Session_Filetransfer_FileTypeBlocked
@ Errors_Session_Share_You_Are_Not_Sharing
@ Errors_Session_Share_Error
@ Errors_Preprocess_Rawdata_Error
@ Errors_Session_Module_Not_Found
@ Errors_Invalid_Parameter
@ Errors_Auth_Wrong_Key_or_Secret
@ Errors_Spotlight_NotEnoughUsers
@ Errors_Session_Password_Wrong
@ Errors_JoinSession_NoUserName
@ Errors_Dont_Support_Multi_Stream_Video_User
@ Errors_Spotlight_UserCannotBeSpotlighted
@ Errors_Wrong_Usage
@ Errors_No_Impl
@ Errors_JoinSession_Invalid_SessionName
@ Errors_Spotlight_UserWithoutVideo
@ Errors_JoinSession_Token_MismatchedSessionName
@ Errors_Video_Module_Not_Ready
@ Errors_Session_Account_FreeCreditExceeded
@ Errors_Remove_Folder_Fail
@ Errors_No_License
@ Errors_Auth_Empty_Key_or_Secret
@ Errors_Rawdata_Cannot_Change_Virtual_Device_In_Preview
@ Errors_JoinSession_NoSessionToken
@ Errors_Session_Already_In_Progress
@ Errors_Session_Audio_No_Microphone
@ Errors_Auth_Error
@ Errors_No_Recording_In_Process
@ Errors_Video_Module_Error
@ Errors_Auth_Base
@ Errors_Rawdata_Init_Device
@ Errors_Video_device_error
@ Errors_Spotlight_ToMuchSpotlightedUsers
@ Errors_Session_Reconnecting
@ Errors_Audio_Module_Not_Ready
@ Errors_Session_Invalid_Param
@ Errors_Session_Video_Error
@ Errors_JoinSession_Invalid_SessionToken
@ Errors_No_Share_Data
ZoomVideoSDKVideoAspect
Enumeration of the video aspect ratio.
@ ZoomVideoSDKVideoAspect_Original
@ ZoomVideoSDKVideoAspect_Full_Filled
@ ZoomVideoSDKVideoAspect_PanAndScan
@ ZoomVideoSDKVideoAspect_LetterBox
ZoomVideoSDKTestMicStatus
Enumeration of the microphone test statuses.
@ ZoomVideoSDKMic_CanPlay
@ ZoomVideoSDKMic_Recording
@ ZoomVideoSDKMic_CanTest
ZoomVideoSDKCRCCallStatus
Enumeration of CRC call statuses.
@ ZoomVideoSDKCRCCallStatus_Success
@ ZoomVideoSDKCRCCallStatus_Timeout
@ ZoomVideoSDKCRCCallStatus_Ring
@ ZoomVideoSDKCRCCallStatus_Decline
@ ZoomVideoSDKCRCCallStatus_Failed
@ ZoomVideoSDKCRCCallStatus_Busy
ZoomVideoSDKRealTimeMediaStreamsFailReason
Enumeration of failure reasons for RealTimeMediaStreams.
@ ZoomVideoSDKRealTimeMediaStreamsFailReason_None
@ ZoomVideoSDKRealTimeMediaStreamsFailReason_NoSubscription
@ ZoomVideoSDKRealTimeMediaStreamsFailReason_StartFail
ZoomVideoSDKMaskShape
Enumeration of the mask shape.
@ ZoomVideoSDKMaskShape_Circle
@ ZoomVideoSDKMaskShape_Oval
@ ZoomVideoSDKMaskShape_Rectangle
ZoomVideoSDKStreamingJoinStatus
Enumeration of the streaming join status.
@ ZoomVideoSDKStreamingJoinStatus_Reconnecting
@ ZoomVideoSDKStreamingJoinStatus_Joined
@ ZoomVideoSDKStreamingJoinStatus_None
@ ZoomVideoSDKStreamingJoinStatus_Disconnecting
@ ZoomVideoSDKStreamingJoinStatus_Connecting
@ ZoomVideoSDKStreamingJoinStatus_Left
@ ZoomVideoSDKStreamingJoinStatus_Failed
ZoomVideoSDKRecordingStatus
Enumeration of the recording status.
@ ZoomVideoSDKRecordingStatus_Connecting
@ ZoomVideoSDKRecordingStatus_DiskFull
@ ZoomVideoSDKRecordingStatus_Pause
@ ZoomVideoSDKRecordingStatus_None
@ ZoomVideoSDKRecordingStatus_Stop
@ ZoomVideoSDKRecordingStatus_Start
ZoomVideoSDKNetworkStatus
Enumeration of network statuses.
@ ZoomVideoSDKNetworkStatus_Good
@ ZoomVideoSDKNetworkStatus_Bad
@ ZoomVideoSDKNetworkStatus_Normal
@ ZoomVideoSDKNetworkStatus_None
ZoomVideoSDKUserRawdataStatus
Enumeration of raw data statuses.
@ ZoomVideoSDKUserRawdataOff
@ ZoomVideoSDKUserRawdataOn
ZoomVideoSDKPhoneStatus
Enumeration of phone call statuses.
@ ZoomVideoSDKPhoneStatus_None
@ ZoomVideoSDKPhoneStatus_Failed
@ ZoomVideoSDKPhoneStatus_Timeout
@ ZoomVideoSDKPhoneStatus_Canceled
@ ZoomVideoSDKPhoneStatus_Calling
@ ZoomVideoSDKPhoneStatus_Cancel_Failed
@ ZoomVideoSDKPhoneStatus_Success
@ ZoomVideoSDKPhoneStatus_Ringing
@ ZoomVideoSDKPhoneStatus_Canceling
@ ZoomVideoSDKPhoneStatus_Accepted
ZoomVideoSDKShareSetting
Enumeration of Zoom Video SDK share setting types.
@ ZoomVideoSDKShareSetting_LockedShare
@ ZoomVideoSDKShareSetting_SingleShare
@ ZoomVideoSDKShareSetting_MultiShare
@ ZoomVideoSDKShareSetting_None
ZoomVideoSDKLiveTranscriptionStatus
Enumeration of the live transcription status.
@ ZoomVideoSDKLiveTranscriptionStatus_Stop
@ ZoomVideoSDKLiveTranscriptionStatus_Start
ZoomVideoSDKDialInNumType
Enumeration of the number types for calling to join the audio into a meeting.
@ ZoomVideoSDKDialInNumType_None
@ ZoomVideoSDKDialInNumType_TollFree
@ ZoomVideoSDKDialInNumType_Toll