zoom_video_sdk_def.h

Go to the documentation of this file.

 
#ifndef _ZOOM_VIDEO_SDK_DEF_H_
#define _ZOOM_VIDEO_SDK_DEF_H_
#include <iostream>
#include "zoom_video_sdk_platform.h"
#include "zoom_sdk_raw_data_def.h"
 
#define ZOOM_VIDEO_SDK_NAMESPACE ZOOMVIDEOSDK
#define BEGIN_ZOOM_VIDEO_SDK_NAMESPACE namespace ZOOM_VIDEO_SDK_NAMESPACE {
#define END_ZOOM_VIDEO_SDK_NAMESPACE };
#define USING_ZOOM_VIDEO_SDK_NAMESPACE using namespace ZOOM_VIDEO_SDK_NAMESPACE;
 
BEGIN_ZOOM_VIDEO_SDK_NAMESPACE
typedef enum
{ 
    ZoomVideoSDKErrors_Success = 0,
    ZoomVideoSDKErrors_Wrong_Usage,
    ZoomVideoSDKErrors_Internal_Error,
    ZoomVideoSDKErrors_Uninitialize,
    ZoomVideoSDKErrors_Memory_Error,
    ZoomVideoSDKErrors_Load_Module_Error,
    ZoomVideoSDKErrors_UnLoad_Module_Error,
    ZoomVideoSDKErrors_Invalid_Parameter,
    ZoomVideoSDKErrors_Call_Too_Frequently,
    ZoomVideoSDKErrors_No_Impl,
    ZoomVideoSDKErrors_Dont_Support_Feature,
    ZoomVideoSDKErrors_Unknown,
    ZoomVideoSDKErrors_Remove_Folder_Fail,
    ZoomVideoSDKErrors_Auth_Error = 1001,
    ZoomVideoSDKErrors_Auth_Empty_Key_or_Secret,
    ZoomVideoSDKErrors_Auth_Wrong_Key_or_Secret,
    ZoomVideoSDKErrors_Auth_DoesNot_Support_SDK,
    ZoomVideoSDKErrors_Auth_Disable_SDK,
    ZoomVideoSDKErrors_JoinSession_NoSessionName = 1500,
    ZoomVideoSDKErrors_JoinSession_NoSessionToken,
    ZoomVideoSDKErrors_JoinSession_NoUserName,
    ZoomVideoSDKErrors_JoinSession_Invalid_SessionName,
    ZoomVideoSDKErrors_JoinSession_Invalid_Password,
    ZoomVideoSDKErrors_JoinSession_Invalid_SessionToken,
    ZoomVideoSDKErrors_JoinSession_SessionName_TooLong,
    ZoomVideoSDKErrors_JoinSession_Token_MismatchedSessionName,
    ZoomVideoSDKErrors_JoinSession_Token_NoSessionName,
    ZoomVideoSDKErrors_JoinSession_Token_RoleType_EmptyOrWrong,
    ZoomVideoSDKErrors_JoinSession_Token_UserIdentity_TooLong,
    ZoomVideoSDKErrors_SessionModule_Not_Found = 2001,
    ZoomVideoSDKErrors_SessionService_Invalid,
    ZoomVideoSDKErrors_Session_Join_Failed,
    ZoomVideoSDKErrors_Session_No_Rights,
    ZoomVideoSDKErrors_Session_Already_In_Progress,
    ZoomVideoSDKErrors_Session_Dont_Support_SessionType,
    ZoomVideoSDKErrors_Session_Reconnecting,
    ZoomVideoSDKErrors_Session_Disconnecting,
    ZoomVideoSDKErrors_Session_Not_Started,
    ZoomVideoSDKErrors_Session_Need_Password,
    ZoomVideoSDKErrors_Session_Password_Wrong,
    ZoomVideoSDKErrors_Session_Remote_DB_Error,
    ZoomVideoSDKErrors_Session_Invalid_Param,
    ZoomVideoSDKErrors_Session_Client_Incompatible,
    ZoomVideoSDKErrors_Session_Account_FreeMinutesExceeded,
    ZoomVideoSDKErrors_Session_Account_FreeCreditExceeded,
    ZoomVideoSDKErrors_Session_Audio_Error = 3000,
    ZoomVideoSDKErrors_Session_Audio_No_Microphone,
    ZoomVideoSDKErrors_Session_Audio_No_Speaker,
    ZoomVideoSDKErrors_Session_Bluetooth_SCO_Connection_Failed,
    ZoomVideoSDKErrors_Session_Video_Error = 4000,
    ZoomVideoSDKErrors_Session_Video_Device_Error,
    ZoomVideoSDKErrors_Session_Live_Stream_Error = 5000,
    ZoomVideoSDKErrors_Session_Phone_Error = 5500,
 
    ZoomVideoSDKErrors_RAWDATA_MALLOC_FAILED = 6001,
    ZoomVideoSDKErrors_RAWDATA_NOT_IN_Session,
    ZoomVideoSDKErrors_RAWDATA_NO_LICENSE,
    ZoomVideoSDKErrors_RAWDATA_VIDEO_MODULE_NOT_READY,
    ZoomVideoSDKErrors_RAWDATA_VIDEO_MODULE_ERROR,
    ZoomVideoSDKErrors_RAWDATA_VIDEO_DEVICE_ERROR,
    ZoomVideoSDKErrors_RAWDATA_NO_VIDEO_DATA,
    ZoomVideoSDKErrors_RAWDATA_SHARE_MODULE_NOT_READY,
    ZoomVideoSDKErrors_RAWDATA_SHARE_MODULE_ERROR,
    ZoomVideoSDKErrors_RAWDATA_NO_SHARE_DATA,
    ZoomVideoSDKErrors_RAWDATA_AUDIO_MODULE_NOT_READY,
    ZoomVideoSDKErrors_RAWDATA_AUDIO_MODULE_ERROR,
    ZoomVideoSDKErrors_RAWDATA_NO_AUDIO_DATA,
    ZoomVideoSDKErrors_RAWDATA_PREPROCESS_RAWDATA_ERROR,
    ZoomVideoSDKErrors_RAWDATA_NO_DEVICE_RUNNING,
    ZoomVideoSDKErrors_RAWDATA_INIT_DEVICE,
    ZoomVideoSDKErrors_RAWDATA_VIRTUAL_DEVICE,
    ZoomVideoSDKErrors_RAWDATA_CANNOT_CHANGE_VIRTUAL_DEVICE_IN_PREVIEW,
    ZoomVideoSDKErrors_RAWDATA_INTERNAL_ERROR,
    ZoomVideoSDKErrors_RAWDATA_SEND_TOO_MUCH_DATA_IN_SINGLE_TIME,
    ZoomVideoSDKErrors_RAWDATA_SEND_TOO_FREQUENTLY,
    ZoomVideoSDKErrors_RAWDATA_VIRTUAL_MIC_IS_TERMINATE,
    ZoomVideoSDKErrors_RAWDATA_INVALID_SHARE_PREPROCESSING_DATA_OBJECT,
    ZoomVideoSDKErrors_RAWDATA_SHARE_PREPROCESSING_IS_STOPPED,
    ZoomVideoSDKErrors_Session_Share_Error = 7001,
    ZoomVideoSDKErrors_Session_Share_Module_Not_Ready,
    ZoomVideoSDKErrors_Session_Share_You_Are_Not_Sharing,
    ZoomVideoSDKErrors_Session_Share_Type_Is_Not_Support,
    ZoomVideoSDKErrors_Session_Share_Internal_Error,
    ZoomVideoSDKErrors_Dont_Support_Multi_Stream_Video_User,
    ZoomVideoSDKErrors_Fail_Assign_User_Privilege,
    ZoomVideoSDKErrors_No_Recording_In_Process,
    ZoomVideoSDKErrors_Recording_Is_Connecting,
    ZoomVideoSDKErrors_Set_Virtual_Background_Fail,
    ZoomVideoSDKErrors_Session_Share_Camera_Video_Not_Start,
    ZoomVideoSDKErrors_Session_Share_Camera_Conflict_With_Video_Effects,
    ZoomVideoSDKErrors_Session_Share_Conflict_With_Whiteboard,
    ZoomVideoSDKErrors_Filetransfer_UnknowError = 7500,
    ZoomVideoSDKErrors_Filetransfer_FileTypeBlocked,
    ZoomVideoSDKErrors_Filetransfer_FileSizelimited,
    ZoomVideoSDKErrors_Spotlight_NotEnoughUsers = 7600,
    ZoomVideoSDKErrors_Spotlight_ToMuchSpotlightedUsers,
    ZoomVideoSDKErrors_Spotlight_UserCannotBeSpotlighted,
    ZoomVideoSDKErrors_Spotlight_UserWithoutVideo,
    ZoomVideoSDKErrors_Spotlight_UserNotSpotlighted,
 
}ZoomVideoSDKErrors;
 
