Meeting SDK for Linux API Reference
All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
setting_service_interface.h File Reference

Configure Service Interface. More...

#include "zoom_sdk_def.h"

Go to the source code of this file.

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
 
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
 Notify overall statistic information. Here are more detailed structural descriptions. More...
 
struct  tagAudioSessionStatisticInfo
 Notify the audio status information. Here are more detailed structural descriptions. More...
 
struct  tagASVSessionStatisticInfo
 Notify video status information. Here are more detailed structural descriptions. 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
 
typedef struct tagAudioSessionStatisticInfo AudioSessionStatisticInfo
 
typedef struct tagASVSessionStatisticInfo ASVSessionStatisticInfo
 

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
}
 Specify the values of available limit fps. Here are more detailed enum descriptions. 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
}
 
enum  VIDEO_LIGHT_ADAPTION_TYPE { Light_Adaption_None = 0 , Light_Adaption_Auto , Light_Adaption_Manual }
 
enum  AutoFramingMode { AutoFramingMode_none , AutoFramingMode_center_coordinates , AutoFramingMode_face_recognition }
 
enum  FaceRecognitionFailStrategy { FaceRecognitionFailStrategy_none , FaceRecognitionFailStrategy_remain , FaceRecognitionFailStrategy_using_center_coordinates , FaceRecognitionFailStrategy_using_original_video }
 
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 }
 
enum  SDK_ECHO_CANCELLATION_LEVEL { SDK_ECHO_CANCELLATION_DEFAULT = 0 , SDK_ECHO_CANCELLATION_AGGRESSIVE }
 
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
}
 Notify network type. Here are more detailed structural descriptions. More...
 
enum  SettingConnectionType { SETTINGS_CONNECTION_TYPE_CLOUD , SETTINGS_CONNECTION_TYPE_DIRECT , SETTINGS_CONNECTION_TYPE_UNKNOWN = -1 }
 Notify connection type. Here are more detailed structural descriptions. 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

◆ AudioSessionStatisticInfo

◆ OverallStatisticInfo

Enumeration Type Documentation

◆ AutoFramingMode

Enumerator
AutoFramingMode_none 

No use of the auto-framing.

AutoFramingMode_center_coordinates 

will use the center point of the video frame as the center for zoom-in

AutoFramingMode_face_recognition 

will use the detected face in the video frame as the center to zoom-in

Definition at line 690 of file setting_service_interface.h.

691{
695};
@ AutoFramingMode_center_coordinates
will use the center point of the video frame as the center for zoom-in
@ AutoFramingMode_face_recognition
will use the detected face in the video frame as the center to zoom-in
@ AutoFramingMode_none
No use of the auto-framing.

◆ FaceRecognitionFailStrategy

Enumerator
FaceRecognitionFailStrategy_none 

No use of the fail strategy.

FaceRecognitionFailStrategy_remain 

After face recognition fail, do nothing util face recognition success again.

FaceRecognitionFailStrategy_using_center_coordinates 

After face recognition fail, will use center point of the video frame as the center for zoom-in.

FaceRecognitionFailStrategy_using_original_video 

After face recognition fail, will use original video.

Definition at line 697 of file setting_service_interface.h.

698{
703};
@ FaceRecognitionFailStrategy_using_original_video
After face recognition fail, will use original video.
@ FaceRecognitionFailStrategy_none
No use of the fail strategy.
@ FaceRecognitionFailStrategy_remain
After face recognition fail, do nothing util face recognition success again.
@ FaceRecognitionFailStrategy_using_center_coordinates
After face recognition fail, will use center point of the video frame as the center for zoom-in.

◆ LimitFPSValue

Specify the values of available limit fps. Here are more detailed enum descriptions.

Enumerator
limitfps_Not_Enable 

The feature is not enabled.

limitfps_1_frame 

1 frame per second.

limitfps_2_frame 

2 frames per second.

