ZMVideoSDKDef.h

Go to the documentation of this file.

 
typedef enum
{
    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_Audio_Error = 3000,
    ZMVideoSDKErrors_Session_Audio_No_Microphone,
    ZMVideoSDKErrors_Session_Audio_No_Speaker,
    
    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_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_Set_Virtual_Background_Fail,
    ZMVideoSDKErrors_Session_Share_Camera_Video_Not_Start,
    ZMVideoSDKErrors_Session_Share_Camera_Conflict_With_Video_Effects,
    
    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;
 
 
typedef enum
{
    ZMVideoSDKShareStatus_None,
    ZMVideoSDKShareStatus_Start,
    ZMVideoSDKShareStatus_Pause,
    ZMVideoSDKShareStatus_Resume,
    ZMVideoSDKShareStatus_Stop
}ZMVideoSDKShareStatus;
 
typedef enum
{
    ZMVideoSDKLiveStreamStatus_None,
    ZMVideoSDKLiveStreamStatus_InProgress,
    ZMVideoSDKLiveStreamStatus_Connecting,
    ZMVideoSDKLiveStreamStatus_FailedTimeout,
    ZMVideoSDKLiveStreamStatus_StartFailed,
    ZMVideoSDKLiveStreamStatus_Ended
}ZMVideoSDKLiveStreamStatus;
 
typedef enum
{
    ZMVideoSDKRawDataType_Video = 0,
    ZMVideoSDKRawDataType_Share
}ZMVideoSDKRawDataType;
 
typedef enum
{
    ZMVideoSDKResolution_90P = 0,
    ZMVideoSDKResolution_180P,
    ZMVideoSDKResolution_360P,
    ZMVideoSDKResolution_720P,
    ZMVideoSDKResolution_1080P,
    ZMVideoSDKResolution_Auto = 100
}ZMVideoSDKResolution;
 
typedef enum
{
    ZMVideoSDKRawDataMemoryMode_Stack,
    ZMVideoSDKRawDataMemoryMode_Heap
}ZMVideoSDKRawDataMemoryMode;
 
typedef enum
{
    ZMVideoSDKRawData_On,
    ZMVideoSDKRawData_Off
}ZMVideoSDKRawDataStatus;
 
typedef enum {
    ZMVideoSDKAudioType_VOIP,
    ZMVideoSDKAudioType_TELEPHONY,
    ZMVideoSDKAudioType_None
}ZMVideoSDKAudioType;
 
typedef enum
{
    ZMVideoRotation_0,
    ZMVideoRotation_90,
    ZMVideoRotation_180,
    ZMVideoRotation_270
}ZMVideoRotation;
 
typedef enum
{
    ZMVideoSDKVideoPreferenceMode_Balance,
    ZMVideoSDKVideoPreferenceMode_Sharpness,
    ZMVideoSDKVideoPreferenceMode_Smoothness,
    ZMVideoSDKVideoPreferenceMode_Custom
}ZMVideoSDKVideoPreferenceMode;
 
 
typedef enum
{
    ZMRecording_Start,
    ZMRecording_Stop,
    ZMRecording_DiskFull,
    ZMRecording_Pause
}ZMRecordingStatus;
 
 
typedef enum
{
    ZMVideoSDKCameraControlRequestType_RequestControl = 0,
    ZMVideoSDKCameraControlRequestType_GiveUpControl
}ZMVideoSDKCameraControlRequestType;
 
 
typedef enum
{
    ZMPhoneStatus_None,
    ZMPhoneStatus_Calling,
    ZMPhoneStatus_Ringing,
    ZMPhoneStatus_Accepted,
    ZMPhoneStatus_Success,
    ZMPhoneStatus_Failed,
    ZMPhoneStatus_Canceling,
    ZMPhoneStatus_Canceled,
    ZMPhoneStatus_Cancel_Failed,
    ZMPhoneStatus_Timeout
}ZMPhoneStatus;
 
typedef enum
{
    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;
 
 
typedef enum
{
    ZMVideoSDKSuppressBackgroundNoiseLevel_Auto = 0,
    ZMVideoSDKSuppressBackgroundNoiseLevel_Low,
    ZMVideoSDKSuppressBackgroundNoiseLevel_Medium,
    ZMVideoSDKSuppressBackgroundNoiseLevel_High
}ZMVideoSDKSuppressBackgroundNoiseLevel;
 
typedef enum {
    ZMVideoSDKEchoCancellationLevel_Default = 0,
    ZMVideoSDKEchoCancellationLevel_Low,
    ZMVideoSDKEchoCancellationLevel_High
}ZMVideoSDKEchoCancellationLevel;
 
 
typedef enum{
    ZMVideoSDKMultiCameraStreamStatus_JoinStart,
    ZMVideoSDKMultiCameraStreamStatus_JoinFail,
    ZMVideoSDKMultiCameraStreamStatus_Joined,
    ZMVideoSDKMultiCameraStreamStatus_Left,
    ZMVideoSDKMultiCameraStreamStatus_VideoOn,
    ZMVideoSDKMultiCameraStreamStatus_VideoOff
}ZMVideoSDKMultiCameraStreamStatus;
 
 
typedef enum{
    ZMVideoSDKMicTestStatus_CanTest = 0,
    ZMVideoSDKMicTestStatus_Recording,
    ZMVideoSDKMicTestStatus_CanPlay
}ZMVideoSDKMicTestStatus;
 
 
typedef enum
{
    ZMVideoSDKAudioDeviceType_Microphone = 0,
    ZMVideoSDKAudioDeviceType_Speaker
}ZMVideoSDKAudioDeviceType;
 
typedef enum {
    ZMVideoSDKAudioDeviceStatus_Device_Error_Unknow = 0,
    ZMVideoSDKAudioDeviceStatus_No_Device,
    ZMVideoSDKAudioDeviceStatus_Device_List_Update,
    ZMVideoSDKAudioDeviceStatus_Audio_No_Input,
    ZMVideoSDKAudioDeviceStatus_Audio_Disconnect_As_Detected_Echo
}ZMVideoSDKAudioDeviceStatus;
 
 
typedef enum
{
    ZMVideoSDKShareType_None,
    ZMVideoSDKShareType_Normal,
    ZMVideoSDKShareType_PureAudio,
    ZMVideoSDKShareType_Camera
}ZMVideoSDKShareType;
 
 
typedef enum
{
    ZMVideoSDKVideoSourceDataMode_None = 0,
    ZMVideoSDKVideoSourceDataMode_Horizontal,
    ZMVideoSDKVideoSourceDataMode_Vertical
}ZMVideoSDKVideoSourceDataMode;
 
typedef enum
{
    ZMVideoSDKLiveTranscription_Status_Stop = 0,
    ZMVideoSDKLiveTranscription_Status_Start = 1
}ZMVideoSDKLiveTranscriptionStatus;
 
typedef enum
{
    ZMVideoSDKLiveTranscription_OperationType_None = 0,
    ZMVideoSDKLiveTranscription_OperationType_Add,
    ZMVideoSDKLiveTranscription_OperationType_Update,
    ZMVideoSDKLiveTranscription_OperationType_Delete,
    ZMVideoSDKLiveTranscription_OperationType_Complete,
    ZMVideoSDKLiveTranscription_OperationType_NotSupported
}ZMVideoSDKLiveTranscriptionOperationType;
 
typedef enum
{
    ZMVideoSDKChatMessageDeleteType_None = 0,
    ZMVideoSDKChatMessageDeleteType_BySelf,
    ZMVideoSDKChatMessageDeleteType_ByHost,
    ZMVideoSDKChatMessageDeleteType_ByDlp
}ZMVideoSDKChatMessageDeleteType;
 
typedef enum
{
    ZMVideoSDKVirtualBackgroundDataType_None,
    ZMVideoSDKVirtualBackgroundDataType_Image,
    ZMVideoSDKVirtualBackgroundDataType_Blur
}ZMVideoSDKVirtualBackgroundDataType;
 
typedef enum
{
    ZMVideoSDKDialInNumType_None,
    ZMVideoSDKDialInNumType_Toll,
    ZMVideoSDKDialInNumType_TollFree
}ZMVideoSDKDialInNumType;
 
typedef enum
{
    ZMVideoSDKNetworkStatus_None,
    ZMVideoSDKNetworkStatus_Bad,
    ZMVideoSDKNetworkStatus_Normal,
    ZMVideoSDKNetworkStatus_Good
}ZMVideoSDKNetworkStatus;
 
 
typedef enum
{
    ZMVideoSDKConsentType_Invalid,
    ZMVideoSDKConsentType_Traditional,
    ZMVideoSDKConsentType_Individual
}ZMVideoSDKConsentType;
 
 
typedef enum
{
    ZMVideoSDKScreenCaptureMode_Auto,
    ZMVideoSDKScreenCaptureMode_Legacy,
    ZMVideoSDKScreenCaptureMode_Filtering,
    ZMVideoSDKScreenCaptureMode_ADA_Filtering,
    ZMVideoSDKScreenCaptureMode_ADA_Without_Filtering
}ZMVideoSDKScreenCaptureMode;
 
 
typedef enum
{
    ZMVideoSDKVideoAspect_Original,
    ZMVideoSDKVideoAspect_Full_Filled,
    ZMVideoSDKVideoAspect_LetterBox,
    ZMVideoSDKVideoAspect_PanAndScan,
}ZMVideoSDKVideoAspect;
 
typedef enum
{
    ZMVideoSDKCanvasType_VideoData = 1,
    ZMVideoSDKCanvasType_ShareData,
}ZMVideoSDKCanvasType;
 
typedef enum
{
    ZMVideoSDKFrameDataFormat_I420_Limited,
    ZMVideoSDKFrameDataFormat_I420_Full,
}ZMVideoSDKFrameDataFormat;
 
typedef enum
{
    ZMVideoSDKCRCProtocol_H323,
    ZMVideoSDKCRCProtocol_SIP
}ZMVideoSDKCRCProtocol;
 
typedef enum
{
    ZMVideoSDKCRCCallStatus_Success = 0,
    ZMVideoSDKCRCCallStatus_Ring,
    ZMVideoSDKCRCCallStatus_Timeout,
    ZMVideoSDKCRCCallStatus_Busy,
    ZMVideoSDKCRCCallStatus_Decline,
    ZMVideoSDKCRCCallStatus_Failed
}ZMVideoSDKCRCCallStatus;
 
typedef enum{
    ZMVideoSDKSubscribeFailReason_None = 0,
    ZMVideoSDKSubscribeFailReason_HasSubscribe1080POr720P,
    ZMVideoSDKSubscribeFailReason_HasSubscribeTwo720P,
    ZMVideoSDKSubscribeFailReason_HasSubscribeExceededLimit,
    ZMVideoSDKSubscribeFailReason_HasSubscribeTwoShare,
    ZMVideoSDKSubscribeFailReason_HasSubscribeVideo1080POr720PAndOneShare,
    ZMVideoSDKSubscribeFailReason_TooFrequentCall
} ZMVideoSDKSubscribeFailReason;
 
typedef enum{
    ZMVideoSDKChatPrivilegeType_Unknown = 0,
    ZMVideoSDKChatPrivilegeType_Publicly_And_Privately,
    ZMVideoSDKChatPrivilegeType_No_One,
    ZMVideoSDKChatPrivilegeType_Publicly,
} ZMVideoSDKChatPrivilegeType;
 
typedef enum{
    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;
 
typedef enum{
    ZMVideoSDKAnnotationClearType_All,
    ZMVideoSDKAnnotationClearType_Others,
    ZMVideoSDKAnnotationClearType_My
}ZMVideoSDKAnnotationClearType;
 
 
typedef enum
{
    ZMVideoSDKFileTransferStatus_None = 0,
    ZMVideoSDKFileTransferStatus_ReadyToTransfer,
    ZMVideoSDKFileTransferStatus_Transfering,
    ZMVideoSDKFileTransferStatus_TransferFailed,
    ZMVideoSDKFileTransferStatus_TransferDone
}ZMVideoSDKFileTransferStatus;
 
typedef enum
{
    ZMVideoSDKAudioChannel_Mono = 0,
    ZMVideoSDKAudioChannel_Stereo
}ZMVideoSDKAudioChannel;
 
typedef enum
{
    ZMVideoSDKSessionLeaveReason_Unknown = 0,
    ZMVideoSDKSessionLeaveReason_BySelf,
    ZMVideoSDKSessionLeaveReason_KickByHost,
    ZMVideoSDKSessionLeaveReason_EndByHost,
    ZMVideoSDKSessionLeaveReason_NetworkError
}ZMVideoSDKSessionLeaveReason;
 
typedef enum
{
    ZMVideoSDKRemoteControlStatus_None = 0,
    ZMVideoSDKRemoteControlStatus_CanRequestControl,
    ZMVideoSDKRemoteControlStatus_RequestDenied,
    ZMVideoSDKRemoteControlStatus_GotControl,
    ZMVideoSDKRemoteControlStatus_LostControl,
    ZMVideoSDKRemoteControlStatus_ControlStart,
    ZMVideoSDKRemoteControlStatus_ControlStop,
    ZMVideoSDKRemoteControlStatus_GiveControlTo,
    ZMVideoSDKRemoteControlStatus_ControlRevoked,
    ZMVideoSDKRemoteControlStatus_ControlledBy,
    ZMVideoSDKRemoteControlStatus_NotControlled
}ZMVideoSDKRemoteControlStatus;
 
typedef enum
{
    ZMVideoSDKSubSessionStatus_None,
    ZMVideoSDKSubSessionStatus_Committed,
    ZMVideoSDKSubSessionStatus_Withdrawn,
    ZMVideoSDKSubSessionStatus_Started,
    ZMVideoSDKSubSessionStatus_Stopping,
    ZMVideoSDKSubSessionStatus_Stopped,
    ZMVideoSDKSubSessionStatus_CommitFailed,
    ZMVideoSDKSubSessionStatus_WithdrawFailed,
    ZMVideoSDKSubSessionStatus_StartFailed,
    ZMVideoSDKSubSessionStatus_StopFailed
}ZMVideoSDKSubSessionStatus;
 
typedef enum
{
    ZMVideoSDKSessionType_MainSession = 0,
    ZMVideoSDKSessionType_SubSession
}ZMVideoSDKSessionType;
 
typedef enum
{
    ZMVideoSDKUserHelpRequestResult_Idle,
    ZMVideoSDKUserHelpRequestResult_Busy,
    ZMVideoSDKUserHelpRequestResult_Ignore,
    ZMVideoSDKUserHelpRequestResult_HostAlreadyInSubSession
}ZMVideoSDKUserHelpRequestResult;
 
typedef enum
{
    ZMVideoSDKSharePreprocessType_None = 0,
    ZMVideoSDKSharePreprocessType_Screen,
    ZMVideoSDKSharePreprocessType_View
}ZMVideoSDKSharePreprocessType;
 
typedef enum
{
    ZMVideoSDKShareSetting_None = 0,
    ZMVideoSDKShareSetting_LockedShare,
    ZMVideoSDKShareSetting_SingleShare,
    ZMVideoSDKShareSetting_MultiShare
}ZMVideoSDKShareSetting;
 
typedef enum
{
    ZMVideoSDKPreferVideoResolution_None,
    ZMVideoSDKPreferVideoResolution_360P,
    ZMVideoSDKPreferVideoResolution_720P,
    ZMVideoSDKPreferVideoResolution_1080P
}ZMVideoSDKPreferVideoResolution;