typedef enum 
{
    ZoomVideoSDKSessionLeaveReason_Unknown = 0,
    ZoomVideoSDKSessionLeaveReason_BySelf,
    ZoomVideoSDKSessionLeaveReason_KickByHost,
    ZoomVideoSDKSessionLeaveReason_EndByHost,
    ZoomVideoSDKSessionLeaveReason_NetworkError,
}ZoomVideoSDKSessionLeaveReason;
 
typedef enum 
{
    ZoomVideoSDKShareStatus_None,
    ZoomVideoSDKShareStatus_Start,
    ZoomVideoSDKShareStatus_Pause,
    ZoomVideoSDKShareStatus_Resume,
    ZoomVideoSDKShareStatus_Stop,
}ZoomVideoSDKShareStatus;
 
typedef enum
{
    ZoomVideoSDKShareType_None,
    ZoomVideoSDKShareType_Normal,
    ZoomVideoSDKShareType_PureAudio,
    ZoomVideoSDKShareType_Camera, 
}ZoomVideoSDKShareType;
 
typedef enum
{
    ZoomVideoSDKShare_Capture_Pause_None,
    ZoomVideoSDKShare_Capture_Pause_WindowMoving,
    ZoomVideoSDKShare_Capture_Pause_WindowCovered,
    ZoomVideoSDKShare_Capture_Pause_WindowMinimized
}ZoomVideoSDKShareCapturePauseReason;
 
