Share setting interface. More...

#include <setting_service_interface.h>

Public Member Functions
virtual SDKError	EnableAutoFitToWindowWhenViewSharing (bool bEnable)=0
	Enable or disable to auto-fit the ZOOM window when viewing the shared content.

virtual bool	IsAutoFitToWindowWhenViewSharingEnabled ()=0
	Determine if it is able to auto-fit the ZOOM window when viewing the shared content.

virtual SDKError	EnableTCPConnectionWhenSharing (bool bEnable)=0
	Enable or disable TCP connecting when sharing.

virtual bool	IsTCPConnectionWhenSharing ()=0
	Determine if it is enable use TCP connection when sharing.

virtual bool	IsCurrentOSSupportAccelerateGPUWhenShare ()=0
	Determine if the operating system supports the GPU acceleration when user shares.

virtual SDKError	EnableAccelerateGPUWhenShare (bool bEnable)=0
	Enable/Disable the GPU acceleration when user shares.

virtual SDKError	IsAccelerateGPUWhenShareEnabled (bool &bEnable)=0
	Determine if GPU acceleration is enabled when user shares.

virtual SDKError	EnableGreenBorderWhenShare (bool bEnable)=0
	Set the visibility of the green border when sharing the application.

virtual bool	IsGreenBorderEnabledWhenShare ()=0
	Determine if the green border is enabled when user shares.

virtual bool	IsLimitFPSEnabledWhenShare ()=0
	Determine if the 'limited sharing fps' feature is enabled when user shares.

virtual SDKError	EnableLimitFPSWhenShare (bool bEnable)=0
	Enable/disable the 'limited sharing fps' feature when uses shares.

virtual LimitFPSValue	GetLimitFPSValueWhenShare ()=0
	Get the limited sharing fps value when the 'limited sharing fps' feature is enabled.

virtual SDKError	SetLimitFPSValueWhenShare (LimitFPSValue value)=0
	Set the limited sharing fps value when the 'limited sharing fps' feature is enabled.

virtual SDKError	EnableShowMyAppWindowWhenShare (bool bEnable)=0
	Enable/Disable to show the userself's app window when shares.

virtual bool	IsShowMyAppWindowWhenShareEnabled ()=0
	Determine if it is enable to show the userself's app window when shares.

virtual bool	IsSupportShowMyAppWindowWhenShare ()=0
	Determine if the feature that showing the userself's app window when shares is supported.

virtual bool	IsDoNotDisturbInSharingOn ()=0
	Determine if it is silence system notification when sharing on.

virtual SDKError	EnableDoNotDisturbInSharing (bool bEnable)=0
	Enable/Disable to silence system notification when sharing on.

virtual SDKError	EnableHardwareAcceleratedAnnotation (bool bEnable)=0
	Enable/Disable the GPU acceleration when a user adds annotations on a shared screen or whiteboard.

virtual SDKError	IsAnnotationHardwareAccelerated (bool &bEnable)=0
	Determine if GPU acceleration is enabled when user use annotations on a shared screen or whiteboard.

virtual SDKError	EnableHardwareAcceleratedVideoSharing (bool bEnable)=0
	Enable/Disable the GPU acceleration when user shares video.

virtual SDKError	IsVideoSharingHardwareAccelerated (bool &bEnable)=0
	Determine if GPU acceleration is enabled when a user shares video.

virtual SDKError	SetWindowSizeTypeWhenViewShare (WindowSizeType eType)=0
	Set the window size type when viewing the sharing.

virtual WindowSizeType	GetWindowSizeTypeWhenViewShare ()=0
	Get the window size type when view share.

virtual SDKError	EnableRemoteControlAllApplications (bool bEnable)=0
	Enable/disable remote control of all applications.

virtual bool	IsRemoteControlAllApplicationsEnabled ()=0
	Determine if remote control of all applications is enabled.

virtual SDKError	GetShareOptionWhenShareInMeeting (ShareOptionInMeeting &shareOption)=0
	Get the share option in meeting.

virtual SDKError	SetShareOptionWhenShareInMeeting (ShareOptionInMeeting shareOption)=0
	Set the share option in meeting.

