Configure Service Interface. More...

#include "zoom_sdk_def.h"

Data Structures
class	ICameraInfo
	Camera device information interface. More...

class	IMicInfo
	Microphone device information interface. More...

class	ISpeakerInfo
	Audio speaker device information interface. More...

class	IRingSpeakerInfo
	Ring speaker device information interface. More...

class	IGeneralSettingContext
	General setting interface. More...

class	IVideoSettingContextEvent
	Video setting context callback event. More...

struct	AutoFramingParameter
	Auto framing parameters. More...

class	IVideoSettingContext
	Video setting interface. More...

class	IAudioSettingContextEvent
	Audio setting context callback event. More...

class	IAudioSettingContext
	Audio setting interface. More...

class	IRecordingSettingContextEvent
	Recording setting context callback event. More...

class	IRecordingSettingContext
	Recording setting interface. More...

struct	tagOverallStatisticInfo
	Overall statistic information. More...

struct	tagAudioSessionStatisticInfo
	The audio status information. More...

struct	tagASVSessionStatisticInfo
	The video status information. More...

class	IStatisticSettingContext
	Statistic setting interface. More...

class	IWallpaperItem
	Wall-paper item interface. More...

class	IWallpaperSettingContextEvent
	Meeting wall-paper context Callback Event. More...

class	IWallpaperSettingContext
	Meeting Wall-paper setting interface. More...

class	IShareSettingContext
	Share setting interface. More...

class	ISettingService
	Meeting setting interface. More...

Typedefs
typedef struct tagOverallStatisticInfo	OverallStatisticInfo
	Overall statistic information.

typedef struct tagAudioSessionStatisticInfo	AudioSessionStatisticInfo
	The audio status information.

typedef struct tagASVSessionStatisticInfo	ASVSessionStatisticInfo
	The video status information.

Enumerations
enum	LimitFPSValue { limitfps_Not_Enable , limitfps_1_frame , limitfps_2_frame , limitfps_4_frame , limitfps_6_frame , limitfps_8_frame , limitfps_10_frame , limitfps_15_frame }
	Enumeration of the values to limit fps. More...

enum	Suppress_Background_Noise_Level { Suppress_BGNoise_Level_None = 0 , Suppress_BGNoise_Level_Auto , Suppress_BGNoise_Level_Low , Suppress_BGNoise_Level_Medium , Suppress_BGNoise_Level_High }
	Enumeration of the level to suppress background noise. For more information, please visit https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0059985. More...

enum	VIDEO_LIGHT_ADAPTION_TYPE { Light_Adaption_None = 0 , Light_Adaption_Auto , Light_Adaption_Manual }
	Enumeration of light adaption type. More...

enum	AutoFramingMode { AutoFramingMode_none , AutoFramingMode_center_coordinates , AutoFramingMode_face_recognition }
	Enumeration of the auto framing modes in video. More...

enum	FaceRecognitionFailStrategy { FaceRecognitionFailStrategy_none , FaceRecognitionFailStrategy_remain , FaceRecognitionFailStrategy_using_center_coordinates , FaceRecognitionFailStrategy_using_original_video }
	Enumeration of the face recognition failure strategies. More...

enum	SDK_AUDIO_DEVICE_RAW_MODE_TYPE { SDK_AUDIO_DEVICE_RAW_MODE_DEFAULT , SDK_AUDIO_DEVICE_RAW_MODE_ON , SDK_AUDIO_DEVICE_RAW_MODE_OFF }
	Enumeration of signal processing by Windows audio device drivers. For more information, please visit https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0066398. More...

enum	SDK_ECHO_CANCELLATION_LEVEL { SDK_ECHO_CANCELLATION_DEFAULT = 0 , SDK_ECHO_CANCELLATION_LOW , SDK_ECHO_CANCELLATION_HIGH }
	Enumeration for echo cancellation. For more information, please visit https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0066398. More...

enum	SettingsNetWorkType { SETTINGS_NETWORK_WIRED = 0 , SETTINGS_NETWORK_WIFI = 1 , SETTINGS_NETWORK_PPP = 2 , SETTINGS_NETWORK_3G = 3 , SETTINGS_NETWORK_OTHERS = 4 , SETTINGS_NETWORK_UNKNOWN = -1 }
	Enumeration of the network type. More...

enum	SettingConnectionType { SETTINGS_CONNECTION_TYPE_CLOUD , SETTINGS_CONNECTION_TYPE_DIRECT , SETTINGS_CONNECTION_TYPE_UNKNOWN = -1 }
	Enumeration of the connection type. More...

enum	ZoomSDKWallpaperLayoutMode { ZoomSDKWallpaperLayoutMode_None , ZoomSDKWallpaperLayoutMode_Fill , ZoomSDKWallpaperLayoutMode_Fit }

