ZoomVideoSDKConstants.h

Go to the documentation of this file.

//
//  ZoomVideoSDKConstants.h
//  ZoomVideoSDK
//
#ifndef ZoomVideoSDKConstants_h
#define ZoomVideoSDKConstants_h
 
typedef NS_ENUM(NSUInteger,ZoomVideoSDKError)
{
    Errors_Success = 0,
    Errors_Wrong_Usage,
    Errors_Internal_Error,
    Errors_Uninitialize,
    Errors_Memory_Error,
    Errors_Load_Module_Error,
    Errors_UnLoad_Module_Error,
    Errors_Invalid_Parameter,
    Errors_Call_Too_Frequently,
    Errors_No_Impl,
    Errors_Dont_Support_Feature,
    Errors_Unknown,
    Errors_Remove_Folder_Fail,
    Errors_Auth_Base = 1000,
    Errors_Auth_Error,
    Errors_Auth_Empty_Key_or_Secret,
    Errors_Auth_Wrong_Key_or_Secret,
    Errors_Auth_DoesNot_Support_SDK,
    Errors_Auth_Disable_SDK,
    Errors_JoinSession_NoSessionName = 1500,
    Errors_JoinSession_NoSessionToken,
    Errors_JoinSession_NoUserName,
    Errors_JoinSession_Invalid_SessionName,
    Errors_JoinSession_Invalid_Password,
    Errors_JoinSession_Invalid_SessionToken,
    Errors_JoinSession_SessionName_TooLong,
    Errors_JoinSession_Token_MismatchedSessionName,
    Errors_JoinSession_Token_NoSessionName,
    Errors_JoinSession_Token_RoleType_EmptyOrWrong,
    Errors_JoinSession_Token_UserIdentity_TooLong,
    Errors_Session_Base = 2000,
    Errors_Session_Module_Not_Found,
    Errors_Session_Service_Invalid,
    Errors_Session_Join_Failed,
    Errors_Session_No_Rights,
    Errors_Session_Already_In_Progress,
    Errors_Session_Dont_Support_SessionType,
    Errors_Session_You_Have_No_Share,
    Errors_Session_Reconnecting,
    Errors_Session_Disconnecting,
    Errors_Session_Not_Started = 2010,
    Errors_Session_Need_Password,
    Errors_Session_Password_Wrong,
    Errors_Session_Remote_DB_Error,
    Errors_Session_Invalid_Param,
    Errors_Session_Client_Incompatible,
    Errors_Session_Account_FreeMinutesExceeded,
    Errors_Session_Audio_Error = 3000,
    Errors_Session_Audio_No_Microphone,
    Errors_Session_Audio_No_Speaker,
    Errors_Session_Video_Error = 4000,
    Errors_Session_Video_Device_Error,
    
    Errors_Session_Live_Stream_Error = 5000,
    Errors_Session_Phone_Error = 5500,
    Errors_Dont_Support_Multi_Stream_Video_User,
    Errors_Fail_Assign_User_Privilege,
    Errors_No_Recording_In_Process,
    Errors_Set_Virtual_Background_Fail,
    
    Errors_Malloc_Failed = 6001,
    Errors_Not_In_Session,
    Errors_No_License,
    
    Errors_Video_Module_Not_Ready,
    Errors_Video_Module_Error,
    Errors_Video_device_error,
    Errors_No_Video_Data,
    
    Errors_Share_Module_Not_Ready,
    Errors_Share_Module_Error,
    Errors_No_Share_Data,
    
    Errors_Audio_Module_Not_Ready,
    Errors_Audio_Module_Error,
    Errors_No_Audio_Data,
    
    Errors_Preprocess_Rawdata_Error,
    Errors_Rawdata_No_Device_Running,
    Errors_Rawdata_Init_Device,
    Errors_Rawdata_Virtual_Device,
    Errors_Rawdata_Cannot_Change_Virtual_Device_In_Preview,
    Errors_Rawdata_Internal_Error,
    Errors_Rawdata_Send_Too_Much_Data_In_Single_Time,
    Errors_Rawdata_Send_Too_Frequently,
    Errors_Rawdata_Virtual_Mic_Is_Terminate,
 
    Errors_Session_Share_Error = 7001,
    Errors_Session_Share_Module_Not_Ready,
    Errors_Session_Share_You_Are_Not_Sharing,
    Errors_Session_Share_Type_Is_Not_Support,
    Errors_Session_Share_Internal_Error,
    Errors_Session_Share_Camera_Video_Not_Start,
    Errors_Session_Share_Camera_Conflict_With_Video_Effects,
    
    Errors_Session_Filetransfer_UnknownError = 7500,
    Errors_Session_Filetransfer_FileTypeBlocked,
    Errors_Session_Filetransfer_FileSizelimited,
    
    Errors_Spotlight_NotEnoughUsers = 7600,
    Errors_Spotlight_ToMuchSpotlightedUsers,
    Errors_Spotlight_UserCannotBeSpotlighted,
    Errors_Spotlight_UserWithoutVideo,
    Errors_Spotlight_UserNotSpotlighted,
};
typedef NS_ENUM(NSUInteger,ZoomVideoSDKError) {…};
 