virtual SDKError	GetShareOptionWhenShareApplication (ShareSelectMode &select_mode)=0
	Get the share select mode.

virtual SDKError	SetShareOptionWhenShareApplication (ShareSelectMode select_mode)=0
	Set the share select mode.

virtual SDKError	GetShareOptionWhenShareInDirectShare (ShareOptionToRoom &share_option)=0
	Get the share option to room.

virtual SDKError	SetShareOptionWhenShareInDirectShare (ShareOptionToRoom share_option)=0
	Get the share option to room.

virtual SDKError	SetScreenCaptureMode (ScreenCaptureMode capture_mode)=0
	set the screen capture mode.

virtual SDKError	GetScreenCaptureMode (ScreenCaptureMode &capture_mode)=0
	Get the screen capture mode.

Detailed Description

Share setting interface.

Definition at line 2829 of file setting_service_interface.h.

Member Function Documentation

◆ EnableAccelerateGPUWhenShare()

virtual SDKError IShareSettingContext::EnableAccelerateGPUWhenShare ( bool bEnable )

pure virtual

Enable/Disable the GPU acceleration when user shares.

Parameters

bEnable true means to enable the acceleration. FALSE not.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.

◆ EnableAutoFitToWindowWhenViewSharing()

virtual SDKError IShareSettingContext::EnableAutoFitToWindowWhenViewSharing ( bool bEnable )

pure virtual

Enable or disable to auto-fit the ZOOM window when viewing the shared content.

Parameters

bEnable true means to resize automatically.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.

◆ EnableDoNotDisturbInSharing()

virtual SDKError IShareSettingContext::EnableDoNotDisturbInSharing ( bool bEnable )

pure virtual

Enable/Disable to silence system notification when sharing on.

Parameters

bEnable true means to silence system notification when sharing on. FALSE not.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.

◆ EnableGreenBorderWhenShare()

virtual SDKError IShareSettingContext::EnableGreenBorderWhenShare ( bool bEnable )

pure virtual

Set the visibility of the green border when sharing the application.

Parameters

bShow true means to display the frame. FALSE hide.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.

◆ EnableHardwareAcceleratedAnnotation()

virtual SDKError IShareSettingContext::EnableHardwareAcceleratedAnnotation ( bool bEnable )

pure virtual

Enable/Disable the GPU acceleration when a user adds annotations on a shared screen or whiteboard.

Parameters

bEnable true means to enable acceleration.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.

◆ EnableHardwareAcceleratedVideoSharing()

virtual SDKError IShareSettingContext::EnableHardwareAcceleratedVideoSharing ( bool bEnable )

pure virtual

Enable/Disable the GPU acceleration when user shares video.

Parameters

bEnable true means to enable the acceleration.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.

◆ EnableLimitFPSWhenShare()

virtual SDKError IShareSettingContext::EnableLimitFPSWhenShare ( bool bEnable )

pure virtual

Enable/disable the 'limited sharing fps' feature when uses shares.

Parameters

bEnable true means to enable the litmited fps feature. FALSE hide.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.

◆ EnableRemoteControlAllApplications()

virtual SDKError IShareSettingContext::EnableRemoteControlAllApplications ( bool bEnable )

pure virtual

Enable/disable remote control of all applications.

Parameters

bEnable true means to enable the remote control. FALSE not.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.

◆ EnableShowMyAppWindowWhenShare()

virtual SDKError IShareSettingContext::EnableShowMyAppWindowWhenShare ( bool bEnable )

pure virtual

Enable/Disable to show the userself's app window when shares.

Parameters

bEnable true means to enable to show the window. FALSE not.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.

◆ EnableTCPConnectionWhenSharing()

virtual SDKError IShareSettingContext::EnableTCPConnectionWhenSharing ( bool bEnable )

pure virtual

Enable or disable TCP connecting when sharing.

Parameters

bEnable true means to use TCP connecting when sharing.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.

◆ GetLimitFPSValueWhenShare()

virtual LimitFPSValue IShareSettingContext::GetLimitFPSValueWhenShare ( )

pure virtual

Get the limited sharing fps value when the 'limited sharing fps' feature is enabled.

◆ GetScreenCaptureMode()

virtual SDKError IShareSettingContext::GetScreenCaptureMode ( ScreenCaptureMode & capture_mode )

