setting_service_interface.h

Go to the documentation of this file.

#ifndef _SETTING_SERVICE_INTERFACE_H_
#define _SETTING_SERVICE_INTERFACE_H_
#include "zoom_sdk_def.h"
#if defined(WIN32)
#include "zoom_sdk_util_define.h"
#endif
 
BEGIN_ZOOM_SDK_NAMESPACE
class ICameraInfo
{
public:
    virtual const zchar_t* GetDeviceId() = 0;

    virtual const zchar_t* GetDeviceName() = 0;

    virtual bool IsSelectedDevice() = 0;
 
    virtual ~ICameraInfo() {};
};

class IMicInfo
{
public:
    virtual const zchar_t* GetDeviceId() = 0;

    virtual const zchar_t* GetDeviceName() = 0;

    virtual bool IsSelectedDevice() = 0;
 
    virtual ~IMicInfo() {};
};

class ISpeakerInfo
{
public:
    virtual const zchar_t* GetDeviceId() = 0;

    virtual const zchar_t* GetDeviceName() = 0;

    virtual bool IsSelectedDevice() = 0;
 
    virtual ~ISpeakerInfo() {};
};

class IRingSpeakerInfo
{
public:
    virtual const zchar_t* GetDeviceId() = 0;

    virtual const zchar_t* GetDeviceName() = 0;

    virtual bool IsSelectedDevice() = 0;
 
    virtual ~IRingSpeakerInfo() {};
};

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,
};
 
 
#if defined(WIN32)
typedef enum tagReactionSkinToneType
{
    ReactionSkinTone_None = 0,
    ReactionSkinTone_Default,
    ReactionSkinTone_Light,
    ReactionSkinTone_MediumLight,
    ReactionSkinTone_Medium,
    ReactionSkinTone_MediumDark,
    ReactionSkinTone_Dark,
}ReactionSkinToneType;

enum ZoomSDKUITheme
{
    ZoomSDKUITheme_Bloom,
    ZoomSDKUITheme_Rose,
    ZoomSDKUITheme_Agave,
    ZoomSDKUITheme_Classic,
};

enum ZoomSDKUIAppearance
{
    ZoomSDKUIAppearance_Light = 1,
    ZoomSDKUIAppearance_Dark,
    ZoomSDKUIAppearance_System,
};

enum WindowSizeType
{
    WindowSize_None = 0,
    WindowSize_FullScreen,
    WindowSize_Maximize,
    WindowSize_CurrentSize,
};

enum SettingTabPage
{
    SettingTabPage_General,
    SettingTabPage_Audio,
    SettingTabPage_Video,
};

enum ScreenCaptureMode
{
    CaptureMode_auto = 0,
    CaptureMode_legacy,
    CaptureMode_gpu_copy_filter,
    CaptureMode_ada_copy_filter,
    CaptureMode_ada_copy_without_filter,
    CaptureMode_ada_secure_filter,
    CaptureMode_end,
};

enum ShareOptionInMeeting
{
    ShareOptionInMeeting_AllOption,
    ShareOptionInMeeting_AutoShareDesktop,
};

enum ShareOptionToRoom
{
    ShareOptionToRoom_AllOption,
    ShareOptionToRoom_AutoShareDesktop,
};

enum ShareSelectMode
{
    SelectMode_None = 0,
    SelectMode_Window,
    SelectMode_Process,
};

typedef struct tagShowSettingDlgParam
{
    HWND hParent;
    int top;
    int left;
    HWND hSettingWnd;
    bool bShow;
    bool bCenter;
    SettingTabPage eTabPageType; 
    tagShowSettingDlgParam()
    {
        hParent = nullptr;
        top = 0;
        left = 0;
        hSettingWnd = nullptr;
        bShow = true;
        bCenter = false;
        eTabPageType = SettingTabPage_General;
    }
}ShowSettingDlgParam;

typedef struct tagSettingDlgShowTabPageOption
{
    bool bShowGeneral;
    bool bShowVideo; 
    bool bShowAudio;
    bool bShowShareScreen; 
    bool bShowVirtualBackGround;
    bool bSHowRecording;
    bool bShowAdvancedFeature;
    bool bShowStatistics;
    bool bShowFeedback;
    bool bShowKeyboardShortcuts;
    bool bShowAccessibility;
    tagSettingDlgShowTabPageOption()
    {
        bShowGeneral = true;
        bShowVideo = true;
        bShowAudio = true;
        bShowShareScreen = true;
        bShowVirtualBackGround = true;
        bSHowRecording = true;
        bShowStatistics = true;
        bShowAccessibility = true;
        bShowKeyboardShortcuts = true;
        bShowAdvancedFeature = false;
        bShowFeedback = false;
    }
 
}SettingDlgShowTabPageOption;

typedef struct tagSettingDlgShowUrlOption
{
    bool bShowGeneralViewMoreSetting;
    bool bShowVideoSupportCenter; 
    bool bShowAudioLearnMore;
    bool bShowShareAndVBLearnMore;
    tagSettingDlgShowUrlOption()
    {
        bShowGeneralViewMoreSetting = true;
        bShowVideoSupportCenter = true;
        bShowAudioLearnMore = true;
        bShowShareAndVBLearnMore = true;
    }
 
}SettingDlgShowUrlOption;

typedef enum
{
    enuCanTest = 0,
    enuMicRecording,
    enuCanPlay,
} SDK_TESTMIC_STATUS;

class ITestAudioDeviceHelperEvent
{
public:
    virtual ~ITestAudioDeviceHelperEvent() {}

    virtual void OnMicSpkVolumeChanged(unsigned int MicVolume, unsigned int SpkVolume) = 0;

    virtual void OnNoAudioDeviceIsUseful(bool bMicOrSpk) = 0; 

    virtual void OnTestMicStatusChanged(SDK_TESTMIC_STATUS status,bool& bHandled) = 0; 

    virtual void OnSelectedAudioDeviceIsChanged() = 0;
};

class ITestAudioDeviceHelper
{
public:
    virtual SDKError SetEvent(ITestAudioDeviceHelperEvent* pEvent) = 0;

