ZOOM windows SDK Common Definition File. More...

#include <tchar.h>

Data Structures
struct	tagWndPosition
	The position of the window. The coordinate of position is that of monitor when the parent window is null. If the the parent window is not null, the position coordinate is that of the parent window. Here are more detailed structural descriptions. More...

struct	tagCustomizedLanguageInfo

struct	tagConfigurableOptions
	SDK configuration options. More...

struct	tagZoomSDKRenderOptions

struct	tagRawDataOptions

struct	tagInitParam
	Initialize the SDK Parameter. Here are more detailed structural descriptions. More...

class	IZoomLastError
	Error mechanism interface provided by the SDK This feature is gradually improved, so some errors may not be supported. More...

class	IList< T >

Macros
#define	PLATFORM_IMPORT __declspec(dllimport)

#define	PLATFORM_EXPORT __declspec(dllexport)

#define	SDK_API

#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;

#define	ENABLE_CUSTOMIZED_UI_FLAG (1 << 5)

#define	SDK_NULL_AUDIO_FILE_HANDLE (0xffffffff)

Typedefs
typedef struct tagWndPosition	WndPosition

typedef struct tagCustomizedLanguageInfo	CustomizedLanguageInfo

typedef struct tagConfigurableOptions	ConfigurableOptions

typedef struct tagZoomSDKRenderOptions	ZoomSDKRenderOptions

typedef struct tagRawDataOptions	RawDataOptions

typedef struct tagInitParam	InitParam

Enumerations
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 }
	SDK error types. Here are more detailed structural descriptions. More...

enum	SDK_LANGUAGE_ID { LANGUAGE_Unknow = 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 }
	The text resource type used by the SDK. Here are more detailed structural descriptions. More...

enum	CustomizedLanguageType { CustomizedLanguage_None , CustomizedLanguage_FilePath , CustomizedLanguage_Content }
	Custom resource type used by the SDK. Here are more detailed structural descriptions. More...

enum	SDK_APP_Locale { SDK_APP_Locale_Default , SDK_APP_Locale_CN }
	SDK_APP locale type. Here are more detailed structural descriptions. More...

enum	ZoomSDKRawDataMemoryMode { ZoomSDKRawDataMemoryModeStack , ZoomSDKRawDataMemoryModeHeap }

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 }

enum	ShareType { SHARE_TYPE_UNKNOWN , SHARE_TYPE_AS , SHARE_TYPE_DS , SHARE_TYPE_WB , SHARE_TYPE_AIRHOST , SHARE_TYPE_CAMERA , SHARE_TYPE_DATA }

enum	LastErrorType { LastErrorType_None , LastErrorType_Auth , LastErrorType_Login , LastErrorType_Meeting , LastErrorType_System }
	The last error types of the SDK. Here are more detailed structural descriptions. More...

Variables
const RECT	_SDK_TEST_VIDEO_INIT_RECT = {0,0,0,0}

Detailed Description

ZOOM windows SDK Common Definition File.

SDK utility Definition of ZOOM windows.

Definition in file zoom_sdk_def.h.

Macro Definition Documentation

◆ BEGIN_ZOOM_SDK_NAMESPACE

#define BEGIN_ZOOM_SDK_NAMESPACE namespace ZOOM_SDK_NAMESPACE {

Definition at line 20 of file zoom_sdk_def.h.

◆ ENABLE_CUSTOMIZED_UI_FLAG

#define ENABLE_CUSTOMIZED_UI_FLAG (1 << 5)

Definition at line 141 of file zoom_sdk_def.h.

◆ END_ZOOM_SDK_NAMESPACE

#define END_ZOOM_SDK_NAMESPACE };

Definition at line 21 of file zoom_sdk_def.h.

◆ PLATFORM_EXPORT

#define PLATFORM_EXPORT __declspec(dllexport)

Definition at line 10 of file zoom_sdk_def.h.

◆ PLATFORM_IMPORT

#define PLATFORM_IMPORT __declspec(dllimport)

Definition at line 9 of file zoom_sdk_def.h.

◆ SDK_API

#define SDK_API

Definition at line 16 of file zoom_sdk_def.h.

◆ SDK_NULL_AUDIO_FILE_HANDLE

#define SDK_NULL_AUDIO_FILE_HANDLE (0xffffffff)

Definition at line 316 of file zoom_sdk_def.h.

◆ USING_ZOOM_SDK_NAMESPACE

#define USING_ZOOM_SDK_NAMESPACE using namespace ZOOM_SDK_NAMESPACE;