typedef NS_ENUM(NSUInteger,ZoomVideoSDKAudioType) {
    ZoomVideoSDKAudioType_None   = 0,
    ZoomVideoSDKAudioType_VOIP,
    ZoomVideoSDKAudioType_TELEPHONY,
    ZoomVideoSDKAudioType_Unknown,
};
typedef NS_ENUM(NSUInteger,ZoomVideoSDKAudioType) {…};
 
typedef NS_ENUM(NSUInteger, ZoomVideoSDKVideoAspect) {
    ZoomVideoSDKVideoAspect_Original         = 0,
    ZoomVideoSDKVideoAspect_Full_Filled,
    ZoomVideoSDKVideoAspect_LetterBox,
    ZoomVideoSDKVideoAspect_PanAndScan,
};
typedef NS_ENUM(NSUInteger, ZoomVideoSDKVideoAspect) {…};
 
typedef NS_ENUM(NSUInteger, ZoomVideoSDKVideoType) {
    ZoomVideoSDKVideoType_VideoData  = 1,
    ZoomVideoSDKVideoType_ShareData,
};
typedef NS_ENUM(NSUInteger, ZoomVideoSDKVideoType) {…};
 
typedef NS_ENUM(NSUInteger, ZoomVideoSDKReceiveSharingStatus) {
    ZoomVideoSDKReceiveSharingStatus_None = 0, 
    ZoomVideoSDKReceiveSharingStatus_Start, 
    ZoomVideoSDKReceiveSharingStatus_Pause, 
    ZoomVideoSDKReceiveSharingStatus_Resume, 
    ZoomVideoSDKReceiveSharingStatus_Stop, 
};
typedef NS_ENUM(NSUInteger, ZoomVideoSDKReceiveSharingStatus) {…};
 
typedef NS_ENUM(NSUInteger, ZoomVideoSDKLiveStreamStatus) {
    ZoomVideoSDKLiveStreamStatus_None = 1,
    ZoomVideoSDKLiveStreamStatus_InProgress,
    ZoomVideoSDKLiveStreamStatus_Connecting,
    ZoomVideoSDKLiveStreamStatus_FailedTimeout,
    ZoomVideoSDKLiveStreamStatus_StartFailed,
    ZoomVideoSDKLiveStreamStatus_Ended,
};
typedef NS_ENUM(NSUInteger, ZoomVideoSDKLiveStreamStatus) {…};
/*
 @brief ZoomVideoSDKFrameDataFormat An enumeration of raw data frame format.
 */
typedef NS_ENUM(NSUInteger, ZoomVideoSDKFrameDataFormat) {
    ZoomVideoSDKFrameDataFormat_I420            = 1,
    ZoomVideoSDKFrameDataFormat_I420_Limit,
};
typedef NS_ENUM(NSUInteger, ZoomVideoSDKFrameDataFormat) {…};
 