    virtual SDKError TestMicStartRecording(const zchar_t* deviceID = nullptr) = 0;

    virtual SDKError TestMicStopTesting() = 0;

    virtual SDKError TestMicPlayRecording() = 0;
    
    virtual SDKError TestSpeakerStartPlaying(const zchar_t* deviceID = nullptr) = 0;
    
    virtual SDKError TestSpeakerStopPlaying() = 0;
    
    virtual SDKError SetTimerInterval(unsigned int timerInterval) = 0;
};
#endif

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

class IGeneralSettingContext
{
public:
    virtual SDKError EnableAutoCopyInviteLink(bool bEnable) = 0;

    virtual bool IsAutoCopyInviteLinkEnabled() = 0;

    virtual SDKError EnableMuteWhenLockScreen(bool bEnable) = 0;

    virtual bool IsMuteWhenLockScreenEnabled() = 0;
#if defined(WIN32)
    virtual SDKError EnableDualScreenMode(bool bEnable) = 0;

    virtual bool IsDualScreenModeEnabled() = 0;

    virtual SDKError TurnOffAeroModeInSharing(bool bTurnoff) = 0;

    virtual bool IsAeroModeInSharingTurnOff() = 0;

    virtual SDKError EnableAutoFullScreenVideoWhenJoinMeeting(bool bEnable) = 0;

    virtual bool IsAutoFullScreenVideoWhenJoinMeetingEnabled() = 0;
    
    virtual SDKError EnableSplitScreenMode(bool bEnable) = 0;

    virtual bool IsSplitScreenModeEnabled() = 0;
    
    virtual SDKError EnableDisplayReminderWindowWhenExit(bool bEnable) = 0;
    
    virtual bool IsDisplayReminderWindowWhenExitEnabled() = 0;
    
    virtual SDKError EnableShowMyMeetingElapseTime(bool bEnable) = 0;
    
    virtual bool IsShowMyMeetingElapseTimeEnabled() = 0;

    virtual SDKError SetReactionSkinTone(ReactionSkinToneType skinTone) = 0;

    virtual ReactionSkinToneType GetReactionSkinTone() = 0;

    virtual bool IsSupportSetUITheme() = 0;

    virtual SDKError SetUITheme(ZoomSDKUITheme theme) = 0;

    virtual ZoomSDKUITheme GetUITheme() = 0;

    virtual bool IsSupportSetUIAppearance() = 0;

    virtual SDKError SetUIAppearance(ZoomSDKUIAppearance appearance) = 0;

    virtual ZoomSDKUIAppearance GetUIAppearance() = 0;
 
#endif
};
#if defined(WIN32)
typedef enum
{
    PREVIEW_VIDEO_ROTATION_ACTION_0,
    PREVIEW_VIDEO_ROTATION_ACTION_CLOCK90,
    PREVIEW_VIDEO_ROTATION_ACTION_CLOCK180,
    PREVIEW_VIDEO_ROTATION_ACTION_ANTI_CLOCK90
} PREVIEW_VIDEO_ROTATION_ACTION, *PPREVIEW_VIDEO_ROTATION_ACTION;

typedef enum
{
    VIDEO_HARDWARE_ENCODE_RECEIVING = 0,
    VIDEO_HARDWARE_ENCODE_SENDING,
    VIDEO_HARDWARE_ENCODE_PROCESSING,
}VIDEO_HARDWARE_ENCODE_TYPE;

class ITestVideoDeviceHelperEvent
{
public:
    virtual ~ITestVideoDeviceHelperEvent() {}

    virtual void OnNoVideoDeviceIsUseful() = 0;
    
    virtual void OnSelectedVideoDeviceIsChanged() = 0; 
    
    virtual void OnNoWindowToShowPreview() = 0;
};

class ITestVideoDeviceHelper
{
public:
    virtual SDKError SetEvent(ITestVideoDeviceHelperEvent* pEvent) = 0;
    
    virtual SDKError SetVideoPreviewParentWnd(HWND hParentWnd, RECT rc = _SDK_TEST_VIDEO_INIT_RECT) = 0;
    
    virtual SDKError TestVideoStartPreview(const zchar_t* deviceID = nullptr) = 0;
    
    virtual SDKError TestVideoStopPreview() = 0;
    
    virtual SDKError TestVideoRotate(PREVIEW_VIDEO_ROTATION_ACTION action) = 0; 
 
    virtual ICameraController* GetTestCameraController() = 0;
};

class ILipSyncAvatarPreviewHelperEvent
{
public:
    virtual ~ILipSyncAvatarPreviewHelperEvent() {}

    virtual void OnNoWindowToShowLipsyncPreview() = 0;
};

class ILipSyncAvatarPreviewHelper
{
public:
    virtual SDKError SetEvent(ILipSyncAvatarPreviewHelperEvent* pEvent) = 0;

    virtual SDKError SetLipSyncAvatarPreviewParentWnd(HWND hParentWnd, RECT rc = _SDK_TEST_VIDEO_INIT_RECT) = 0;

    virtual SDKError StartLipSyncAvatarPreview() = 0;

    virtual SDKError StopLipSyncAvatarPreview() = 0;
 
    virtual ~ILipSyncAvatarPreviewHelper() {};
};

class I3DAvatarImageInfo
{
public:
    virtual bool IsSelected() = 0;

    virtual bool IsLastUsed() = 0;

    virtual const zchar_t* GetImageFilePath() = 0;

    virtual const zchar_t* GetImageName() = 0;

    virtual int GetIndex() = 0;
 
    virtual ~I3DAvatarImageInfo() {};
};
 
#endif
typedef enum 
{
    Light_Adaption_None = 0,
    Light_Adaption_Auto,
    Light_Adaption_Manual,
}VIDEO_LIGHT_ADAPTION_TYPE;
 

class IVideoSettingContextEvent
{
public:
    virtual ~IVideoSettingContextEvent() {}

    virtual void onComputerCamDeviceChanged(IList<ICameraInfo*>* pNewCameraList) = 0;

    virtual void onDefaultCamDeviceChanged(const zchar_t* deviceId, const zchar_t* deviceName) = 0;
};

