ZOOM Windows SDK  5.2.41727.0928
Classes | Macros | Typedefs | Enumerations | Variables
zoom_sdk_def.h File Reference

ZOOM windows SDK Common Definition File. More...

#include <tchar.h>

Go to the source code of this file.

Classes

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  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 tagRawDataOptions RawDataOptions
 
typedef struct tagInitParam InitParam
 

Enumerations

enum  SDKError {
  SDKERR_SUCCESS = 0, SDKERR_NO_IMPL, SDKERR_WRONG_USEAGE, 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_INTELNAL_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
}
 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
}
 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.
 
enum  ZoomSDKRawDataMemoryMode { ZoomSDKRawDataMemoryModeStack, ZoomSDKRawDataMemoryModeHeap }
 
enum  ZoomSDKVideoRenderMode {
  ZoomSDKVideoRenderMode_None = 0, ZoomSDKVideoRenderMode_Auto, ZoomSDKVideoRenderMode_D3D11EnableFLIP, ZoomSDKVideoRenderMode_D3D11,
  ZoomSDKVideoRenderMode_D3D9, ZoomSDKVideoRenderMode_GDI
}
 
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.

Enumeration Type Documentation

◆ 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.

◆ 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.

◆ 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.

◆ 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_USEAGE 

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_INTELNAL_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.