typedef enum
{
    ZoomVideoSDKLiveStreamStatus_None,
    ZoomVideoSDKLiveStreamStatus_InProgress,
    ZoomVideoSDKLiveStreamStatus_Connecting,
    ZoomVideoSDKLiveStreamStatus_FailedTimeout,
    ZoomVideoSDKLiveStreamStatus_StartFailed,
    ZoomVideoSDKLiveStreamStatus_Ended,
}ZoomVideoSDKLiveStreamStatus;
 
typedef enum
{
    ZoomVideoSDKRawDataMemoryModeStack = 0,
    ZoomVideoSDKRawDataMemoryModeHeap,
}ZoomVideoSDKRawDataMemoryMode;
 
typedef enum
{
    RAW_DATA_TYPE_VIDEO = 0,
    RAW_DATA_TYPE_SHARE,
}ZoomVideoSDKRawDataType;
 
typedef enum
{
    ZoomVideoSDKCameraControlRequestType_RequestControl = 0,
    ZoomVideoSDKCameraControlRequestType_GiveUpControl
    
}ZoomVideoSDKCameraControlRequestType;
 
enum ZoomVideoSDKRemoteControlStatus
{
    ZoomVideoSDKRemoteControlStatus_None = 0,           
    ZoomVideoSDKRemoteControlStatus_CanRequestControl,      
    ZoomVideoSDKRemoteControlStatus_RequestDenied,  
    ZoomVideoSDKRemoteControlStatus_GotControl,         
    ZoomVideoSDKRemoteControlStatus_LostControl,        
    ZoomVideoSDKRemoteControlStatus_ControlStart,       
    ZoomVideoSDKRemoteControlStatus_ControlStop,        
    ZoomVideoSDKRemoteControlStatus_GiveControlTo,      
    ZoomVideoSDKRemoteControlStatus_ControlRevoked,     
    ZoomVideoSDKRemoteControlStatus_ControlledBy,       
    ZoomVideoSDKRemoteControlStatus_NotControlled,      
};
 
enum RecordingStatus
{
    Recording_Start,
    Recording_Stop,
    Recording_DiskFull,
    Recording_Pause,
    Recording_Connecting,
};
 
typedef enum
{
    ZoomVideoSDKMic_CanTest = 0,
    ZoomVideoSDKMic_Recording,
    ZoomVideoSDKMic_CanPlay,
}ZoomVideoSDK_TESTMIC_STATUS;
 