enum AutoFramingMode
{
    AutoFramingMode_none,
    AutoFramingMode_center_coordinates,
    AutoFramingMode_face_recognition,
};

enum FaceRecognitionFailStrategy
{
    FaceRecognitionFailStrategy_none,
    FaceRecognitionFailStrategy_remain,
    FaceRecognitionFailStrategy_using_center_coordinates,
    FaceRecognitionFailStrategy_using_original_video,
};

struct AutoFramingParameter
{
    float ratio;
    FaceRecognitionFailStrategy fail_Strategy;
 
    AutoFramingParameter()
    {
        ratio = 1;
        fail_Strategy = FaceRecognitionFailStrategy_using_original_video;
    }
};

class IVideoSettingContext
{
public:
    virtual IList<ICameraInfo* >* GetCameraList() = 0;

    virtual SDKError SelectCamera(const zchar_t* deviceId) = 0;

    virtual SDKError EnableFaceBeautyEffect(bool bEnable) = 0;

    virtual bool IsFaceBeautyEffectEnabled() = 0;

    virtual unsigned int GetFaceBeautyStrengthValue() = 0;

    virtual SDKError SetFaceBeautyStrengthValue(unsigned int beautyStrengthValue) = 0;

    virtual SDKError EnableLightAdaption(bool bEnable, VIDEO_LIGHT_ADAPTION_TYPE lightAdaptionType, double manualValue) = 0;

    virtual bool IsLightAdaptionEnabled() = 0;

    virtual VIDEO_LIGHT_ADAPTION_TYPE GetLightAdaptionType() = 0;

    virtual double GetLightAdaptionManualValue() = 0;

    virtual SDKError EnableHDVideo(bool bEnable) = 0;

    virtual bool IsHDVideoEnabled() = 0;

    virtual SDKError EnableAlwaysUseOriginalSizeVideo(bool bEnable) = 0;

    virtual bool IsAlwaysUseOriginalSizeVideo() = 0;

    virtual SDKError EnableTemporalDeNoise(bool bEnable) = 0;

    virtual bool IsTemporalDeNoiseEnabled() = 0;

    virtual SDKError EnableAlwaysShowNameOnVideo(bool bEnable) = 0;

    virtual bool IsAlwaysShowNameOnVideoEnabled() = 0;

    virtual SDKError EnableAutoTurnOffVideoWhenJoinMeeting(bool bEnable) = 0;

    virtual bool IsAutoTurnOffVideoWhenJoinMeetingEnabled() = 0;

    virtual SDKError SetVideoDeviceEvent(IVideoSettingContextEvent* pEvent) = 0;

    virtual SDKError EnableVideoAutoFraming(AutoFramingMode mode, AutoFramingParameter& param) = 0; 

    virtual bool IsVideoAutoFramingEnabled() = 0;

    virtual SDKError GetVideoAutoFramingMode(AutoFramingMode& mode) = 0;

    virtual SDKError SetVideoAutoFramingMode(AutoFramingMode mode) = 0;

    virtual SDKError SetVideoAutoFramingRatio(float ratio) = 0;

    virtual SDKError SetFaceRecognitionFailStrategy(FaceRecognitionFailStrategy strategy) = 0;

    virtual SDKError GetVideoAutoFramingSetting(AutoFramingMode mode, AutoFramingParameter& param) = 0;

    virtual SDKError DisableVideoAutoFraming() = 0;

    virtual SDKError EnableOptimizeVideoQuality(bool bEnable) = 0;

    virtual bool IsOptimizeVideoQualityEnabled() = 0;

    virtual bool IsOptimizeVideoQualitySupported() = 0;
#if defined(WIN32)
    virtual SDKError EnableVideoMirrorEffect(bool bEnable) = 0;

    virtual bool IsVideoMirrorEffectEnabled() = 0;

    virtual SDKError EnableSpotlightSelf(bool bEnable) = 0;

    virtual bool IsSpotlightSelfEnabled() = 0;

    virtual SDKError EnableHardwareEncode(bool bEnable, VIDEO_HARDWARE_ENCODE_TYPE encodeType) = 0;

    virtual bool IsHardwareEncodeEnabled(VIDEO_HARDWARE_ENCODE_TYPE encodeType) = 0;

    virtual SDKError Enable49VideoesInGallaryView(bool bEnable) = 0;

    virtual bool Is49VideoesInGallaryViewEnabled() = 0;
    
    virtual SDKError EnableHideNoVideoUsersOnWallView(bool bEnable) = 0;

    virtual bool IsHideNoVideoUsersOnWallViewEnabled() = 0;

    virtual SDKError EnableVideoPreviewDialog(bool bEnable) = 0;

    virtual bool IsVideoPreviewDialogEnabled() = 0;

    virtual SDKError EnableStopIncomingVideo(bool bEnable) = 0;

    virtual bool IsStopIncomingVideoEnabled() = 0;

    virtual SDKError EnableHideSelfView(bool bEnable) = 0;

    virtual SDKError IsHideSelfViewEnabled(bool& bEnabled) = 0;
    
    virtual ITestVideoDeviceHelper* GetTestVideoDeviceHelper() = 0;
#endif
};

class IAudioSettingContextEvent
{
public:
    virtual ~IAudioSettingContextEvent() {}

    virtual void onComputerMicDeviceChanged(IList<IMicInfo*>* pNewMicList) = 0;
    
    virtual void onComputerSpeakerDeviceChanged(IList<ISpeakerInfo*>* pNewSpeakerList) = 0;

    virtual void onDefaultMicDeviceChanged(const zchar_t* deviceId, const zchar_t* deviceName) = 0;

    virtual void onDefaultSpeakerDeviceChanged(const zchar_t* deviceId, const zchar_t* deviceName) = 0;
};

typedef enum
{
    SDK_AUDIO_DEVICE_RAW_MODE_DEFAULT,
    SDK_AUDIO_DEVICE_RAW_MODE_ON, 
    SDK_AUDIO_DEVICE_RAW_MODE_OFF 
}SDK_AUDIO_DEVICE_RAW_MODE_TYPE;

