ZOOM windows SDK Common Definition File. More...

#include <stdint.h>
#include <unistd.h>
#include <cstring>
#include <float.h>

Data Structures
struct	tagConfigurableOptions

struct	tagRawDataOptions
	Rawdata options. More...

struct	tagInitParam
	Initialize the SDK Parameter. 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 >

struct	ZoomSDKColor
	Zoom SDK color. The standard RGB color model has a value range of 0-255. More...

struct	tagGrantCoOwnerAssetsInfo
	Asset information. More...

Macros
#define	TLS_KEY_DEF pthread_key_t

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

Typedefs
typedef char	zchar_t

typedef uint64_t	UINT64

typedef int64_t	INT64

typedef float	FLOAT

typedef void *	HWND

typedef struct tagConfigurableOptions	ConfigurableOptions

typedef struct tagRawDataOptions	RawDataOptions
	Rawdata options.

typedef struct tagInitParam	InitParam
	Initialize the SDK Parameter.

typedef struct tagGrantCoOwnerAssetsInfo	GrantCoOwnerAssetsInfo
	Asset information.

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 , SDKERR_NOT_JOIN_AUDIO , SDKERR_HARDWARE_DONT_SUPPORT , SDKERR_DOMAIN_DONT_SUPPORT , SDKERR_MEETING_REMOTE_CONTROL_IS_OFF , SDKERR_FILETRANSFER_ERROR }
	Enumeration of common errors of SDK. More...

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 }
	Enumeration of the text resource type used by the SDK. More...

enum	ZoomSDKRawDataMemoryMode { ZoomSDKRawDataMemoryModeStack , ZoomSDKRawDataMemoryModeHeap }
	Enumeration of memory modes for raw data handling. More...

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 }
	Enumeration of types of shared content. More...

enum	LastErrorType { LastErrorType_None , LastErrorType_Auth , LastErrorType_Login , LastErrorType_Meeting , LastErrorType_System }
	Enumeration of the last error types of the SDK. More...

enum	FrameDataFormat { FrameDataFormat_I420_LIMITED , FrameDataFormat_I420_FULL }
	Enumeration of video frame data format. More...

enum	ZoomSDKAudioChannel { ZoomSDKAudioChannel_Mono , ZoomSDKAudioChannel_Stereo }
	Enumeration of the audio modes. More...

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 }
	Enumeration of reasons why sharing is not allowed. More...

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 }
	Enumeration of sharing status. More...

enum	GrantCoOwnerAssetsType { GrantCoOwnerAssetsType_None , GrantCoOwnerAssetsType_Summary , GrantCoOwnerAssetsType_CloudRecording }
	Enumeration of asset type. More...

Detailed Description

ZOOM windows SDK Common Definition File.

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 34 of file zoom_sdk_def.h.

◆ END_ZOOM_SDK_NAMESPACE

#define END_ZOOM_SDK_NAMESPACE };

Definition at line 35 of file zoom_sdk_def.h.

◆ PLATFORM_EXPORT

#define PLATFORM_EXPORT __declspec(dllexport)

Definition at line 24 of file zoom_sdk_def.h.

◆ PLATFORM_IMPORT

#define PLATFORM_IMPORT __declspec(dllimport)

Definition at line 23 of file zoom_sdk_def.h.

◆ SDK_API

#define SDK_API

Definition at line 30 of file zoom_sdk_def.h.

◆ TLS_KEY_DEF

#define TLS_KEY_DEF pthread_key_t

Definition at line 21 of file zoom_sdk_def.h.

◆ USING_ZOOM_SDK_NAMESPACE

#define USING_ZOOM_SDK_NAMESPACE using namespace ZOOM_SDK_NAMESPACE;

Definition at line 36 of file zoom_sdk_def.h.

◆ ZOOM_SDK_NAMESPACE

#define ZOOM_SDK_NAMESPACE ZOOMSDK

Definition at line 33 of file zoom_sdk_def.h.

Typedef Documentation