enum	ZoomSDKWallpaperSettingStatus { ZoomSDKWallpaperSettingStatus_None , ZoomSDKWallpaperSettingStatus_Downloading , ZoomSDKWallpaperSettingStatus_Downloaded , ZoomSDKWallpaperSettingStatus_DownloadFail }

Detailed Description

Configure Service Interface.

Definition in file setting_service_interface.h.

Typedef Documentation

◆ ASVSessionStatisticInfo

typedef struct tagASVSessionStatisticInfo ASVSessionStatisticInfo

The video status information.

◆ AudioSessionStatisticInfo

typedef struct tagAudioSessionStatisticInfo AudioSessionStatisticInfo

The audio status information.

◆ OverallStatisticInfo

typedef struct tagOverallStatisticInfo OverallStatisticInfo

Overall statistic information.

Enumeration Type Documentation

◆ AutoFramingMode

enum AutoFramingMode

Enumeration of the auto framing modes in video.

Enumerator
AutoFramingMode_none	No auto framing.
AutoFramingMode_center_coordinates	Use the video frame's center point as the center to zoom in.
AutoFramingMode_face_recognition	Use the detected face in the video frame as the center to zoom in.

Definition at line 919 of file setting_service_interface.h.

{
    AutoFramingMode_none,
    AutoFramingMode_center_coordinates,
    AutoFramingMode_face_recognition,
};

◆ FaceRecognitionFailStrategy

enum FaceRecognitionFailStrategy

Enumeration of the face recognition failure strategies.

Enumerator
FaceRecognitionFailStrategy_none	No use of the fail strategy.
FaceRecognitionFailStrategy_remain	After face recognition fails, do nothing until face recognition succeeds again.
FaceRecognitionFailStrategy_using_center_coordinates	After face recognition fails, use the video frame's center point as the center for zoom in.
FaceRecognitionFailStrategy_using_original_video	After face recognition fails, use original video.

Definition at line 932 of file setting_service_interface.h.

{
    FaceRecognitionFailStrategy_none,
    FaceRecognitionFailStrategy_remain,
    FaceRecognitionFailStrategy_using_center_coordinates,
    FaceRecognitionFailStrategy_using_original_video,
};

◆ LimitFPSValue

enum LimitFPSValue

Enumeration of the values to limit fps.

Enumerator
limitfps_Not_Enable	The feature is not enabled.
limitfps_1_frame	1 frame per second.
limitfps_2_frame	2 frame per second.
limitfps_4_frame	4 frame per second.
limitfps_6_frame	6 frame per second.
limitfps_8_frame	8 frame per second.
limitfps_10_frame	10 frame per second.
limitfps_15_frame	15 frame per second.

Definition at line 128 of file setting_service_interface.h.

{
    limitfps_Not_Enable,
    limitfps_1_frame,
    limitfps_2_frame,
    limitfps_4_frame,
    limitfps_6_frame,
    limitfps_8_frame,
    limitfps_10_frame,
    limitfps_15_frame,
};

◆ SDK_AUDIO_DEVICE_RAW_MODE_TYPE

enum SDK_AUDIO_DEVICE_RAW_MODE_TYPE

Enumeration of signal processing by Windows audio device drivers. For more information, please visit https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0066398.

Enumerator
SDK_AUDIO_DEVICE_RAW_MODE_DEFAULT	Allows Zoom Workplace to set the Windows signal processing mode for your device.
SDK_AUDIO_DEVICE_RAW_MODE_ON	Enables the drivers to provide a level of audio processing.
SDK_AUDIO_DEVICE_RAW_MODE_OFF	Puts the drivers into "Raw" mode so that the ZoomWorkplave app can receive an unprocessed signal.

Definition at line 1339 of file setting_service_interface.h.

{
    SDK_AUDIO_DEVICE_RAW_MODE_DEFAULT,
    SDK_AUDIO_DEVICE_RAW_MODE_ON, 
    SDK_AUDIO_DEVICE_RAW_MODE_OFF 
}SDK_AUDIO_DEVICE_RAW_MODE_TYPE;

◆ SDK_ECHO_CANCELLATION_LEVEL

enum SDK_ECHO_CANCELLATION_LEVEL

Enumeration for echo cancellation. For more information, please visit https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0066398.

Enumerator
SDK_ECHO_CANCELLATION_DEFAULT	Automatically adjust echo cancellation, balancing CPU and performance.
SDK_ECHO_CANCELLATION_LOW	Better echo limitation, taking into account multiple people talking at the same time, low CPU utilization.
SDK_ECHO_CANCELLATION_HIGH	Best experience when multiple people are talking at the same time. Enabling this option may increase CPU utilization.