limitfps_4_frame 

4 frames per second.

limitfps_6_frame 

6 frames per second.

limitfps_8_frame 

8 frames per second.

limitfps_10_frame 

10 frames per second.

limitfps_15_frame 

15 frames per second.

Definition at line 105 of file setting_service_interface.h.

106{
115};
@ limitfps_2_frame
2 frames per second.
@ limitfps_Not_Enable
The feature is not enabled.
@ limitfps_8_frame
8 frames per second.
@ limitfps_15_frame
15 frames per second.
@ limitfps_10_frame
10 frames per second.
@ limitfps_1_frame
1 frame per second.
@ limitfps_4_frame
4 frames per second.
@ limitfps_6_frame
6 frames per second.

◆ SDK_AUDIO_DEVICE_RAW_MODE_TYPE

Enumerator
SDK_AUDIO_DEVICE_RAW_MODE_DEFAULT 

default mode

SDK_AUDIO_DEVICE_RAW_MODE_ON 

on

SDK_AUDIO_DEVICE_RAW_MODE_OFF 

off

Definition at line 1010 of file setting_service_interface.h.

◆ SDK_ECHO_CANCELLATION_LEVEL

Enumerator
SDK_ECHO_CANCELLATION_DEFAULT 
SDK_ECHO_CANCELLATION_AGGRESSIVE 

Definition at line 1017 of file setting_service_interface.h.

◆ SettingConnectionType

Notify connection type. Here are more detailed structural descriptions.

Enumerator
SETTINGS_CONNECTION_TYPE_CLOUD 

Cloud connection.

SETTINGS_CONNECTION_TYPE_DIRECT 

Direct connection.

SETTINGS_CONNECTION_TYPE_UNKNOWN 

Unknown connection.

Definition at line 1372 of file setting_service_interface.h.

1373{
1377};
@ SETTINGS_CONNECTION_TYPE_UNKNOWN
Unknown connection.
@ SETTINGS_CONNECTION_TYPE_CLOUD
Cloud connection.
@ SETTINGS_CONNECTION_TYPE_DIRECT
Direct connection.

◆ SettingsNetWorkType

Notify network type. Here are more detailed structural descriptions.

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 1357 of file setting_service_interface.h.

1358{
1364
1366};
@ SETTINGS_NETWORK_3G
3G
@ SETTINGS_NETWORK_UNKNOWN
Unknown network.
@ SETTINGS_NETWORK_WIRED
Wired LAN.
@ SETTINGS_NETWORK_OTHERS
Others.
@ SETTINGS_NETWORK_WIFI
WIFI.
@ SETTINGS_NETWORK_PPP
PPP.

◆ Suppress_Background_Noise_Level

Enumerator
Suppress_BGNoise_Level_None 
Suppress_BGNoise_Level_Auto 
Suppress_BGNoise_Level_Low 
Suppress_BGNoise_Level_Medium 
Suppress_BGNoise_Level_High 

Definition at line 370 of file setting_service_interface.h.

◆ VIDEO_LIGHT_ADAPTION_TYPE

Enumerator
Light_Adaption_None 
Light_Adaption_Auto 
Light_Adaption_Manual 

Definition at line 666 of file setting_service_interface.h.

◆ ZoomSDKWallpaperLayoutMode

Enumerator
ZoomSDKWallpaperLayoutMode_None 
ZoomSDKWallpaperLayoutMode_Fill 
ZoomSDKWallpaperLayoutMode_Fit 

Definition at line 1476 of file setting_service_interface.h.

◆ ZoomSDKWallpaperSettingStatus

Enumerator
ZoomSDKWallpaperSettingStatus_None 
ZoomSDKWallpaperSettingStatus_Downloading 
ZoomSDKWallpaperSettingStatus_Downloaded 
ZoomSDKWallpaperSettingStatus_DownloadFail 

Definition at line 1483 of file setting_service_interface.h.