typedef enum {
    SDK_ECHO_CANCELLATION_DEFAULT = 0,
    SDK_ECHO_CANCELLATION_LOW,
    SDK_ECHO_CANCELLATION_HIGH
}SDK_ECHO_CANCELLATION_LEVEL;

class IAudioSettingContext
{
public:
    virtual IList<IMicInfo* >* GetMicList() = 0;

    virtual SDKError SelectMic(const zchar_t* deviceId, const zchar_t* deviceName) = 0;

    virtual IList<ISpeakerInfo* >* GetSpeakerList() = 0;

    virtual SDKError SelectSpeaker(const zchar_t* deviceId, const zchar_t* deviceName) = 0;

    virtual SDKError EnableAutoJoinAudio(bool bEnable) = 0;

    virtual bool IsAutoJoinAudioEnabled() = 0;

    virtual SDKError EnableAutoAdjustMic(bool bEnable) = 0;

    virtual bool IsAutoAdjustMicEnabled() = 0;

    virtual SDKError EnableAlwaysMuteMicWhenJoinVoip(bool bEnable) = 0;

    virtual bool IsAlwaysMuteMicWhenJoinVoipEnabled() = 0;

    virtual SDKError EnableSuppressAudioNotify(bool bEnable) = 0;

    virtual bool IsSuppressAudioNotifyEnabled() = 0;

    virtual SDKError    SetMicVol(FLOAT& value) = 0;
    
    virtual SDKError    GetMicVol(FLOAT& value) = 0;
    
    virtual SDKError    SetSpeakerVol(FLOAT& value) = 0;
    
    virtual SDKError    GetSpeakerVol(FLOAT& value) = 0;

    virtual SDKError SetAudioDeviceEvent(IAudioSettingContextEvent* pEvent) = 0;

    virtual SDK_ECHO_CANCELLATION_LEVEL GetEchoCancellationLevel() = 0;

    virtual SDKError SetEchoCancellationLevel(SDK_ECHO_CANCELLATION_LEVEL level) = 0;

    virtual Suppress_Background_Noise_Level GetSuppressBackgroundNoiseLevel() = 0;

    virtual SDKError SetSuppressBackgroundNoiseLevel(Suppress_Background_Noise_Level level) = 0;

    virtual SDK_AUDIO_DEVICE_RAW_MODE_TYPE GetAudioSignalProcessType() = 0;

    virtual SDKError SetAudioSignalProcessType(SDK_AUDIO_DEVICE_RAW_MODE_TYPE type) = 0;

    virtual SDKError DisableEchoCancellation(bool bDisable) = 0;

    virtual bool IsEchoCancellationDisabled() = 0;
 
    virtual IList<IRingSpeakerInfo* >* GetRingSpkList() = 0;
 
    virtual SDKError GetRingSpkVolume(FLOAT& fValue) = 0;
 
    virtual SDKError SetRingSpkVolume(FLOAT fValue) = 0;
 
    virtual SDKError SetRingSpkDevice(const zchar_t* spk_id) = 0;
 
    virtual SDKError UseDefaultSystemMic() = 0;
 
    virtual SDKError UseDefaultSystemSpeaker() = 0;

    virtual SDKError EnableMicOriginalInput(bool bEnable) = 0;
#if defined(WIN32)
    virtual SDKError EnableStereoAudio(bool bEnable) = 0;

    virtual bool IsStereoAudioEnable() = 0;

    virtual bool IsMicOriginalInputEnable() = 0;
    
    virtual SDKError EnableHoldSpaceKeyToSpeak(bool bEnable) = 0;

    virtual bool IsHoldSpaceKeyToSpeakEnabled() = 0;

    virtual ITestAudioDeviceHelper* GetTestAudioDeviceHelper() = 0;

    virtual SDKError EnableSyncButtonsOnHeadset(bool bEnable) = 0;

    virtual bool IsSyncButtonsOnHeadsetEnabled() = 0;

    virtual SDKError EnableHighFidelityMusicMode(bool bEnable) = 0;

    virtual bool IsHighFidelityMusicModeDisabled() = 0;
 
    virtual SDKError EnableAlwaysUseSeparateRingSpk(bool bEnable) = 0;
 
    virtual bool IsAlwaysUseSeparateRingSpk() = 0;
 
    virtual bool isSupportPromptJoinAudioDialogWhenUse3rdPartyAudio() = 0;
#endif
};

class IRecordingSettingContextEvent
{
public:
    virtual ~IRecordingSettingContextEvent() {}

    virtual void onCloudRecordingStorageInfo(INT64 storage_total_size, INT64 storage_used_size, bool allow_exceed_storage) = 0;
};

class IRecordingSettingContext
{
public:
    virtual SDKError SetRecordingPath(const zchar_t* szPath) = 0;

    virtual const zchar_t* GetRecordingPath() = 0;
    
    virtual SDKError SetRecordingSettingEvent(IRecordingSettingContextEvent* pEvent) = 0;
    
    virtual bool CanGetCloudRecordingStorageInfo() = 0;

    virtual SDKError GetCloudRecordingStorageInfo() = 0;

    virtual const zchar_t* GetRecordingManagementURL() = 0;
    
    virtual SDKError CanGetRecordingManagementURL(bool& bEnable) = 0;

    virtual SDKError EnableMultiAudioStreamRecord(bool bEnable) = 0;
    
    virtual bool IsMultiAudioStreamRecordEnabled() = 0;
    
    virtual SDKError EnableAddTimestampWatermark(bool bEnable) = 0;
    
    virtual bool IsAddTimestampWatermarkEnabled() = 0;
    
    virtual SDKError EnableOptimizeFor3rdPartyVideoEditor(bool bEnable) = 0;
    
    virtual bool IsOptimizeFor3rdPartyVideoEditorEnabled() = 0;
    
    virtual SDKError EnableShowVideoThumbnailWhenShare(bool bEnable) = 0;
    
    virtual bool IsShowVideoThumbnailWhenShareEnabled() = 0;
    
    virtual SDKError EnablePlaceVideoNextToShareInRecord(bool bEnable) = 0;
    