enum ZoomVideoSDKPreferVideoResolution
{
    ZoomVideoSDKPreferVideoResolution_None,
    ZoomVideoSDKPreferVideoResolution_360P,
    ZoomVideoSDKPreferVideoResolution_720P,
    ZoomVideoSDKPreferVideoResolution_1080P
};
 
struct ZoomVideoSDKExtendParams
{
    const zchar_t* speakerTestFilePath; 
    int wrapperType;
    ZoomVideoSDKPreferVideoResolution preferVideoResolution;
#if defined __MACOS__
    bool disableKeychainAccess;
#endif
 
    ZoomVideoSDKExtendParams()
    {
        speakerTestFilePath = nullptr;
        wrapperType = 0;
        preferVideoResolution = ZoomVideoSDKPreferVideoResolution_None;
#if defined __MACOS__
        disableKeychainAccess = false;
#endif
    }
};
 
struct ZoomVideoSDKInitParams
{
    const zchar_t* domain;
    const zchar_t* logFilePrefix;
    bool  enableLog; 
    bool  enableIndirectRawdata; 
#if defined(WIN32)
    bool  permonitor_awareness_mode;
#endif
    ZoomVideoSDKRawDataMemoryMode audioRawDataMemoryMode; 
    ZoomVideoSDKRawDataMemoryMode videoRawDataMemoryMode; 
    ZoomVideoSDKRawDataMemoryMode shareRawDataMemoryMode; 
 
    ZoomVideoSDKExtendParams extendParam;
    ZoomVideoSDKInitParams()
    {
        domain = nullptr;
        logFilePrefix = nullptr;
        enableLog = false;
        enableIndirectRawdata = false;
#if defined(WIN32)
        permonitor_awareness_mode = false;
#endif
        audioRawDataMemoryMode = ZoomVideoSDKRawDataMemoryModeStack;
        videoRawDataMemoryMode = ZoomVideoSDKRawDataMemoryModeStack;
        shareRawDataMemoryMode = ZoomVideoSDKRawDataMemoryModeStack;
    }
};
 
struct ZoomVideoSDKVideoOption 
{
    bool localVideoOn; 
    ZoomVideoSDKVideoOption()
    {
        localVideoOn = true;
    }
};
struct ZoomVideoSDKAudioOption 
{
    bool connect; 
    bool mute;  
    bool isMyVoiceInMix; 
    bool autoAdjustSpeakerVolume; 
    ZoomVideoSDKAudioOption()
    {
        connect = true;
        mute = false;
        isMyVoiceInMix = true;
        autoAdjustSpeakerVolume = false;
    }
};
 
class IZoomVideoSDKVideoSourcePreProcessor;
class IZoomVideoSDKVideoSource;
class IZoomVideoSDKVirtualAudioMic;
class IZoomVideoSDKVirtualAudioSpeaker;
 
struct ZoomVideoSDKSessionContext
{
    const zchar_t* sessionName;     
    const zchar_t* sessionPassword; 
    const zchar_t* userName;        
    const zchar_t* token;           
    ZoomVideoSDKVideoOption videoOption; 
    ZoomVideoSDKAudioOption audioOption; 
    IZoomVideoSDKVideoSourcePreProcessor* preProcessor; 
    IZoomVideoSDKVideoSource* externalVideoSource; 
    IZoomVideoSDKVirtualAudioMic* virtualAudioMic; 
    IZoomVideoSDKVirtualAudioSpeaker* virtualAudioSpeaker; 
    unsigned int sessionIdleTimeoutMins;
    bool autoLoadMutliStream; 
 
    ZoomVideoSDKSessionContext()
    {
        sessionName = nullptr;
        sessionPassword = nullptr;
        userName = nullptr;
        token = nullptr;
        preProcessor = nullptr;
        externalVideoSource = nullptr;
        virtualAudioMic = nullptr;
        virtualAudioSpeaker = nullptr;
        sessionIdleTimeoutMins = 40;
        autoLoadMutliStream = true;
    }
};
 
enum FrameDataFormat
{
    FrameDataFormat_I420_LIMITED,
    FrameDataFormat_I420_FULL,
};
 
typedef enum
{
    FileTransferState_None = 0, 
    FileTransferState_ReadyToTransfer, 
    FileTransferState_Transfering, 
    FileTransferState_TransferFailed, 
    FileTransferState_TransferDone, 
}FileTransferStatus;
 
