zoom_sdk_def.h

Go to the documentation of this file.

#ifndef _ZOOM_SDK_DEF_H_
#define _ZOOM_SDK_DEF_H_
#if defined(WIN32)
#include <tchar.h>
typedef wchar_t zchar_t;
#define TLS_KEY_DEF uint32_t
#else
#include <stdint.h>
#include <unistd.h>
#include <cstring>
#include <float.h>
typedef char zchar_t;
typedef uint64_t UINT64;
typedef int64_t INT64;
typedef float  FLOAT;
typedef void* HWND;
#define TLS_KEY_DEF pthread_key_t
#endif//#if defined(WIN32)

struct ZoomSDKShareCursorData
{
    unsigned int source_id;
    int x;
    int y;
 
    ZoomSDKShareCursorData()
        : source_id(0), x(0), y(0)
    {
    }
};
 
#define PLATFORM_IMPORT __declspec(dllimport)  
#define PLATFORM_EXPORT __declspec(dllexport)
#ifdef ZOOM_SDK_DLL_EXPORT
#define SDK_API PLATFORM_EXPORT
#elif defined ZOOM_SDK_DLL_IMPORT
#define SDK_API PLATFORM_IMPORT
#else
#define SDK_API
#endif
 
#define ZOOM_SDK_NAMESPACE ZOOMSDK
#define BEGIN_ZOOM_SDK_NAMESPACE namespace ZOOM_SDK_NAMESPACE {
#define END_ZOOM_SDK_NAMESPACE };
#define USING_ZOOM_SDK_NAMESPACE using namespace ZOOM_SDK_NAMESPACE;
 
BEGIN_ZOOM_SDK_NAMESPACE 
enum SDKError
{
    SDKERR_SUCCESS = 0,
    SDKERR_NO_IMPL,
    SDKERR_WRONG_USAGE,
    SDKERR_INVALID_PARAMETER,
    SDKERR_MODULE_LOAD_FAILED,
    SDKERR_MEMORY_FAILED,
    SDKERR_SERVICE_FAILED,
    SDKERR_UNINITIALIZE,
    SDKERR_UNAUTHENTICATION,
    SDKERR_NORECORDINGINPROCESS,
    SDKERR_TRANSCODER_NOFOUND,
    SDKERR_VIDEO_NOTREADY,
    SDKERR_NO_PERMISSION,
    SDKERR_UNKNOWN,
    SDKERR_OTHER_SDK_INSTANCE_RUNNING,
    SDKERR_INTERNAL_ERROR,
    SDKERR_NO_AUDIODEVICE_ISFOUND,
    SDKERR_NO_VIDEODEVICE_ISFOUND,
    SDKERR_TOO_FREQUENT_CALL,
    SDKERR_FAIL_ASSIGN_USER_PRIVILEGE,
    SDKERR_MEETING_DONT_SUPPORT_FEATURE,
    SDKERR_MEETING_NOT_SHARE_SENDER,
    SDKERR_MEETING_YOU_HAVE_NO_SHARE,
    SDKERR_MEETING_VIEWTYPE_PARAMETER_IS_WRONG,
    SDKERR_MEETING_ANNOTATION_IS_OFF,
    SDKERR_SETTING_OS_DONT_SUPPORT,
    SDKERR_EMAIL_LOGIN_IS_DISABLED,
    SDKERR_HARDWARE_NOT_MEET_FOR_VB,
    SDKERR_NEED_USER_CONFIRM_RECORD_DISCLAIMER,
    SDKERR_NO_SHARE_DATA,
    SDKERR_SHARE_CANNOT_SUBSCRIBE_MYSELF,
    SDKERR_NOT_IN_MEETING,
    SDKERR_NOT_JOIN_AUDIO,
    SDKERR_HARDWARE_DONT_SUPPORT,
    SDKERR_DOMAIN_DONT_SUPPORT,
    SDKERR_MEETING_REMOTE_CONTROL_IS_OFF,
    SDKERR_FILETRANSFER_ERROR,
    SDKERR_BREAKOUT_ROOM_NOT_CREATED,
    SDKERR_SEND_TOO_MUCH_DATA_IN_SINGLE_TIME,
 
};

enum ZoomSDKSessionSource
{
    SessionSource_CurrentSession = 0,
    SessionSource_MainSession = 1,
};

enum SDK_LANGUAGE_ID
{
    LANGUAGE_Unknown = 0,
    LANGUAGE_English,
    LANGUAGE_Chinese_Simplified,
    LANGUAGE_Chinese_Traditional,
    LANGUAGE_Japanese,
    LANGUAGE_Spanish,
    LANGUAGE_German,
    LANGUAGE_French,
    LANGUAGE_Portuguese,
    LANGUAGE_Russian,
    LANGUAGE_Korean,
    LANGUAGE_Vietnamese,
    LANGUAGE_Italian,
    LANGUAGE_Polish,
    LANGUAGE_Turkish,
    LANGUAGE_Indonesian,
    LANGUAGE_Dutch,
    LANGUAGE_Swedish
};