typedef NS_ENUM(NSInteger, ZoomVideoSDKVideoRawDataRotation) {
    ZoomVideoSDKVideoRawDataRotationNone      = 1,
    ZoomVideoSDKVideoRawDataRotation90,
    ZoomVideoSDKVideoRawDataRotation180,
    ZoomVideoSDKVideoRawDataRotation270,
};
typedef NS_ENUM(NSInteger, ZoomVideoSDKVideoRawDataRotation) {…};
 
typedef NS_ENUM(NSUInteger, ZoomVideoSDKVideoResolution) {
    ZoomVideoSDKVideoResolution_90,
    ZoomVideoSDKVideoResolution_180,
    ZoomVideoSDKVideoResolution_360,
    ZoomVideoSDKVideoResolution_720,
    ZoomVideoSDKVideoResolution_Auto = 100,
};
typedef NS_ENUM(NSUInteger, ZoomVideoSDKVideoResolution) {…};
 
typedef NS_ENUM(NSUInteger, ZoomVideoSDKRawDataMemoryMode) {
    ZoomVideoSDKRawDataMemoryModeStack,
    ZoomVideoSDKRawDataMemoryModeHeap
};
typedef NS_ENUM(NSUInteger, ZoomVideoSDKRawDataMemoryMode) {…};
 
typedef NS_ENUM(NSUInteger, ZoomVideoSDKUserRawdataStatus) {
    ZoomVideoSDKUserRawdataOn,
    ZoomVideoSDKUserRawdataOff
};
typedef NS_ENUM(NSUInteger, ZoomVideoSDKUserRawdataStatus) {…};
 
typedef NS_ENUM(NSUInteger, ZoomVideoSDKPhoneStatus) {
    ZoomVideoSDKPhoneStatus_None,
    ZoomVideoSDKPhoneStatus_Calling,
    ZoomVideoSDKPhoneStatus_Ringing,
    ZoomVideoSDKPhoneStatus_Accepted,
    ZoomVideoSDKPhoneStatus_Success,
    ZoomVideoSDKPhoneStatus_Failed,
    ZoomVideoSDKPhoneStatus_Canceling,
    ZoomVideoSDKPhoneStatus_Canceled, 
    ZoomVideoSDKPhoneStatus_Cancel_Failed,
    ZoomVideoSDKPhoneStatus_Timeout,
};
typedef NS_ENUM(NSUInteger, ZoomVideoSDKPhoneStatus) {…};
 
 
typedef NS_ENUM(NSUInteger, ZoomVideoSDKPhoneFailedReason) {
    ZoomVideoSDKPhoneFailedReason_None,
    ZoomVideoSDKPhoneFailedReason_Busy,
    ZoomVideoSDKPhoneFailedReason_Not_Available,
    ZoomVideoSDKPhoneFailedReason_User_Hangup,
    ZoomVideoSDKPhoneFailedReason_Other_Fail,
    ZoomVideoSDKPhoneFailedReason_No_Answer,
    ZoomVideoSDKPhoneFailedReason_Block_No_Host,
    ZoomVideoSDKPhoneFailedReason_Block_High_Rate,
    ZoomVideoSDKPhoneFailedReason_Block_Too_Frequent,
};
typedef NS_ENUM(NSUInteger, ZoomVideoSDKPhoneFailedReason) {…};
 
typedef NS_ENUM(NSUInteger, ZoomVideoSDKRecordingStatus) {
    ZoomVideoSDKRecordingStatus_None,
    ZoomVideoSDKRecordingStatus_Start,
    ZoomVideoSDKRecordingStatus_Stop,
    ZoomVideoSDKRecordingStatus_DiskFull,
    ZoomVideoSDKRecordingStatus_Pause, 
    ZoomVideoSDKRecordingStatus_Connecting, 
};
typedef NS_ENUM(NSUInteger, ZoomVideoSDKRecordingStatus) {…};
 