Definition at line 1352 of file setting_service_interface.h.

             {
    SDK_ECHO_CANCELLATION_DEFAULT = 0,
    SDK_ECHO_CANCELLATION_LOW,
    SDK_ECHO_CANCELLATION_HIGH
}SDK_ECHO_CANCELLATION_LEVEL;

◆ SettingConnectionType

enum SettingConnectionType

Enumeration of the connection type.

Enumerator
SETTINGS_CONNECTION_TYPE_CLOUD	Cloud connection.
SETTINGS_CONNECTION_TYPE_DIRECT	Direct connection.
SETTINGS_CONNECTION_TYPE_UNKNOWN	Unknown connection.

Definition at line 1802 of file setting_service_interface.h.

{
    SETTINGS_CONNECTION_TYPE_CLOUD,
    SETTINGS_CONNECTION_TYPE_DIRECT,
    SETTINGS_CONNECTION_TYPE_UNKNOWN = -1,
};

◆ SettingsNetWorkType

enum SettingsNetWorkType

Enumeration of the network type.

Enumerator
SETTINGS_NETWORK_WIRED	Wired LAN.
SETTINGS_NETWORK_WIFI	WIFI.
SETTINGS_NETWORK_PPP	PPP.
SETTINGS_NETWORK_3G	3G.
SETTINGS_NETWORK_OTHERS	Others.
SETTINGS_NETWORK_UNKNOWN	Unknown network.

Definition at line 1783 of file setting_service_interface.h.

{ 
    SETTINGS_NETWORK_WIRED  = 0,
    SETTINGS_NETWORK_WIFI   = 1,
    SETTINGS_NETWORK_PPP    = 2,
    SETTINGS_NETWORK_3G     = 3,
    SETTINGS_NETWORK_OTHERS = 4,
    SETTINGS_NETWORK_UNKNOWN = -1,
};

◆ Suppress_Background_Noise_Level

enum Suppress_Background_Noise_Level

Enumeration of the level to suppress background noise. For more information, please visit https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0059985.

Enumerator
Suppress_BGNoise_Level_None	For initialization.
Suppress_BGNoise_Level_Auto	Automatically adjust noise suppression.
Suppress_BGNoise_Level_Low	Low level suppression. Allows faint background.
Suppress_BGNoise_Level_Medium	Medium level suppression. Filters out moderate noise like computer fan or desk taps.
Suppress_BGNoise_Level_High	High level suppression. Eliminates most background speech and persistent noise.

Definition at line 497 of file setting_service_interface.h.

{
    Suppress_BGNoise_Level_None = 0,
    Suppress_BGNoise_Level_Auto,
    Suppress_BGNoise_Level_Low,
    Suppress_BGNoise_Level_Medium,
    Suppress_BGNoise_Level_High,
};

◆ VIDEO_LIGHT_ADAPTION_TYPE

enum VIDEO_LIGHT_ADAPTION_TYPE

Enumeration of light adaption type.

Enumerator
Light_Adaption_None	None.
Light_Adaption_Auto	Auto type.
Light_Adaption_Manual	Manual type.

Definition at line 882 of file setting_service_interface.h.

{
    Light_Adaption_None = 0,
    Light_Adaption_Auto,
    Light_Adaption_Manual,
}VIDEO_LIGHT_ADAPTION_TYPE;

◆ ZoomSDKWallpaperLayoutMode

enum ZoomSDKWallpaperLayoutMode

Enumerator
ZoomSDKWallpaperLayoutMode_None
ZoomSDKWallpaperLayoutMode_Fill
ZoomSDKWallpaperLayoutMode_Fit

Definition at line 1934 of file setting_service_interface.h.

{
    ZoomSDKWallpaperLayoutMode_None,
    ZoomSDKWallpaperLayoutMode_Fill,
    ZoomSDKWallpaperLayoutMode_Fit
}ZoomSDKWallpaperLayoutMode;

◆ ZoomSDKWallpaperSettingStatus

enum ZoomSDKWallpaperSettingStatus

Enumerator
ZoomSDKWallpaperSettingStatus_None
ZoomSDKWallpaperSettingStatus_Downloading
ZoomSDKWallpaperSettingStatus_Downloaded
ZoomSDKWallpaperSettingStatus_DownloadFail

Definition at line 1941 of file setting_service_interface.h.

{
    ZoomSDKWallpaperSettingStatus_None,
    ZoomSDKWallpaperSettingStatus_Downloading,
    ZoomSDKWallpaperSettingStatus_Downloaded,
    ZoomSDKWallpaperSettingStatus_DownloadFail
}ZoomSDKWallpaperSettingStatus;

Data Structures

Typedefs

Enumerations