enum ZoomSDKRawDataMemoryMode 
{
    ZoomSDKRawDataMemoryModeStack,
    ZoomSDKRawDataMemoryModeHeap
};
 
#if (defined WIN32 )
typedef struct tagWndPosition 
{
    int left;
    int top;
    HWND hSelfWnd;
    HWND hParent;
    tagWndPosition()
    {
        left = 0;
        top = 0;
        hSelfWnd = nullptr;
        hParent = nullptr;
    }
}WndPosition;

enum CustomizedLanguageType
{
    CustomizedLanguage_None,
    CustomizedLanguage_FilePath,
    CustomizedLanguage_Content,
};
 
typedef struct tagCustomizedLanguageInfo
{
    const char* langName;
    const char* langInfo;
    CustomizedLanguageType langType;
    tagCustomizedLanguageInfo()
    {
        langName = nullptr;
        langInfo = nullptr;
        langType = CustomizedLanguage_None;
    }
 
}CustomizedLanguageInfo;

#define ENABLE_CUSTOMIZED_UI_FLAG (1 << 5)

enum SDK_APP_Locale
{
    SDK_APP_Locale_Default,
    SDK_APP_Locale_CN,
};

enum ZoomSDKVideoRenderMode
{
    ZoomSDKVideoRenderMode_None = 0,
    ZoomSDKVideoRenderMode_Auto,
    ZoomSDKVideoRenderMode_D3D11EnableFLIP,
    ZoomSDKVideoRenderMode_D3D11,
    ZoomSDKVideoRenderMode_D3D9,
    ZoomSDKVideoRenderMode_GDI,
};

enum ZoomSDKRenderPostProcessing
{
    ZoomSDKRenderPostProcessing_None = 0,
    ZoomSDKRenderPostProcessing_Auto,
    ZoomSDKRenderPostProcessing_Enable,
    ZoomSDKRenderPostProcessing_Disable,
};

enum ZoomSDKVideoCaptureMethod
{
    ZoomSDKVideoCaptureMethod_None = 0,
    ZoomSDKVideoCaptureMethod_Auto,
    ZoomSDKVideoCaptureMethod_DirectSHow,
    ZoomSDKVideoCaptureMethod_MediaFoundation,
};

typedef struct tagZoomSDKRenderOptions
{
    ZoomSDKVideoRenderMode    videoRenderMode;
    ZoomSDKRenderPostProcessing renderPostProcessing;
    ZoomSDKVideoCaptureMethod videoCaptureMethod;
    tagZoomSDKRenderOptions()
    {
        videoRenderMode = ZoomSDKVideoRenderMode_None;
        renderPostProcessing = ZoomSDKRenderPostProcessing_Auto;
        videoCaptureMethod = ZoomSDKVideoCaptureMethod_Auto;
    }
}ZoomSDKRenderOptions;
#endif
 
typedef struct tagConfigurableOptions
{
#if defined(WIN32)
    CustomizedLanguageInfo customizedLang;
    int optionalFeatures;
#endif
    const zchar_t* sdkPathPostfix;
#if defined(__linux__)
    bool create_qt_gui_application_if_needed;
    unsigned int custom_video_device_index;
#endif
 
    tagConfigurableOptions()
    {
    #if defined(WIN32)
        optionalFeatures = 0;
    #endif
        sdkPathPostfix = nullptr;
#if defined(__linux__)
        create_qt_gui_application_if_needed = false;
        custom_video_device_index = 0;
#endif
    }
 
}ConfigurableOptions;

typedef struct tagRawDataOptions
{
    bool enableRawdataIntermediateMode; 
    ZoomSDKRawDataMemoryMode  videoRawdataMemoryMode;
    ZoomSDKRawDataMemoryMode  shareRawdataMemoryMode;
    ZoomSDKRawDataMemoryMode  audioRawdataMemoryMode;
    tagRawDataOptions()
    {
        enableRawdataIntermediateMode = false;
        videoRawdataMemoryMode = ZoomSDKRawDataMemoryModeStack;
        shareRawdataMemoryMode = ZoomSDKRawDataMemoryModeStack;
        audioRawdataMemoryMode = ZoomSDKRawDataMemoryModeStack;
    }
}RawDataOptions;