Definition at line 22 of file zoom_sdk_def.h.

◆ ZOOM_SDK_NAMESPACE

#define ZOOM_SDK_NAMESPACE ZOOMSDK

Definition at line 19 of file zoom_sdk_def.h.

Typedef Documentation

◆ ConfigurableOptions

typedef struct tagConfigurableOptions ConfigurableOptions

◆ CustomizedLanguageInfo

typedef struct tagCustomizedLanguageInfo CustomizedLanguageInfo

◆ InitParam

typedef struct tagInitParam InitParam

◆ RawDataOptions

typedef struct tagRawDataOptions RawDataOptions

◆ WndPosition

typedef struct tagWndPosition WndPosition

◆ ZoomSDKRenderOptions

typedef struct tagZoomSDKRenderOptions ZoomSDKRenderOptions

Enumeration Type Documentation

◆ CustomizedLanguageType

enum CustomizedLanguageType

Custom resource type used by the SDK. Here are more detailed structural descriptions.

Enumerator
CustomizedLanguage_None	No use of the custom resource.
CustomizedLanguage_FilePath	Use the specified file path to assign the custom resource.
CustomizedLanguage_Content	Use the specified content to assign the custom resource.

Definition at line 111 of file zoom_sdk_def.h.

{
    CustomizedLanguage_None,
    CustomizedLanguage_FilePath,
    CustomizedLanguage_Content,
};

◆ LastErrorType

enum LastErrorType

The last error types of the SDK. Here are more detailed structural descriptions.

Enumerator
LastErrorType_None	No error.
LastErrorType_Auth	Error during verification.
LastErrorType_Login	Error during login.
LastErrorType_Meeting	The associated error with the meeting.
LastErrorType_System	The associated error with the SDK bottom layer.

Definition at line 282 of file zoom_sdk_def.h.

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

◆ SDK_APP_Locale

enum SDK_APP_Locale

SDK_APP locale type. Here are more detailed structural descriptions.

Enumerator
SDK_APP_Locale_Default
SDK_APP_Locale_CN

Definition at line 159 of file zoom_sdk_def.h.

{
    SDK_APP_Locale_Default,
    SDK_APP_Locale_CN,
};

◆ SDK_LANGUAGE_ID

enum SDK_LANGUAGE_ID

The text resource type used by the SDK. Here are more detailed structural descriptions.

Enumerator
LANGUAGE_Unknow	For initialization.
LANGUAGE_English	In English.
LANGUAGE_Chinese_Simplified	In simplified Chinese.
LANGUAGE_Chinese_Traditional	In traditional Chinese.
LANGUAGE_Japanese	In Japanese.
LANGUAGE_Spanish	In Spanish.
LANGUAGE_German	In German.
LANGUAGE_French	In French.
LANGUAGE_Portuguese	In Portuguese.
LANGUAGE_Russian	In Russian.
LANGUAGE_Korean	In Korean.
LANGUAGE_Vietnamese	In Vietnamese.
LANGUAGE_Italian	In Italian.
LANGUAGE_Polish	In Polish.
LANGUAGE_Turkish	In Turkish.

Definition at line 69 of file zoom_sdk_def.h.

{
    LANGUAGE_Unknow = 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
};

◆ SDKError

enum SDKError

SDK error types. Here are more detailed structural descriptions.