    virtual bool IsPlaceVideoNextToShareInRecordEnabled() = 0;
#if defined(WIN32)  
    virtual SDKError EnableSelectRecordFileLocationAfterMeeting(bool bEnable) = 0;
    
    virtual bool IsSelectRecordFileLocationAfterMeetingEnabled() = 0;
#endif
    
};

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

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

typedef struct tagOverallStatisticInfo
{
    SettingsNetWorkType net_work_type_;
    SettingConnectionType connection_type_;
    const zchar_t* proxy_addr_;
    tagOverallStatisticInfo()
    {
        net_work_type_ = SETTINGS_NETWORK_UNKNOWN;
        connection_type_ = SETTINGS_CONNECTION_TYPE_UNKNOWN;
        proxy_addr_ = nullptr;
    }
}OverallStatisticInfo;

typedef struct tagAudioSessionStatisticInfo
{
    int frequency_send_;
    int frequency_recv_;
    int latency_send_;
    int latency_recv_;
    int jitter_send_;
    int jitter_recv_;
    float packetloss_send_;
    float packetloss_recv_;
 
    tagAudioSessionStatisticInfo()
    {
        memset(this, 0, sizeof(tagAudioSessionStatisticInfo)); 
    }
}AudioSessionStatisticInfo;

typedef struct tagASVSessionStatisticInfo
{
    int latency_send_;
    int latency_recv_;
    int jitter_send_;
    int jitter_recv_;
    float packetloss_send_max_;
    float packetloss_recv_max_;
    float packetloss_send_avg_;
    float packetloss_recv_avg_;
    int resolution_send_;
    int resolution_recv_;
    int fps_send_;
    int fps_recv_;
    tagASVSessionStatisticInfo()
    {
        memset(this, 0, sizeof(tagASVSessionStatisticInfo));   
    }
}ASVSessionStatisticInfo;
 

class IStatisticSettingContext
{
public:
    virtual SDKError QueryOverallStatisticInfo(OverallStatisticInfo& info_) = 0;
 
};
 
typedef enum
{
    ZoomSDKWallpaperLayoutMode_None,
    ZoomSDKWallpaperLayoutMode_Fill,
    ZoomSDKWallpaperLayoutMode_Fit
}ZoomSDKWallpaperLayoutMode;
 
typedef enum
{
    ZoomSDKWallpaperSettingStatus_None,
    ZoomSDKWallpaperSettingStatus_Downloading,
    ZoomSDKWallpaperSettingStatus_Downloaded,
    ZoomSDKWallpaperSettingStatus_DownloadFail
}ZoomSDKWallpaperSettingStatus;

class IWallpaperItem
{
public:
    virtual ZoomSDKWallpaperLayoutMode GetWallpaperLayoutMode() = 0;

    virtual const zchar_t* GetWallpaperID() = 0;

    virtual const zchar_t* GetTitle() = 0;

    virtual const zchar_t* GetThumbnailPath() = 0;

    virtual const zchar_t* GetPath() = 0;

    virtual int GetTransparency() = 0;

    virtual void SetTransparency(int transparency) = 0;

    virtual void SetWallpaperLayoutMode(ZoomSDKWallpaperLayoutMode mode) = 0;
 
    virtual ~IWallpaperItem() {};
};

class IWallpaperSettingContextEvent
{
public:
    virtual void onMeetingWallpaperChanged(IWallpaperItem* item) = 0;

    virtual void onMeetingWallpaperImageDownloadStatus(ZoomSDKWallpaperSettingStatus status, const zchar_t* wallpaperId) = 0;
 
#if defined(WIN32)
    virtual void onPersonalWallpaperChanged(IWallpaperItem* item) = 0;

    virtual void onPersonalWallpaperImageDownloadStatus(ZoomSDKWallpaperSettingStatus status, const zchar_t* wallpaperId) = 0;
#endif
};

class IWallpaperSettingContext
{
public:
    virtual SDKError SetEvent(IWallpaperSettingContextEvent* pEvent) = 0;

    virtual bool IsMeetingWallpaperEnabled() = 0;

    virtual bool IsMeetingWallpaperThumbsReady() = 0;

    virtual IWallpaperItem* GetCurrentMeetingWallpaperItem() = 0;

    virtual IList<IWallpaperItem* >* GetMeetingWallpaperList() = 0;

    virtual SDKError SetMeetingWallpaper(IWallpaperItem* item) = 0;

    virtual IWallpaperItem* GetMeetingWallpaperItemByID(const zchar_t* wallpaperID) = 0;
 
#if defined(WIN32)  
    virtual bool IsPersonalWallpaperEnabled() = 0;

    virtual IWallpaperItem* GetCurrentPersonalWallpaperItem() = 0;

    virtual IList<IWallpaperItem* >* GetPersonalWallpaperList() = 0;

    virtual SDKError SetPersonalWallpaper(IWallpaperItem* item) = 0;

    virtual IWallpaperItem* GetPersonalWallpaperItemByID(const zchar_t* wallpaperID) = 0;
#endif
};
 
#if defined(WIN32)  
class IAccessibilitySettingContext
{
public:
    virtual SDKError EnableAlwaysShowMeetingControls(bool bEnable) = 0;

    virtual SDKError IsAlwaysShowMeetingControlsEnable(bool& bEnable) = 0;
};

class ISettingUIStrategy
{
public:
    virtual void DisableAdvancedFeatures4GeneralSetting(bool bDisable) = 0;

    virtual void ConfSettingDialogShownTabPage(SettingDlgShowTabPageOption showOption) = 0;

    virtual void HideAutoCopyInviteLinkCheckBox(bool bHide) = 0;

    virtual void ConfigToShowUrlLinksInSetting(SettingDlgShowUrlOption showOption) = 0;
};
class IVirtualBGImageInfo
{
public:
    virtual bool isSelected() = 0;

    virtual bool isAllowDelete() = 0;
    virtual const zchar_t* GetImageFilePath() = 0;

    virtual const zchar_t* GetImageName() = 0;
 
    virtual ~IVirtualBGImageInfo() {};
};
 