◆ ConfigurableOptions

typedef struct tagConfigurableOptions ConfigurableOptions

◆ FLOAT

typedef float FLOAT

Definition at line 19 of file zoom_sdk_def.h.

◆ GrantCoOwnerAssetsInfo

typedef struct tagGrantCoOwnerAssetsInfo GrantCoOwnerAssetsInfo

Asset information.

◆ HWND

typedef void* HWND

Definition at line 20 of file zoom_sdk_def.h.

◆ InitParam

typedef struct tagInitParam InitParam

Initialize the SDK Parameter.

◆ INT64

typedef int64_t INT64

Definition at line 18 of file zoom_sdk_def.h.

◆ RawDataOptions

typedef struct tagRawDataOptions RawDataOptions

Rawdata options.

◆ UINT64

typedef uint64_t UINT64

Definition at line 17 of file zoom_sdk_def.h.

◆ zchar_t

typedef char zchar_t

Definition at line 16 of file zoom_sdk_def.h.

Enumeration Type Documentation

◆ CannotShareReasonType

enum CannotShareReasonType

Enumeration of reasons why sharing is not allowed.

Enumerator
CannotShareReasonType_None	For initialization.
CannotShareReasonType_Locked	Only the host is allowed to share.
CannotShareReasonType_Disabled	Sharing is disabled.
CannotShareReasonType_Other_Screen_Sharing	Another participant is currently sharing their screen.
CannotShareReasonType_Other_WB_Sharing	Another participant is currently sharing their whiteboard.
CannotShareReasonType_Need_Grab_Myself_Screen_Sharing	The user is sharing screen, and can grab. To grab, call EnableGrabShareWithoutReminder(true) before starting the share.
CannotShareReasonType_Need_Grab_Other_Screen_Sharing	Another is sharing their screen, and can grab. To grab, call EnableGrabShareWithoutReminder(true) before starting share.
CannotShareReasonType_Need_Grab_Audio_Sharing	Another is sharing pure computer audio, and can grab. To grab, call EnableGrabShareWithoutReminder(true) before starting share.
CannotShareReasonType_Need_Grap_WB_Sharing	Other or myself is sharing whiteboard, and can Grab. To grab, call EnableGrabShareWithoutReminder(true) before starting share.
CannotShareReasonType_Reach_Maximum	The meeting has reached the maximum allowed screen share sessions.
CannotShareReasonType_Have_Share_From_Mainsession	Other share screen in main session.
CannotShareReasonType_Other_DOCS_Sharing	Another participant is sharing their zoom docs.
CannotShareReasonType_Need_Grab_DOCS_Sharing	Other or myself is sharing docs, and can grab. To grab, call EnableGrabShareWithoutReminder(true) before starting share.
CannotShareReasonType_UnKnown	UnKnown reason.

Definition at line 524 of file zoom_sdk_def.h.

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

◆ FrameDataFormat

enum FrameDataFormat

Enumeration of video frame data format.

Enumerator
FrameDataFormat_I420_LIMITED	I420 format with limited (TV) range color space.
FrameDataFormat_I420_FULL	I420 format with full (PC) range color space.

Definition at line 502 of file zoom_sdk_def.h.

{
    FrameDataFormat_I420_LIMITED,
    FrameDataFormat_I420_FULL,
};

◆ GrantCoOwnerAssetsType

enum GrantCoOwnerAssetsType

Enumeration of asset type.

Enumerator
GrantCoOwnerAssetsType_None	For initialization.
GrantCoOwnerAssetsType_Summary	Summary.
GrantCoOwnerAssetsType_CloudRecording	CloudRecording.

Definition at line 600 of file zoom_sdk_def.h.

                            {
    GrantCoOwnerAssetsType_None,
    GrantCoOwnerAssetsType_Summary,
    GrantCoOwnerAssetsType_CloudRecording
};

◆ LastErrorType

enum LastErrorType

Enumeration of the last error types of the SDK.

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 447 of file zoom_sdk_def.h.

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