Enumerator
SDKERR_SUCCESS	Success.
SDKERR_NO_IMPL	This feature is currently invalid.
SDKERR_WRONG_USAGE	Incorrect usage of the feature.
SDKERR_INVALID_PARAMETER	Wrong parameter.
SDKERR_MODULE_LOAD_FAILED	Loading module failed.
SDKERR_MEMORY_FAILED	No memory is allocated.
SDKERR_SERVICE_FAILED	Internal service error.
SDKERR_UNINITIALIZE	Not initialized before the usage.
SDKERR_UNAUTHENTICATION	Not authorized before the usage.
SDKERR_NORECORDINGINPROCESS	No recording in process.
SDKERR_TRANSCODER_NOFOUND	Transcoder module is not found.
SDKERR_VIDEO_NOTREADY	The video service is not ready.
SDKERR_NO_PERMISSION	No permission.
SDKERR_UNKNOWN	Unknown error.
SDKERR_OTHER_SDK_INSTANCE_RUNNING	The other instance of the SDK is in process.
SDKERR_INTERNAL_ERROR	SDK internal error.
SDKERR_NO_AUDIODEVICE_ISFOUND	No audio device found.
SDKERR_NO_VIDEODEVICE_ISFOUND	No video device found.
SDKERR_TOO_FREQUENT_CALL	API calls too frequently.
SDKERR_FAIL_ASSIGN_USER_PRIVILEGE	User can't be assigned with new privilege.
SDKERR_MEETING_DONT_SUPPORT_FEATURE	The current meeting doesn't support the feature.
SDKERR_MEETING_NOT_SHARE_SENDER	The current user is not the presenter.
SDKERR_MEETING_YOU_HAVE_NO_SHARE	There is no sharing.
SDKERR_MEETING_VIEWTYPE_PARAMETER_IS_WRONG	Incorrect ViewType parameters.
SDKERR_MEETING_ANNOTATION_IS_OFF	Annotation is disabled.
SDKERR_SETTING_OS_DONT_SUPPORT	Current OS doesn't support the setting.
SDKERR_EMAIL_LOGIN_IS_DISABLED	Email login is disable.
SDKERR_HARDWARE_NOT_MEET_FOR_VB	Computer doesn't meet the minimum requirements to use virtual background feature.
SDKERR_NEED_USER_CONFIRM_RECORD_DISCLAIMER	Need process disclaimer.
SDKERR_NO_SHARE_DATA	There is no raw data of sharing.
SDKERR_SHARE_CANNOT_SUBSCRIBE_MYSELF
SDKERR_NOT_IN_MEETING

Definition at line 29 of file zoom_sdk_def.h.

{
    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,
};

◆ ShareType

enum ShareType

Type of current sharing received by the user. Here are more detailed structural descriptions..

Enumerator
SHARE_TYPE_UNKNOWN	Type unknown.
SHARE_TYPE_AS	Type of sharing the application.
SHARE_TYPE_DS	Type of sharing the desktop.
SHARE_TYPE_WB	Type of sharing the white-board.
SHARE_TYPE_AIRHOST	Type of sharing data from the device connected WIFI.
SHARE_TYPE_CAMERA	Type of sharing the camera.
SHARE_TYPE_DATA	Type of sharing the data.

Definition at line 267 of file zoom_sdk_def.h.

{
    SHARE_TYPE_UNKNOWN,
    SHARE_TYPE_AS,
    SHARE_TYPE_DS,
    SHARE_TYPE_WB,
    SHARE_TYPE_AIRHOST,
    SHARE_TYPE_CAMERA,
    SHARE_TYPE_DATA,
};

◆ ZoomSDKRawDataMemoryMode

enum ZoomSDKRawDataMemoryMode

Enumerator
ZoomSDKRawDataMemoryModeStack
ZoomSDKRawDataMemoryModeHeap

Definition at line 165 of file zoom_sdk_def.h.

{
    ZoomSDKRawDataMemoryModeStack,
    ZoomSDKRawDataMemoryModeHeap
};

◆ ZoomSDKRenderPostProcessing

enum ZoomSDKRenderPostProcessing

Enumerator
ZoomSDKRenderPostProcessing_None
ZoomSDKRenderPostProcessing_Auto
ZoomSDKRenderPostProcessing_Enable
ZoomSDKRenderPostProcessing_Disable

Definition at line 181 of file zoom_sdk_def.h.

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

◆ ZoomSDKVideoCaptureMethod

enum ZoomSDKVideoCaptureMethod

Enumerator
ZoomSDKVideoCaptureMethod_None
ZoomSDKVideoCaptureMethod_Auto
ZoomSDKVideoCaptureMethod_DirectSHow
ZoomSDKVideoCaptureMethod_MediaFoundation

Definition at line 189 of file zoom_sdk_def.h.

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

◆ ZoomSDKVideoRenderMode

enum ZoomSDKVideoRenderMode

Enumerator
ZoomSDKVideoRenderMode_None
ZoomSDKVideoRenderMode_Auto
ZoomSDKVideoRenderMode_D3D11EnableFLIP
ZoomSDKVideoRenderMode_D3D11
ZoomSDKVideoRenderMode_D3D9
ZoomSDKVideoRenderMode_GDI

Definition at line 171 of file zoom_sdk_def.h.

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

Variable Documentation

◆ _SDK_TEST_VIDEO_INIT_RECT

const RECT _SDK_TEST_VIDEO_INIT_RECT = {0,0,0,0}

Definition at line 317 of file zoom_sdk_def.h.

Data Structures

Macros

Typedefs

Enumerations

Variables