enum VBVideoError {
    VB_VideoError_None = 0,
    VB_VideoError_UnknownFormat,
    VB_VideoError_ResolutionHigh1080P,
    VB_VideoError_ResolutionHigh720P,
    VB_VideoError_ResolutionLow,
    VB_VideoError_PlayError,
    VB_VideoError_OpenError,
};

class IVirtualBGSettingContextEvent
{
public:
    virtual ~IVirtualBGSettingContextEvent() {}

    virtual void onVBImageDidDownloaded() = 0;
    
    virtual void onGreenVBDidUpdateWithReplaceColor(DWORD selectedColor) = 0;

    virtual void onSelectedVBImageChanged() = 0;

    virtual void OnVideoThumbReady(const zchar_t* file_path) = 0;

    virtual void OnVideoThumbError(const zchar_t* file_path, VBVideoError error) = 0;

    virtual void OnVideoPlayError(const zchar_t* file_path, VBVideoError error) = 0;
};

class IVirtualBGSettingContext
{
public:
    virtual SDKError SetVirtualBGEvent(IVirtualBGSettingContextEvent* pEvent) = 0;

    virtual bool IsSupportVirtualBG() = 0;

    virtual bool IsDeviceSupportSmartVirtualBG() = 0;

    virtual bool IsSupportVirtualBackgroundVideo() = 0;

    virtual bool IsDeviceSupportSmartVirtualBackgroundVideo() = 0;

    virtual bool IsDeviceSupportGreenVirtualBackgroundVideo() = 0;

    virtual bool IsUsingGreenScreenOn() = 0;

    virtual SDKError SetUsingGreenScreen(bool bUse) = 0;

    virtual bool IsAllowToAddNewVBItem() = 0;

    virtual SDKError AddBGImage(const zchar_t* file_path) = 0;

    virtual SDKError RemoveBGImage(IVirtualBGImageInfo* pRemoveImage) = 0;

    virtual IList<IVirtualBGImageInfo* >* GetBGImageList() = 0;

    virtual SDKError UseBGImage(IVirtualBGImageInfo* pImage) = 0;

    virtual DWORD GetBGReplaceColor() = 0;

    virtual SDKError BeginSelectReplaceVBColor() = 0;

    virtual SDKError AddBGVideo(const zchar_t* file_path) = 0;

    virtual SDKError RemoveBGVideo(IVirtualBGImageInfo* pRemoveVideo) = 0;

    virtual IList<IVirtualBGImageInfo* >* GetBGVideoList() = 0;

    virtual SDKError UseBGVideo(IVirtualBGImageInfo* pImage) = 0;

    virtual ITestVideoDeviceHelper* GetTestVideoDeviceHelper() = 0;
};
 
typedef enum
{
    ZoomSDKVideoEffectType_None = 0,
    ZoomSDKVideoEffectType_Filter = 1,
    ZoomSDKVideoEffectType_Frame = 2,
    ZoomSDKVideoEffectType_CustomFilter = 3,
    ZoomSDKVideoEffectType_Sticker = 4,
}ZoomSDKVideoEffectType;

class IVideoFilterImageInfo
{
public:
    virtual bool isSelected() = 0;

    virtual const zchar_t* GetImageFilePath() = 0;

    virtual const zchar_t* GetImageName() = 0;

    virtual ZoomSDKVideoEffectType GetType() = 0;

    virtual int GetIndex() = 0;
 
    virtual ~IVideoFilterImageInfo() {};
};

class IVideoFilterSettingContextEvent
{
public:
    virtual void onVideoFilterItemThumnailsDownloaded() = 0;

    virtual void onVideoFilterItemDataDownloading(ZoomSDKVideoEffectType type, int index) = 0;

    virtual void onVideoFilterItemDataDownloaded(bool bSuccess, ZoomSDKVideoEffectType type, int index) = 0;
};

class IVideoFilterSettingContext
{
public:
    virtual SDKError SetVideoFilterEvent(IVideoFilterSettingContextEvent* pEvent) = 0;
 

    virtual bool IsSupportVideoFilter() = 0;

    virtual bool IsVideoFilterEnabled() = 0;

    virtual bool IsVideoFilterLocked() = 0;

    virtual IList<IVideoFilterImageInfo* >* GetVideoFilterImageList() = 0;

    virtual SDKError UseVideoFilterImage(IVideoFilterImageInfo* pImage) = 0;

    virtual ITestVideoDeviceHelper* GetTestVideoDeviceHelper() = 0;
};
 
typedef enum
{
    ZoomSDKCustom3DAvatarElementImageType_None,
    ZoomSDKCustom3DAvatarElementImageType_Skin,
    ZoomSDKCustom3DAvatarElementImageType_Face,
    ZoomSDKCustom3DAvatarElementImageType_Hair,
    ZoomSDKCustom3DAvatarElementImageType_Eyes,
    ZoomSDKCustom3DAvatarElementImageType_EyeColor,
    ZoomSDKCustom3DAvatarElementImageType_Eyelashes,
    ZoomSDKCustom3DAvatarElementImageType_Eyebrows,
    ZoomSDKCustom3DAvatarElementImageType_Nose,
    ZoomSDKCustom3DAvatarElementImageType_Mouth,
    ZoomSDKCustom3DAvatarElementImageType_LipColor,
    ZoomSDKCustom3DAvatarElementImageType_Age,
    ZoomSDKCustom3DAvatarElementImageType_FacialHair,
    ZoomSDKCustom3DAvatarElementImageType_Body,
    ZoomSDKCustom3DAvatarElementImageType_Clothing,
    ZoomSDKCustom3DAvatarElementImageType_HeadCovering,
    ZoomSDKCustom3DAvatarElementImageType_Glasses,
}ZoomSDKCustom3DAvatarElementImageType;
 
typedef enum
{
    ZoomSDKCustom3DAvatarElementColorType_None,
    ZoomSDKCustom3DAvatarElementColorType_Eyebrow,
    ZoomSDKCustom3DAvatarElementColorType_Mustache,
    ZoomSDKCustom3DAvatarElementColorType_Hair,
    ZoomSDKCustom3DAvatarElementColorType_Eyelash,
}ZoomSDKCustom3DAvatarElementColorType;