typedef NS_ENUM(NSUInteger, ZoomVideoSDKVideoPreferenceMode) {
    ZoomVideoSDKVideoPreferenceMode_Balance, 
    ZoomVideoSDKVideoPreferenceMode_Sharpness,
    ZoomVideoSDKVideoPreferenceMode_Smoothness,
    ZoomVideoSDKVideoPreferenceMode_Custom,
};
typedef NS_ENUM(NSUInteger, ZoomVideoSDKVideoPreferenceMode) {…};
 
typedef NS_ENUM(NSUInteger, ZoomVideoSDKMultiCameraStreamStatus) {
    ZoomVideoSDKMultiCameraStreamStatus_JoinStart,  
    ZoomVideoSDKMultiCameraStreamStatus_JoinFail,   
    ZoomVideoSDKMultiCameraStreamStatus_Joined,     
    ZoomVideoSDKMultiCameraStreamStatus_Left,       
    ZoomVideoSDKMultiCameraStreamStatus_VideoOn,    
    ZoomVideoSDKMultiCameraStreamStatus_VideoOff,   
};
typedef NS_ENUM(NSUInteger, ZoomVideoSDKMultiCameraStreamStatus) {…};
 
typedef NS_ENUM(NSUInteger, ZoomVideoSDKLiveTranscriptionStatus) {
    ZoomVideoSDKLiveTranscriptionStatus_Stop,   
    ZoomVideoSDKLiveTranscriptionStatus_Start,  
};
typedef NS_ENUM(NSUInteger, ZoomVideoSDKLiveTranscriptionStatus) {…};
 
typedef NS_ENUM(NSUInteger, ZoomVideoSDKLiveTranscriptionOperationType) {
    ZoomVideoSDKLiveTranscriptionOperationType_None,    
    ZoomVideoSDKLiveTranscriptionOperationType_Add,     
    ZoomVideoSDKLiveTranscriptionOperationType_Update,  
    ZoomVideoSDKLiveTranscriptionOperationType_Delete,  
    ZoomVideoSDKLiveTranscriptionOperationType_Complete,
    ZoomVideoSDKLiveTranscriptionOperationType_NotSupported,
};
typedef NS_ENUM(NSUInteger, ZoomVideoSDKLiveTranscriptionOperationType) {…};
 
typedef NS_ENUM(NSUInteger, ZoomVideoSDKSystemPermissionType) {
    ZoomVideoSDKSystemPermissionType_Camera,    
    ZoomVideoSDKSystemPermissionType_Microphone,      
};
typedef NS_ENUM(NSUInteger, ZoomVideoSDKSystemPermissionType) {…};
 
typedef NS_ENUM(NSUInteger,ZoomVideoSDKChatMsgDeleteBy)
{
    ZoomVideoSDKChatMsgDeleteBy_NONE ,    
    ZoomVideoSDKChatMsgDeleteBy_SELF,     
    ZoomVideoSDKChatMsgDeleteBy_HOST,     
    ZoomVideoSDKChatMsgDeleteBy_DLP,      
};
typedef NS_ENUM(NSUInteger,ZoomVideoSDKChatMsgDeleteBy) {…};
 
typedef NS_ENUM(NSUInteger, ZoomVideoSDKDialInNumType)
{
    ZoomVideoSDKDialInNumType_None,     
    ZoomVideoSDKDialInNumType_Toll,     
    ZoomVideoSDKDialInNumType_TollFree, 
};
typedef NS_ENUM(NSUInteger, ZoomVideoSDKDialInNumType) {…};
 
 
typedef NS_ENUM(NSUInteger, ZoomVideoSDKNetworkStatus)
{
    ZoomVideoSDKNetworkStatus_None,
    ZoomVideoSDKNetworkStatus_Bad,
    ZoomVideoSDKNetworkStatus_Normal,
    ZoomVideoSDKNetworkStatus_Good,
};
typedef NS_ENUM(NSUInteger, ZoomVideoSDKNetworkStatus) {…};
 