◆ SDK_LANGUAGE_ID

enum SDK_LANGUAGE_ID

Enumeration of the text resource type used by the SDK.

Enumerator
LANGUAGE_Unknown	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.
LANGUAGE_Indonesian	In Indonesian.
LANGUAGE_Dutch	In Dutch.
LANGUAGE_Swedish	In Swedish.

Definition at line 124 of file zoom_sdk_def.h.

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

◆ SDKError

enum SDKError

Enumeration of common errors of SDK.

Enumerator
SDKERR_SUCCESS	Success.
SDKERR_NO_IMPL	The 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	Share can not subscribe myself.
SDKERR_NOT_IN_MEETING	Not in meeting.
SDKERR_NOT_JOIN_AUDIO	Not Joining audio.
SDKERR_HARDWARE_DONT_SUPPORT	The current device doesn't support the feature.
SDKERR_DOMAIN_DONT_SUPPORT	Domain not support.
SDKERR_MEETING_REMOTE_CONTROL_IS_OFF	Remote control is disabled.
SDKERR_FILETRANSFER_ERROR	File transfer fail.

Definition at line 42 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,
    SDKERR_NOT_JOIN_AUDIO,
    SDKERR_HARDWARE_DONT_SUPPORT,
    SDKERR_DOMAIN_DONT_SUPPORT,
    SDKERR_MEETING_REMOTE_CONTROL_IS_OFF,
    SDKERR_FILETRANSFER_ERROR,
 
};

◆ ShareType

enum ShareType

Enumeration of types of shared content.

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.
SHARE_TYPE_VIDEO_FILE	Type of sharing the video file.
SHARE_TYPE_FRAME	Type of sharing the frame.
SHARE_TYPE_DOCUMENT	Type of sharing the document.
SHARE_TYPE_COMPUTER_AUDIO	Type of sharing the computer audio.

Definition at line 418 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,
    SHARE_TYPE_VIDEO_FILE,
    SHARE_TYPE_FRAME,
    SHARE_TYPE_DOCUMENT,
    SHARE_TYPE_COMPUTER_AUDIO
};

◆ SharingStatus

enum SharingStatus

Enumeration of sharing status.

Enumerator
Sharing_Self_Send_Begin	Begin to share by the user himself.
Sharing_Self_Send_End	Stop sharing by the user.
Sharing_Self_Send_Pure_Audio_Begin	Begin to share pure audio by the user himself.
Sharing_Self_Send_Pure_Audio_End	Stop sharing pure audio by the user.
Sharing_Other_Share_Begin	Others begin to share.
Sharing_Other_Share_End	Others stop sharing.
Sharing_Other_Share_Pure_Audio_Begin	Others begin to share pure audio.
Sharing_Other_Share_Pure_Audio_End	Others stop sharing pure audio.
Sharing_View_Other_Sharing	View the sharing of others.
Sharing_Pause	Pause sharing.
Sharing_Resume	Resume sharing.

Definition at line 559 of file zoom_sdk_def.h.

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

◆ ZoomSDKAudioChannel

enum ZoomSDKAudioChannel

Enumeration of the audio modes.

Enumerator
ZoomSDKAudioChannel_Mono	Single channel audio.
ZoomSDKAudioChannel_Stereo	Stereo audio.

Definition at line 513 of file zoom_sdk_def.h.

{
    ZoomSDKAudioChannel_Mono,
    ZoomSDKAudioChannel_Stereo,
};

◆ ZoomSDKRawDataMemoryMode

enum ZoomSDKRawDataMemoryMode

Enumeration of memory modes for raw data handling.

Enumerator
ZoomSDKRawDataMemoryModeStack	Use stack memory.
ZoomSDKRawDataMemoryModeHeap	Use heap memory.

Definition at line 167 of file zoom_sdk_def.h.

{
    ZoomSDKRawDataMemoryModeStack,
    ZoomSDKRawDataMemoryModeHeap
};

Data Structures

Macros

Typedefs

Enumerations