pure virtual

Get the screen capture mode.

Parameters

[out] capture_mode Specifies the screen capture mode.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.

◆ GetShareOptionWhenShareApplication()

virtual SDKError IShareSettingContext::GetShareOptionWhenShareApplication ( ShareSelectMode & select_mode )

pure virtual

Get the share select mode.

Parameters

[out] select_mode Specifies the share select mode.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.

◆ GetShareOptionWhenShareInDirectShare()

virtual SDKError IShareSettingContext::GetShareOptionWhenShareInDirectShare ( ShareOptionToRoom & share_option )

pure virtual

Get the share option to room.

Parameters

[out] share_option Specifies the share option to room.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.

◆ GetShareOptionWhenShareInMeeting()

virtual SDKError IShareSettingContext::GetShareOptionWhenShareInMeeting ( ShareOptionInMeeting & shareOption )

pure virtual

Get the share option in meeting.

Parameters

[out] shareOption Specifies the share option in meeting.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.

◆ GetWindowSizeTypeWhenViewShare()

virtual WindowSizeType IShareSettingContext::GetWindowSizeTypeWhenViewShare ( )

pure virtual

Get the window size type when view share.

◆ IsAccelerateGPUWhenShareEnabled()

virtual SDKError IShareSettingContext::IsAccelerateGPUWhenShareEnabled ( bool & bEnable )

pure virtual

Determine if GPU acceleration is enabled when user shares.

Parameters

[out]

true means the GPU acceleration is enabled. FALSE not. It validates only when the return value is SDKERR_SUCCESS.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.

◆ IsAnnotationHardwareAccelerated()

virtual SDKError IShareSettingContext::IsAnnotationHardwareAccelerated ( bool & bEnable )

pure virtual

Determine if GPU acceleration is enabled when user use annotations on a shared screen or whiteboard.

Parameters

[out]

true means the GPU acceleration is enabled. It validates only when the return value is SDKERR_SUCCESS.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.

◆ IsAutoFitToWindowWhenViewSharingEnabled()

virtual bool IShareSettingContext::IsAutoFitToWindowWhenViewSharingEnabled ( )

pure virtual

Determine if it is able to auto-fit the ZOOM window when viewing the shared content.

Returns: true means to resize automatically.

◆ IsCurrentOSSupportAccelerateGPUWhenShare()

virtual bool IShareSettingContext::IsCurrentOSSupportAccelerateGPUWhenShare ( )

pure virtual

Determine if the operating system supports the GPU acceleration when user shares.

Returns: true means support.

◆ IsDoNotDisturbInSharingOn()

virtual bool IShareSettingContext::IsDoNotDisturbInSharingOn ( )

pure virtual

Determine if it is silence system notification when sharing on.

Returns: true means to silence system notification when sharing on.

◆ IsGreenBorderEnabledWhenShare()

virtual bool IShareSettingContext::IsGreenBorderEnabledWhenShare ( )

pure virtual

Determine if the green border is enabled when user shares.

Returns: true means support. FALSE not.

◆ IsLimitFPSEnabledWhenShare()

virtual bool IShareSettingContext::IsLimitFPSEnabledWhenShare ( )

pure virtual

Determine if the 'limited sharing fps' feature is enabled when user shares.

Returns: true means support.

◆ IsRemoteControlAllApplicationsEnabled()

virtual bool IShareSettingContext::IsRemoteControlAllApplicationsEnabled ( )

pure virtual

Determine if remote control of all applications is enabled.

Returns: true means enabled.

◆ IsShowMyAppWindowWhenShareEnabled()

virtual bool IShareSettingContext::IsShowMyAppWindowWhenShareEnabled ( )

pure virtual

Determine if it is enable to show the userself's app window when shares.

Returns: true indicates to show the userself's app window when shares.

◆ IsSupportShowMyAppWindowWhenShare()

virtual bool IShareSettingContext::IsSupportShowMyAppWindowWhenShare ( )

pure virtual

Determine if the feature that showing the userself's app window when shares is supported.

Returns: true indicates to support.

◆ IsTCPConnectionWhenSharing()

virtual bool IShareSettingContext::IsTCPConnectionWhenSharing ( )