typedef NS_ENUM(NSUInteger, ZoomVideoSDKRecordAgreementType)
{
    ZoomVideoSDKRecordAgreementType_Invalid,
    ZoomVideoSDKRecordAgreementType_Traditional,
    ZoomVideoSDKRecordAgreementType_Individual_Only,
};
typedef NS_ENUM(NSUInteger, ZoomVideoSDKRecordAgreementType) {…};
 
typedef NS_ENUM(NSUInteger, ZoomVideoSDKVirtualBackgroundDataType)
{
    ZoomVideoSDKVirtualBackgroundDataType_None,
    ZoomVideoSDKVirtualBackgroundDataType_Image,
    ZoomVideoSDKVirtualBackgroundDataType_Blur,
};
typedef NS_ENUM(NSUInteger, ZoomVideoSDKVirtualBackgroundDataType) {…};
 
typedef NS_ENUM(NSUInteger, ZoomVideoSDKCRCProtocol) {
    ZoomVideoSDKCRCProtocol_H323        = 0,
    ZoomVideoSDKCRCProtocol_SIP,
};
typedef NS_ENUM(NSUInteger, ZoomVideoSDKCRCProtocol) {…};
 
typedef NS_ENUM(NSUInteger, ZoomVideoSDKCRCCallStatus) {
    ZoomVideoSDKCRCCallStatus_Success        = 0,
    ZoomVideoSDKCRCCallStatus_Ring,
    ZoomVideoSDKCRCCallStatus_Timeout,
    ZoomVideoSDKCRCCallStatus_Busy,
    ZoomVideoSDKCRCCallStatus_Decline,
    ZoomVideoSDKCRCCallStatus_Failed,
};
typedef NS_ENUM(NSUInteger, ZoomVideoSDKCRCCallStatus) {…};
 
typedef NS_ENUM(NSUInteger,ZoomVideoSDKAnnotationToolType) {
    ZoomVideoSDKAnnotationToolType_None = 0,
    ZoomVideoSDKAnnotationToolType_Pen,
    ZoomVideoSDKAnnotationToolType_HighLighter,
    ZoomVideoSDKAnnotationToolType_AutoLine,
    ZoomVideoSDKAnnotationToolType_AutoRectangle,
    ZoomVideoSDKAnnotationToolType_AutoEllipse,
    ZoomVideoSDKAnnotationToolType_AutoArrow,
    ZoomVideoSDKAnnotationToolType_AutoRectangleFill,
    ZoomVideoSDKAnnotationToolType_AutoEllipseFill,
    ZoomVideoSDKAnnotationToolType_SpotLight,
    ZoomVideoSDKAnnotationToolType_Arrow,
    ZoomVideoSDKAnnotationToolType_ERASER,
    ZoomVideoSDKAnnotationToolType_Picker,
    ZoomVideoSDKAnnotationToolType_AutoRectangleSemiFill,
    ZoomVideoSDKAnnotationToolType_AutoEllipseSemiFill,
    ZoomVideoSDKAnnotationToolType_AutoDoubleArrow,
    ZoomVideoSDKAnnotationToolType_AutoDiamond,
    ZoomVideoSDKAnnotationToolType_AutoStampArrow,
    ZoomVideoSDKAnnotationToolType_AutoStampCheck,
    ZoomVideoSDKAnnotationToolType_AutoStampX,
    ZoomVideoSDKAnnotationToolType_AutoStampStar,
    ZoomVideoSDKAnnotationToolType_AutoStampHeart,
    ZoomVideoSDKAnnotationToolType_AutoStampQm,
};
typedef NS_ENUM(NSUInteger,ZoomVideoSDKAnnotationToolType) {…};
 
typedef NS_ENUM(NSUInteger,ZoomVideoSDKAnnotationClearType) {
    ZoomVideoSDKAnnotationClearType_All = 0,    
    ZoomVideoSDKAnnotationClearType_Others,     
    ZoomVideoSDKAnnotationClearType_My,         
};
typedef NS_ENUM(NSUInteger,ZoomVideoSDKAnnotationClearType) {…};
 