struct FileTransferProgress
{
    uint32_t ratio; 
    uint32_t completeSize; 
    uint32_t bitPerSecond;
    FileTransferProgress()
    {
        ratio = 0;
        completeSize = 0;
        bitPerSecond = 0;
    }
};
 
struct ZoomVideoSDKFileStatus
{
    FileTransferStatus transStatus; 
    FileTransferProgress transProgress;
    ZoomVideoSDKFileStatus()
    {
        transStatus = FileTransferState_None;
        transProgress = {};
    }
};
 
class IZoomVideoSDKFileTransferBaseInfo
{
public:
    virtual ~IZoomVideoSDKFileTransferBaseInfo() {}
    virtual time_t getTimeStamp() = 0;
    virtual bool isSendToAll() = 0;
    virtual uint32_t getFileSize() = 0;
    virtual const zchar_t* getFileName() = 0;
    virtual ZoomVideoSDKFileStatus getStatus() = 0;
 
};
class IZoomVideoSDKUser;
class IZoomVideoSDKSendFile : public IZoomVideoSDKFileTransferBaseInfo
{
public:
    virtual ~IZoomVideoSDKSendFile() {}
    virtual IZoomVideoSDKUser* getReceiver() = 0;
    virtual ZoomVideoSDKErrors cancelSend() = 0;
};
 
class IZoomVideoSDKReceiveFile : public IZoomVideoSDKFileTransferBaseInfo
{
public:
    virtual ~IZoomVideoSDKReceiveFile() {}
    virtual IZoomVideoSDKUser* getSender() = 0;
    virtual ZoomVideoSDKErrors cancelReceive() = 0;
    virtual ZoomVideoSDKErrors startReceive(const zchar_t* path) = 0;
};
 
enum ZoomVideoSDKAudioChannel
{
    ZoomVideoSDKAudioChannel_Mono,
    ZoomVideoSDKAudioChannel_Stereo,
};
 
enum ZoomVideoSDKSessionType
{
    ZoomVideoSDKSessionType_MainSession = 0,
    ZoomVideoSDKSessionType_SubSession,
};
 
enum ZoomVideoSDKShareSetting
{
    ZoomVideoSDKShareSetting_None = 0,
    ZoomVideoSDKShareSetting_LockedShare,
    ZoomVideoSDKShareSetting_SingleShare,
    ZoomVideoSDKShareSetting_MultiShare
};
 
enum ZoomVideoSDKWhiteboardStatus
{
    WhiteboardStatus_Started,
 
    WhiteboardStatus_Stopped
};
 
enum ZoomVideoSDKExportFormat
{
    EXPORT_FORMAT_PDF,
};
 
enum ZoomVideoSDKLiveStreamLayout {
    ZoomVideoSDKLiveStreamLayout_SpeakerView = 1,
    ZoomVideoSDKLiveStreamLayout_GalleryView
};
 
enum ZoomVideoSDKLiveStreamCloseCaption {
    ZoomVideoSDKLiveStreamCloseCaption_OFF = 0,
    ZoomVideoSDKLiveStreamCloseCaption_BurntIn,
    ZoomVideoSDKLiveStreamCloseCaption_Embedded
};
 
struct ZoomVideoSDKLiveStreamSetting {
    ZoomVideoSDKLiveStreamLayout layout;
    ZoomVideoSDKLiveStreamCloseCaption closeCaption;
 
    ZoomVideoSDKLiveStreamSetting() {
        layout = ZoomVideoSDKLiveStreamLayout_SpeakerView;
        closeCaption = ZoomVideoSDKLiveStreamCloseCaption_BurntIn;
    }
};
 
struct ZoomVideoSDKLiveStreamParams {
    const zchar_t* streamUrl;
    const zchar_t* key;
    const zchar_t* broadcastUrl;
    ZoomVideoSDKLiveStreamSetting setting;
 
    ZoomVideoSDKLiveStreamParams()
    {
        streamUrl = nullptr;
        key = nullptr;
        broadcastUrl = nullptr;
        setting = ZoomVideoSDKLiveStreamSetting();
    }
};
 
enum ZoomVideoSDKDataType
{
    ZoomVideoSDKDataType_Unknown,
    ZoomVideoSDKDataType_Audio,
    ZoomVideoSDKDataType_Video,
    ZoomVideoSDKDataType_Share
};
END_ZOOM_VIDEO_SDK_NAMESPACE
#endif