class ICustom3DAvatarElementImageInfo
{
public:
    virtual ZoomSDKCustom3DAvatarElementImageType GetCustom3DAvatarElementImageType() = 0;

    virtual bool IsSelected() = 0;

    virtual const zchar_t* GetImageFilePath() = 0;

    virtual const zchar_t* GetImageName() = 0;
 
    virtual ~ICustom3DAvatarElementImageInfo() {};
};

class ICustom3DAvatarElementColorInfo
{
public:
    virtual ZoomSDKCustom3DAvatarElementColorType GetCustom3DAvatarElementColorType() = 0;
 

    virtual unsigned long GetColor() = 0;

    virtual bool IsSelected() = 0;

    virtual const zchar_t* GetImageName() = 0;
 
    virtual ~ICustom3DAvatarElementColorInfo() {};
};

class ICustom3DAvatarElementSettingContextEvent
{
public:
    virtual ~ICustom3DAvatarElementSettingContextEvent() {}

    virtual void onCustom3DAvatarElementImageModelDataDownloaded(bool bSuccess, ICustom3DAvatarElementImageInfo* pImageInfo) = 0;
};

class ICustom3DAvatarElementSettingContext
{
public:
    virtual ~ICustom3DAvatarElementSettingContext() {}
    virtual SDKError SetEvent(ICustom3DAvatarElementSettingContextEvent* pEvent) = 0;
    virtual IList<ICustom3DAvatarElementImageInfo* >* GetCustom3DAvatarElementImageList() = 0;
    virtual bool IsCustom3DAvatarElementImageModelDataReady(ICustom3DAvatarElementImageInfo* pImageInfo) = 0;
    virtual SDKError DownloadCustom3dAvatarElementImageModelData(ICustom3DAvatarElementImageInfo* pImageInfo) = 0;
    virtual SDKError SetCustom3DAvatarElementImage(ICustom3DAvatarElementImageInfo* pImageInfo) = 0;
    virtual IList<ICustom3DAvatarElementColorInfo* >* GetCustom3DAvatarElementColorList() = 0;
    virtual SDKError SetCustom3DAvatarElementColor(ICustom3DAvatarElementColorInfo* pColorInfo) = 0;
};
 

class I3DAvatarSettingContextEvent
{
public:
    virtual ~I3DAvatarSettingContextEvent() {}

    virtual void on3DAvatarItemThumbnailsDownloaded() = 0;

    virtual void on3DAvatarItemDataDownloading(int index) = 0;

    virtual void on3DAvatarItemDataDownloaded(bool bSuccess, int index) = 0;

    virtual void onCustom3DAvatarImageModelDataDownloaded(bool bSuccess, I3DAvatarImageInfo* pImageInfo) = 0;

    virtual void onCustom3DAvatarDefaultImageModelDataDownloaded(bool bSuccess) = 0;
};

class I3DAvatarSettingContext
{
public:
    virtual ~I3DAvatarSettingContext() {}
    virtual SDKError SetEvent(I3DAvatarSettingContextEvent* pEvent) = 0;

    virtual bool Is3DAvatarSupportedByDevice() = 0;

    virtual bool Is3DAvatarEnabled() = 0;

    virtual bool IsCustom3DAvatarEnabled() = 0;

    virtual SDKError Enable3DAvatarEffectForAllMeeting(bool bEnable) = 0;

    virtual bool Is3DAvatarEffectForAllMeetingEnabled() = 0;

    virtual IList<I3DAvatarImageInfo* >* Get3DAvatarImageList() = 0;

    virtual SDKError Set3DAvatarImage(I3DAvatarImageInfo* pImage) = 0;

    virtual IList<I3DAvatarImageInfo* >* GetCustom3DAvatarImageList() = 0;

    virtual bool IsCustom3DAvatarImageModelDataReady(I3DAvatarImageInfo* pImageInfo) = 0;

    virtual SDKError DownloadCustom3DAvatarImageModelData(I3DAvatarImageInfo* pImageInfo) = 0;
    
    virtual SDKError SetCustom3DAvatarImage(I3DAvatarImageInfo* pImageInfo) = 0;

    virtual bool IsCustom3DAvatarDefaultImageModelDataReady() = 0;

    virtual SDKError DownloadCustom3DAvatarDefaultImageModelData() = 0;

    virtual ICustom3DAvatarElementSettingContext* StartCreateCustom3DAvatar(HWND hPreviewWnd, RECT rc) = 0;

    virtual SDKError FinishCreateCustom3DAvatar(bool bSave) = 0;

    virtual ICustom3DAvatarElementSettingContext* StartEditCustom3DAvatar(HWND hPreviewWnd, RECT rc, I3DAvatarImageInfo* pImage) = 0;
    
    virtual SDKError FinishEditCustom3DAvatar(bool bSave) = 0;

    virtual SDKError DuplicateCustom3DAvatarImage(I3DAvatarImageInfo* pImage) = 0;

    virtual SDKError DeleteCustom3DAvatarImage(I3DAvatarImageInfo* pImage) = 0;

    virtual ITestVideoDeviceHelper* GetTestVideoDeviceHelper() = 0;

    virtual ILipSyncAvatarPreviewHelper* GetLipSyncAvatarPreviewHelper() = 0;
};
 
typedef enum
{
    ZoomSDKFaceMakeupType_Mustache,
    ZoomSDKFaceMakeupType_Eyebrow,
    ZoomSDKFaceMakeupType_Lip
}ZoomSDKFaceMakeupType;

class IFaceMakeupImageInfo
{
public:
    virtual ZoomSDKFaceMakeupType GetFaceMakeupType() = 0;

    virtual bool IsSelected() = 0;

    virtual const zchar_t* GetImageFilePath() = 0;

    virtual const zchar_t* GetImageName() = 0;

    virtual int GetIndex() = 0;
 
    virtual ~IFaceMakeupImageInfo() {};
};

class IFaceMakeupSettingContextEvent
{
public:
    virtual ~IFaceMakeupSettingContextEvent() {}

    virtual void onFaceMakeupItemThumbnailsDownloaded(ZoomSDKFaceMakeupType type) = 0;