pure virtual

Determine if it is enable use TCP connection when sharing.

Returns: true means to enter the full screen video mode.

◆ IsVideoSharingHardwareAccelerated()

virtual SDKError IShareSettingContext::IsVideoSharingHardwareAccelerated ( bool & bEnable )

pure virtual

Determine if GPU acceleration is enabled when a user shares video.

Parameters

[out]

true means the GPU acceleration is enabled. FALSE indicates the GPU acceleration is not. It validates only when the return value is SDKERR_SUCCESS.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.

◆ SetLimitFPSValueWhenShare()

virtual SDKError IShareSettingContext::SetLimitFPSValueWhenShare ( LimitFPSValue value )

pure virtual

Set the limited sharing fps value when the 'limited sharing fps' feature is enabled.

Parameters

value Specifies the limited fps value. It validates only when the 'limited sharing fps' feature is enabled.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.

◆ SetScreenCaptureMode()

virtual SDKError IShareSettingContext::SetScreenCaptureMode ( ScreenCaptureMode capture_mode )

pure virtual

set the screen capture mode.

Parameters

capture_mode Specifies the screen capture mode.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.

◆ SetShareOptionWhenShareApplication()

virtual SDKError IShareSettingContext::SetShareOptionWhenShareApplication ( ShareSelectMode select_mode )

pure virtual

Set the share select mode.

Parameters

select_mode Specifies the share select mode.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.

◆ SetShareOptionWhenShareInDirectShare()

virtual SDKError IShareSettingContext::SetShareOptionWhenShareInDirectShare ( ShareOptionToRoom share_option )

pure virtual

Get the share option to room.

Parameters

share_option Specifies the share option to room.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.

◆ SetShareOptionWhenShareInMeeting()

virtual SDKError IShareSettingContext::SetShareOptionWhenShareInMeeting ( ShareOptionInMeeting shareOption )

pure virtual

Set the share option in meeting.

Parameters

shareOption Specifies the share option in meeting.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.

◆ SetWindowSizeTypeWhenViewShare()

virtual SDKError IShareSettingContext::SetWindowSizeTypeWhenViewShare ( WindowSizeType eType )

pure virtual

Set the window size type when viewing the sharing.

Parameters

eType Specifies the window size type.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.

Public Member Functions

Detailed Description

Member Function Documentation

◆ EnableAccelerateGPUWhenShare()

◆ EnableAutoFitToWindowWhenViewSharing()

◆ EnableDoNotDisturbInSharing()

◆ EnableGreenBorderWhenShare()

◆ EnableHardwareAcceleratedAnnotation()

◆ EnableHardwareAcceleratedVideoSharing()

◆ EnableLimitFPSWhenShare()

◆ EnableRemoteControlAllApplications()

◆ EnableShowMyAppWindowWhenShare()

◆ EnableTCPConnectionWhenSharing()

◆ GetLimitFPSValueWhenShare()

◆ GetScreenCaptureMode()

◆ GetShareOptionWhenShareApplication()

◆ GetShareOptionWhenShareInDirectShare()

◆ GetShareOptionWhenShareInMeeting()

◆ GetWindowSizeTypeWhenViewShare()

◆ IsAccelerateGPUWhenShareEnabled()

◆ IsAnnotationHardwareAccelerated()

◆ IsAutoFitToWindowWhenViewSharingEnabled()

◆ IsCurrentOSSupportAccelerateGPUWhenShare()

◆ IsDoNotDisturbInSharingOn()

◆ IsGreenBorderEnabledWhenShare()

◆ IsLimitFPSEnabledWhenShare()

◆ IsRemoteControlAllApplicationsEnabled()

◆ IsShowMyAppWindowWhenShareEnabled()

◆ IsSupportShowMyAppWindowWhenShare()

◆ IsTCPConnectionWhenSharing()

◆ IsVideoSharingHardwareAccelerated()

◆ SetLimitFPSValueWhenShare()

◆ SetScreenCaptureMode()

◆ SetShareOptionWhenShareApplication()

◆ SetShareOptionWhenShareInDirectShare()

◆ SetShareOptionWhenShareInMeeting()

◆ SetWindowSizeTypeWhenViewShare()