typedef NS_ENUM(NSUInteger, ZoomVideoSDKSubscribeFailReason) {
    ZoomVideoSDKSubscribeFailReason_None = 0,
    ZoomVideoSDKSubscribeFailReason_HasSubscribeShare, // has subscribe share and try to subscribe 720 video
    ZoomVideoSDKSubscribeFailReason_HasSubscribeExceededLimit,
    ZoomVideoSDKSubscribeFailReason_HasSubscribe1080POr720P,
    ZoomVideoSDKSubscribeFailReason_HasSubscribeOneShare, // try to subscribe the second share
};
typedef NS_ENUM(NSUInteger, ZoomVideoSDKSubscribeFailReason) {…};
 
typedef NS_ENUM(NSUInteger,ZoomVideoSDKShareType)
{
    ZoomVideoSDKShareType_None,
    ZoomVideoSDKShareType_Normal,
    ZoomVideoSDKShareType_PureAudio,
    ZoomVideoSDKShareType_Camera,
};
typedef NS_ENUM(NSUInteger,ZoomVideoSDKShareType) {…};
 
 
typedef NS_ENUM(NSUInteger, ZoomVideoSDKChatPrivilegeType) {
    ZoomVideoSDKChatPrivilege_Unknown = 0,
    ZoomVideoSDKChatPrivilege_Everyone_Publicly_And_Privately,
    ZoomVideoSDKChatPrivilege_No_One,
    ZoomVideoSDKChatPrivilege_Everyone_Publicly,
};
typedef NS_ENUM(NSUInteger, ZoomVideoSDKChatPrivilegeType) {…};
 
 
typedef NS_ENUM(NSInteger, ZoomVideoSDKAudioChannel) {
    ZoomVideoSDKAudioChannel_Mono,         
    ZoomVideoSDKAudioChannel_Stereo,       
};
typedef NS_ENUM(NSInteger, ZoomVideoSDKAudioChannel) {…};
 
typedef NS_ENUM(NSInteger, ZoomVideoSDKTestMicStatus) {
    ZoomVideoSDKMic_CanTest = 0,
    ZoomVideoSDKMic_Recording,
    ZoomVideoSDKMic_CanPlay,
};
typedef NS_ENUM(NSInteger, ZoomVideoSDKTestMicStatus) {…};
 
 
typedef NS_ENUM(NSInteger, ZoomVideoSDKFileTransferStatus) {
    FileTransferState_None = 0,         
    FileTransferState_ReadyToTransfer,  
    FileTransferState_Transfering,      
    FileTransferState_TransferFailed,   
    FileTransferState_TransferDone,     
};
typedef NS_ENUM(NSInteger, ZoomVideoSDKFileTransferStatus) {…};
 
typedef NS_ENUM(NSInteger, ZoomVideoSDKSessionLeaveReason) {
    ZoomVideoSDKSessionLeaveReason_Unknown = 0,     
    ZoomVideoSDKSessionLeaveReason_BySelf,          
    ZoomVideoSDKSessionLeaveReason_KickByHost,      
    ZoomVideoSDKSessionLeaveReason_EndByHost,       
    ZoomVideoSDKSessionLeaveReason_NetworkError,    
};
typedef NS_ENUM(NSInteger, ZoomVideoSDKSessionLeaveReason) {…};
 
typedef NS_ENUM(NSUInteger, ZoomVideoSDKMaskShape) {
    ZoomVideoSDKMaskShape_Rectangle, 
    ZoomVideoSDKMaskShape_Circle,    
    ZoomVideoSDKMaskShape_Oval,      
};
typedef NS_ENUM(NSUInteger, ZoomVideoSDKMaskShape) {…};
 
typedef NS_ENUM(NSInteger, ZoomVideoSDKUVCCameraStatus) {
    ZoomVideoSDKUVCCameraStatus_Attached = 0,       
    ZoomVideoSDKUVCCameraStatus_Detached          
};
typedef NS_ENUM(NSInteger, ZoomVideoSDKUVCCameraStatus) {…};
#endif /* ZoomVideoSDKConstants_h */