typedef struct tagInitParam  
{
    const zchar_t* strWebDomain;
    const zchar_t* strBrandingName;
    const zchar_t* strSupportUrl;
    SDK_LANGUAGE_ID emLanguageID;
    bool enableGenerateDump; 
    bool enableLogByDefault;
    unsigned int uiLogFileSize; 
    RawDataOptions rawdataOpts;
    ConfigurableOptions obConfigOpts;
#if defined(WIN32)
    void* hResInstance;
    unsigned int uiWindowIconSmallID;
    unsigned int uiWindowIconBigID;
    SDK_APP_Locale locale;
    ZoomSDKRenderOptions renderOpts;
    bool permonitor_awareness_mode;
#endif
    int wrapperType;
 
    tagInitParam()
    {
        strWebDomain = nullptr;
        strBrandingName = nullptr;
        strSupportUrl = nullptr;
        emLanguageID = LANGUAGE_Unknown;
        enableGenerateDump = false;
        enableLogByDefault = false;
        uiLogFileSize = 5;
        wrapperType = 0;
#if defined(WIN32)
        hResInstance = (void*)-1;
        uiWindowIconSmallID = 0;
        uiWindowIconBigID = 0;
        locale = SDK_APP_Locale_Default;
        permonitor_awareness_mode = true;
#endif
    }
}InitParam;

enum ShareType
{
    SHARE_TYPE_UNKNOWN,
    SHARE_TYPE_AS,
    SHARE_TYPE_DS,
    SHARE_TYPE_WB,
    SHARE_TYPE_AIRHOST,
    SHARE_TYPE_CAMERA,
    SHARE_TYPE_DATA,
    SHARE_TYPE_VIDEO_FILE,
    SHARE_TYPE_FRAME,
    SHARE_TYPE_DOCUMENT,
    SHARE_TYPE_COMPUTER_AUDIO,
    SHARE_TYPE_CLIPS
};

enum LastErrorType
{
    LastErrorType_None,
    LastErrorType_Auth,
    LastErrorType_Login,
    LastErrorType_Meeting,
    LastErrorType_System,
};

class IZoomLastError
{
public:
    virtual LastErrorType GetErrorType() const = 0 ;
    virtual UINT64 GetErrorCode() const = 0;

    virtual const zchar_t* GetErrorDescription() const = 0;
    virtual ~IZoomLastError(){};
};
template<class T>
class IList
{
public:
    virtual ~IList(){};
    virtual int GetCount() = 0;
    virtual T   GetItem(int index) = 0;
    virtual void AddItem(T item) = 0;
};
#if (defined WIN32)
#define SDK_NULL_AUDIO_FILE_HANDLE (0xffffffff)
const RECT _SDK_TEST_VIDEO_INIT_RECT = {0,0,0,0};
#endif

enum FrameDataFormat
{
    FrameDataFormat_I420_LIMITED,
    FrameDataFormat_I420_FULL,
};

enum ZoomSDKAudioChannel
{
    ZoomSDKAudioChannel_Mono,
    ZoomSDKAudioChannel_Stereo,
};

enum CannotShareReasonType
{
    CannotShareReasonType_None,
    CannotShareReasonType_Locked,                          
    CannotShareReasonType_Disabled,
    CannotShareReasonType_Other_Screen_Sharing,
    CannotShareReasonType_Other_WB_Sharing,
    CannotShareReasonType_Need_Grab_Myself_Screen_Sharing,
    CannotShareReasonType_Need_Grab_Other_Screen_Sharing,
    CannotShareReasonType_Need_Grab_Audio_Sharing,
    CannotShareReasonType_Need_Grap_WB_Sharing,
    CannotShareReasonType_Reach_Maximum,
    CannotShareReasonType_Have_Share_From_Mainsession,
    CannotShareReasonType_Other_DOCS_Sharing,
    CannotShareReasonType_Need_Grab_DOCS_Sharing,
    CannotShareReasonType_UnKnown,
};

enum SharingStatus
{
    Sharing_Self_Send_Begin,
    Sharing_Self_Send_End,
    Sharing_Self_Send_Pure_Audio_Begin,
    Sharing_Self_Send_Pure_Audio_End,
    Sharing_Other_Share_Begin,
    Sharing_Other_Share_End,
    Sharing_Other_Share_Pure_Audio_Begin,
    Sharing_Other_Share_Pure_Audio_End,
    Sharing_View_Other_Sharing,
    Sharing_Pause,
    Sharing_Resume,
};

struct ZoomSDKColor {
    unsigned int red = 0;
    unsigned int green = 0;
    unsigned int blue = 0;
};

enum GrantCoOwnerAssetsType {
    GrantCoOwnerAssetsType_None,
    GrantCoOwnerAssetsType_Summary,
    GrantCoOwnerAssetsType_CloudRecording
};

typedef struct tagGrantCoOwnerAssetsInfo
{
    GrantCoOwnerAssetsType assetType;
    bool isAssetsLocked;
    bool isGranted;
    bool setGrant;
    tagGrantCoOwnerAssetsInfo()
    {
        assetType = GrantCoOwnerAssetsType_None;
        isAssetsLocked = false;
        isGranted = false;
        setGrant = false;
    }
}GrantCoOwnerAssetsInfo;
END_ZOOM_SDK_NAMESPACE
 
#endif