    virtual void onFaceMakeupItemDataDownloading(ZoomSDKFaceMakeupType type, int index) = 0;

    virtual void onFaceMakeupItemDataDownloaded(bool bSuccess, ZoomSDKFaceMakeupType type, int index) = 0;
};

class IFaceMakeupSettingContext
{
public:
    virtual SDKError SetEvent(IFaceMakeupSettingContextEvent* pEvent) = 0;

    virtual bool IsFaceMakeupEnabled() = 0;

    virtual bool IsSupportFaceMakeup() = 0;

    virtual SDKError EnableFaceMakeupEffectForAllMeeting(bool bEnable) = 0;

    virtual bool IsFaceMakeupEffectForAllMeetingEnabled() = 0;

    virtual IList<IFaceMakeupImageInfo* >* GetFaceMakeupImageList() = 0;

    virtual SDKError SetFaceMakeupImage(IFaceMakeupImageInfo* pImage) = 0;

    virtual SDKError SetLipsFaceMakeup(bool bEnable) = 0;

    virtual SDKError SetColor(ZoomSDKFaceMakeupType type, unsigned long color) = 0;

    virtual SDKError SetOpactity(ZoomSDKFaceMakeupType type, unsigned int opactity) = 0;

    virtual SDKError ResetAllFaceMakeupEffect() = 0;

    virtual ITestVideoDeviceHelper* GetTestVideoDeviceHelper() = 0;
};
#endif 

class IShareSettingContext
{
public:

    virtual SDKError EnableAutoFitToWindowWhenViewSharing(bool bEnable) = 0;

    virtual bool IsAutoFitToWindowWhenViewSharingEnabled() = 0;

    virtual SDKError EnableTCPConnectionWhenSharing(bool bEnable) = 0;

    virtual bool IsTCPConnectionWhenSharing() = 0;

    virtual bool IsCurrentOSSupportAccelerateGPUWhenShare() = 0;

    virtual SDKError EnableAccelerateGPUWhenShare(bool bEnable) = 0;

    virtual SDKError IsAccelerateGPUWhenShareEnabled(bool& bEnable) = 0;

    virtual SDKError EnableGreenBorderWhenShare(bool bEnable) = 0;

    virtual bool IsGreenBorderEnabledWhenShare() = 0;

    virtual bool IsLimitFPSEnabledWhenShare() = 0;

    virtual SDKError EnableLimitFPSWhenShare(bool bEnable) = 0;

    virtual LimitFPSValue GetLimitFPSValueWhenShare() = 0;

    virtual SDKError SetLimitFPSValueWhenShare(LimitFPSValue value) = 0;

    virtual SDKError EnableShowMyAppWindowWhenShare(bool bEnable) = 0;

    virtual bool IsShowMyAppWindowWhenShareEnabled() = 0;

    virtual bool IsSupportShowMyAppWindowWhenShare() = 0;
 

    virtual bool IsDoNotDisturbInSharingOn() = 0;

    virtual SDKError EnableDoNotDisturbInSharing(bool bEnable) = 0;

    virtual SDKError EnableHardwareAcceleratedAnnotation(bool bEnable) = 0;

    virtual SDKError IsAnnotationHardwareAccelerated(bool& bEnable) = 0;

    virtual SDKError EnableHardwareAcceleratedVideoSharing(bool bEnable) = 0;

    virtual SDKError IsVideoSharingHardwareAccelerated(bool& bEnable) = 0;

    virtual SDKError EnableShareContentFlashDetection(bool bEnable) = 0;
    virtual bool IsShareContentFlashDetectionEnabled() = 0;
#if defined(WIN32)
    virtual SDKError SetWindowSizeTypeWhenViewShare(WindowSizeType eType) = 0;

    virtual WindowSizeType GetWindowSizeTypeWhenViewShare() = 0;

    virtual SDKError EnableRemoteControlAllApplications(bool bEnable) = 0;

    virtual bool IsRemoteControlAllApplicationsEnabled() = 0;

    virtual SDKError GetShareOptionWhenShareInMeeting(ShareOptionInMeeting& shareOption) = 0;

    virtual SDKError SetShareOptionWhenShareInMeeting(ShareOptionInMeeting shareOption) = 0;

    virtual SDKError GetShareOptionWhenShareApplication(ShareSelectMode& select_mode) = 0;

    virtual SDKError SetShareOptionWhenShareApplication(ShareSelectMode select_mode) = 0;

    virtual SDKError GetShareOptionWhenShareInDirectShare(ShareOptionToRoom& share_option) = 0;

    virtual SDKError SetShareOptionWhenShareInDirectShare(ShareOptionToRoom share_option) = 0;

    virtual SDKError SetScreenCaptureMode(ScreenCaptureMode capture_mode) = 0;

    virtual SDKError GetScreenCaptureMode(ScreenCaptureMode& capture_mode) = 0;
#endif
};

class ISettingService
{
public:

    virtual IGeneralSettingContext* GetGeneralSettings() = 0;

    virtual IAudioSettingContext* GetAudioSettings() = 0;

    virtual IVideoSettingContext* GetVideoSettings() = 0;

    virtual IRecordingSettingContext* GetRecordingSettings() = 0;

    virtual IStatisticSettingContext* GetStatisticSettings() = 0;

    virtual IShareSettingContext* GetShareSettings() = 0;
 
#if defined(WIN32)
    virtual SDKError ShowSettingDlg(ShowSettingDlgParam& param) = 0;

    virtual SDKError HideSettingDlg() = 0;

    virtual IAccessibilitySettingContext* GetAccessibilitySettings() = 0;

    virtual ISettingUIStrategy* GetSettingUIStrategy() = 0;

    virtual IVirtualBGSettingContext* GetVirtualBGSettings() = 0;

    virtual IVideoFilterSettingContext* GetVideoFilterSettings() = 0;

    virtual I3DAvatarSettingContext* Get3DAvatarSettings() = 0;

    virtual IFaceMakeupSettingContext* GetFaceMakeupSettings() = 0;
#endif

    virtual IWallpaperSettingContext* GetWallpaperSettings() = 0;
 
};
END_ZOOM_SDK_NAMESPACE
#endif