Meeting SDK for Windows API Reference
All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
IVideoSettingContext Class Referenceabstract

Video setting interface. More...

#include <setting_service_interface.h>

Public Member Functions

virtual IList< ICameraInfo * > * GetCameraList ()=0
 Get camera device list.
 
virtual SDKError SelectCamera (const zchar_t *deviceId)=0
 Select camera device.
 
virtual SDKError EnableFaceBeautyEffect (bool bEnable)=0
 Enable or disable the video facial beauty effect.
 
virtual bool IsFaceBeautyEffectEnabled ()=0
 Get the flag to enable/disable the video facial beauty effect.
 
virtual unsigned int GetFaceBeautyStrengthValue ()=0
 Get the video facial beauty strength value.
 
virtual SDKError SetFaceBeautyStrengthValue (unsigned int beautyStrengthValue)=0
 Set the video facial beauty strength value.
 
virtual SDKError EnableLightAdaption (bool bEnable, VIDEO_LIGHT_ADAPTION_TYPE lightAdaptionType, double manualValue)=0
 Enable or disable the light adaption of the video.
 
virtual bool IsLightAdaptionEnabled ()=0
 Get the flag to enable/disable the light adaption of the video.
 
virtual VIDEO_LIGHT_ADAPTION_TYPE GetLightAdaptionType ()=0
 Get the light adaption type of the video.
 
virtual double GetLightAdaptionManualValue ()=0
 Get the manual setting value for the light adaption of the video.
 
virtual SDKError EnableHDVideo (bool bEnable)=0
 Enable or disable HD video.
 
virtual bool IsHDVideoEnabled ()=0
 Get the flag to enable/disable the HD video.
 
virtual SDKError EnableAlwaysUseOriginalSizeVideo (bool bEnable)=0
 Enable or disable always use original size video.
 
virtual bool IsAlwaysUseOriginalSizeVideo ()=0
 Get the flag to enable/disable always use original size video.
 
virtual SDKError EnableTemporalDeNoise (bool bEnable)=0
 Enable or disable video de-noise.
 
virtual bool IsTemporalDeNoiseEnabled ()=0
 Get the flag to enable/disable the video de-noise.
 
virtual SDKError EnableAlwaysShowNameOnVideo (bool bEnable)=0
 Enable or disable to show the username on the video.
 
virtual bool IsAlwaysShowNameOnVideoEnabled ()=0
 Get the flag to enable/disable to show the username on video.
 
virtual SDKError EnableAutoTurnOffVideoWhenJoinMeeting (bool bEnable)=0
 Enable or disable to turn off the video when join meeting.
 
virtual bool IsAutoTurnOffVideoWhenJoinMeetingEnabled ()=0
 Get the flag to enable to turn off the video when join meeting.
 
virtual SDKError SetVideoDeviceEvent (IVideoSettingContextEvent *pEvent)=0
 Video device monitor callback event.
 
virtual SDKError EnableVideoAutoFraming (AutoFramingMode mode, AutoFramingParameter &param)=0
 Enable my video auto-framing.
 
virtual bool IsVideoAutoFramingEnabled ()=0
 Determine whether auto-framing is enabled.
 
virtual SDKError GetVideoAutoFramingMode (AutoFramingMode &mode)=0
 Get current mode of auto-framing.
 
virtual SDKError SetVideoAutoFramingMode (AutoFramingMode mode)=0
 Set the mode of auto-framing when auto-framing is enabled.
 
virtual SDKError SetVideoAutoFramingRatio (float ratio)=0
 Set the zoom in ratio of auto-framing when auto-framing is enabled.
 
virtual SDKError SetFaceRecognitionFailStrategy (FaceRecognitionFailStrategy strategy)=0
 Set the fail strategy of face recognition when auto-framing is enabled(mode is "AutoFramingMode_face_recognition")
 
virtual SDKError GetVideoAutoFramingSetting (AutoFramingMode mode, AutoFramingParameter &param)=0
 Get the setting of auto-framing.
 
virtual SDKError DisableVideoAutoFraming ()=0
 Stop video auto-framing.
 
virtual SDKError EnableOptimizeVideoQuality (bool bEnable)=0
 Enable or disable optimizing received video quality when facing network issues for a variety of reasons. Applies to the window in focus: speaker view, pinned / spotlighted videos, gallery view with a small number of videos.
 
virtual bool IsOptimizeVideoQualityEnabled ()=0
 Determine if optimizing received video quality is enabled.
 
virtual bool IsOptimizeVideoQualitySupported ()=0
 Determine if optimizing received video quality is supported.
 
virtual SDKError EnableVideoMirrorEffect (bool bEnable)=0
 Enable or disable video mirror effect.
 
virtual bool IsVideoMirrorEffectEnabled ()=0
 Get the flag to enable/disable the video mirror effect.
 
virtual SDKError EnableSpotlightSelf (bool bEnable)=0
 Enable or disable to spotlight the video.
 
virtual bool IsSpotlightSelfEnabled ()=0
 Get the flag to enable/disable to spotlight video.
 
virtual SDKError EnableHardwareEncode (bool bEnable, VIDEO_HARDWARE_ENCODE_TYPE encodeType)=0
 Enable or disable the hardware acceleration.
 
virtual bool IsHardwareEncodeEnabled (VIDEO_HARDWARE_ENCODE_TYPE encodeType)=0
 Get the flag to enable/disable the hardware acceleration.
 
virtual SDKError Enable49VideoesInGallaryView (bool bEnable)=0
 Enable or disable to show the participants in Gallery View up to 49 per screen.
 
virtual bool Is49VideoesInGallaryViewEnabled ()=0
 Get the flag to enable/disable to show the participants in Gallery View up to 49 per screen.
 
virtual SDKError EnableHideNoVideoUsersOnWallView (bool bEnable)=0
 Enable or disable to hide the non-video participants.
 
virtual bool IsHideNoVideoUsersOnWallViewEnabled ()=0
 Get the flag to enable/disable to hide non-video participants.
 
virtual SDKError EnableVideoPreviewDialog (bool bEnable)=0
 Enable or disable to show the video preview dialog when join meeting.
 
virtual bool IsVideoPreviewDialogEnabled ()=0
 Get the flag to enable to show the video preview dialog when join meeting.
 
virtual SDKError EnableStopIncomingVideo (bool bEnable)=0
 Enable or disable to stop incoming video.
 
virtual bool IsStopIncomingVideoEnabled ()=0
 Get the flag to enable/disable to stop in coming video.
 
virtual SDKError EnableHideSelfView (bool bEnable)=0
 Enable or disable to hide the userself's view.
 
virtual SDKError IsHideSelfViewEnabled (bool &bEnabled)=0
 Get the flag to enable/disable to hide userself's view.
 
virtual ITestVideoDeviceHelperGetTestVideoDeviceHelper ()=0
 Get the pointer to ITestVideoDeviceHelper which is used to test camera device.
 

Detailed Description

Video setting interface.

Definition at line 719 of file setting_service_interface.h.

Member Function Documentation

◆ DisableVideoAutoFraming()

virtual SDKError IVideoSettingContext::DisableVideoAutoFraming ( )
pure virtual

Stop video auto-framing.

Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise the function fails and return an error. To get extended error information, see SDKError enum.

◆ Enable49VideoesInGallaryView()

virtual SDKError IVideoSettingContext::Enable49VideoesInGallaryView ( bool bEnable)
pure virtual

Enable or disable to show the participants in Gallery View up to 49 per screen.

Parameters
bEnableTRUE indicates to show the participants in Gallery View up to 49 per screen.
Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

◆ EnableAlwaysShowNameOnVideo()

virtual SDKError IVideoSettingContext::EnableAlwaysShowNameOnVideo ( bool bEnable)
pure virtual

Enable or disable to show the username on the video.

Parameters
bEnableTRUE indicates to show the username on the video.
Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

◆ EnableAlwaysUseOriginalSizeVideo()

virtual SDKError IVideoSettingContext::EnableAlwaysUseOriginalSizeVideo ( bool bEnable)
pure virtual

Enable or disable always use original size video.

Parameters
bEnableTRUE indicates to enable always use original size video.
Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

◆ EnableAutoTurnOffVideoWhenJoinMeeting()

virtual SDKError IVideoSettingContext::EnableAutoTurnOffVideoWhenJoinMeeting ( bool bEnable)
pure virtual

Enable or disable to turn off the video when join meeting.

Parameters
bEnableTRUE indicates to enable to turn off the video when join meeting
Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

◆ EnableFaceBeautyEffect()

virtual SDKError IVideoSettingContext::EnableFaceBeautyEffect ( bool bEnable)
pure virtual

Enable or disable the video facial beauty effect.

Parameters
bEnableTRUE indicates to enable the video facial beauty effect.
Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

◆ EnableHardwareEncode()

virtual SDKError IVideoSettingContext::EnableHardwareEncode ( bool bEnable,
VIDEO_HARDWARE_ENCODE_TYPE encodeType )
pure virtual

Enable or disable the hardware acceleration.

Parameters
bEnableTRUE indicates to enable the hardware acceleration.
Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

◆ EnableHDVideo()

virtual SDKError IVideoSettingContext::EnableHDVideo ( bool bEnable)
pure virtual

Enable or disable HD video.

Parameters
bEnableTRUE indicates to enable the HD video.
Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

◆ EnableHideNoVideoUsersOnWallView()

virtual SDKError IVideoSettingContext::EnableHideNoVideoUsersOnWallView ( bool bEnable)
pure virtual

Enable or disable to hide the non-video participants.

Parameters
bEnableTRUE indicates to hide the non-video Participants.
Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

◆ EnableHideSelfView()

virtual SDKError IVideoSettingContext::EnableHideSelfView ( bool bEnable)
pure virtual

Enable or disable to hide the userself's view.

Parameters
bEnableTRUE indicates to enable to hide the userself's view.
Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.
Remarks
Valid only for Zoom style user interface mode.

◆ EnableLightAdaption()

virtual SDKError IVideoSettingContext::EnableLightAdaption ( bool bEnable,
VIDEO_LIGHT_ADAPTION_TYPE lightAdaptionType,
double manualValue )
pure virtual

Enable or disable the light adaption of the video.

Parameters
bEnableTRUE indicates to enable the light adaption of the video.
lightAdaptionTypeTRUE indicates the type to adjust the low light. If bEnable is TRUE, the default value of lightAdaptionType is Light_Adaption_Auto.
manualValueThe value is only effective when the bAutoAdaption is FALSE. The value should between 0 to 100.
Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

◆ EnableOptimizeVideoQuality()

virtual SDKError IVideoSettingContext::EnableOptimizeVideoQuality ( bool bEnable)
pure virtual

Enable or disable optimizing received video quality when facing network issues for a variety of reasons. Applies to the window in focus: speaker view, pinned / spotlighted videos, gallery view with a small number of videos.

Parameters
bEnabletrue indicates to enable this feature. Otherwise disable this feature.
Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise the function fails and returns error code. To get extended error information, see SDKError enum.

◆ EnableSpotlightSelf()

virtual SDKError IVideoSettingContext::EnableSpotlightSelf ( bool bEnable)
pure virtual

Enable or disable to spotlight the video.

Parameters
bEnableTRUE indicates to enable to spotlight the video.
Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

◆ EnableStopIncomingVideo()

virtual SDKError IVideoSettingContext::EnableStopIncomingVideo ( bool bEnable)
pure virtual

Enable or disable to stop incoming video.

Parameters
bEnableTRUE indicates to enable to stop incoming video.
Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise the function fails and returns an error. To get extended error information, see SDKError enum.

◆ EnableTemporalDeNoise()

virtual SDKError IVideoSettingContext::EnableTemporalDeNoise ( bool bEnable)
pure virtual

Enable or disable video de-noise.

Parameters
bEnableTRUE indicates to enable video de-noise.
Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

◆ EnableVideoAutoFraming()

virtual SDKError IVideoSettingContext::EnableVideoAutoFraming ( AutoFramingMode mode,
AutoFramingParameter & param )
pure virtual

Enable my video auto-framing.

Parameters
modethe auto-framing mode.
paramthe auto-framing parameter.
Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise the function fails and return an error. To get extended error information, see SDKError enum.

◆ EnableVideoMirrorEffect()

virtual SDKError IVideoSettingContext::EnableVideoMirrorEffect ( bool bEnable)
pure virtual

Enable or disable video mirror effect.

Parameters
bEnableTRUE indicates to enable the video mirror effect.
Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

◆ EnableVideoPreviewDialog()

virtual SDKError IVideoSettingContext::EnableVideoPreviewDialog ( bool bEnable)
pure virtual

Enable or disable to show the video preview dialog when join meeting.

Parameters
bEnableTRUE indicates to enable to show the video preview dialog when join meeting
Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

◆ GetCameraList()

virtual IList< ICameraInfo * > * IVideoSettingContext::GetCameraList ( )
pure virtual

Get camera device list.

Returns
If the function succeeds, the return value the is camera device list. Otherwise failed, returns nullptr.

◆ GetFaceBeautyStrengthValue()

virtual unsigned int IVideoSettingContext::GetFaceBeautyStrengthValue ( )
pure virtual

Get the video facial beauty strength value.

Returns
The video facial beauty strength value. If the video facial beauty effect is disabled, the return value is 0.

◆ GetLightAdaptionManualValue()

virtual double IVideoSettingContext::GetLightAdaptionManualValue ( )
pure virtual

Get the manual setting value for the light adaption of the video.

Returns
The manual setting value. If the light adaption is disabled or the type of light adaption is AUTO, the return value is 0.

◆ GetLightAdaptionType()

virtual VIDEO_LIGHT_ADAPTION_TYPE IVideoSettingContext::GetLightAdaptionType ( )
pure virtual

Get the light adaption type of the video.

Returns
The light adaption type. If the light adaption is disabled, the return value is Light_Adaption_None.

◆ GetTestVideoDeviceHelper()

virtual ITestVideoDeviceHelper * IVideoSettingContext::GetTestVideoDeviceHelper ( )
pure virtual

Get the pointer to ITestVideoDeviceHelper which is used to test camera device.

Returns
If the function succeeds, the return value is the pointer to ITestVideoDeviceHelper. Otherwise failed, returns nullptr. For more details, see ITestVideoDeviceHelper.

◆ GetVideoAutoFramingMode()

virtual SDKError IVideoSettingContext::GetVideoAutoFramingMode ( AutoFramingMode & mode)
pure virtual

Get current mode of auto-framing.

Parameters
modethe auto-framing mode.
Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise the function fails and return an error. To get extended error information, see SDKError enum.

◆ GetVideoAutoFramingSetting()

virtual SDKError IVideoSettingContext::GetVideoAutoFramingSetting ( AutoFramingMode mode,
AutoFramingParameter & param )
pure virtual

Get the setting of auto-framing.

Parameters
modethe auto-framing mode.
paramthe auto-framing parameter.
Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise the function fails and return an error. To get extended error information, see SDKError enum.

◆ Is49VideoesInGallaryViewEnabled()

virtual bool IVideoSettingContext::Is49VideoesInGallaryViewEnabled ( )
pure virtual

Get the flag to enable/disable to show the participants in Gallery View up to 49 per screen.

Returns
Enabled or disabled.

◆ IsAlwaysShowNameOnVideoEnabled()

virtual bool IVideoSettingContext::IsAlwaysShowNameOnVideoEnabled ( )
pure virtual

Get the flag to enable/disable to show the username on video.

Returns
Enabled or disabled.

◆ IsAlwaysUseOriginalSizeVideo()

virtual bool IVideoSettingContext::IsAlwaysUseOriginalSizeVideo ( )
pure virtual

Get the flag to enable/disable always use original size video.

Returns
Enabled or disabled.

◆ IsAutoTurnOffVideoWhenJoinMeetingEnabled()

virtual bool IVideoSettingContext::IsAutoTurnOffVideoWhenJoinMeetingEnabled ( )
pure virtual

Get the flag to enable to turn off the video when join meeting.

Returns
Enabled or disabled.

◆ IsFaceBeautyEffectEnabled()

virtual bool IVideoSettingContext::IsFaceBeautyEffectEnabled ( )
pure virtual

Get the flag to enable/disable the video facial beauty effect.

Returns
Enabled or disabled.

◆ IsHardwareEncodeEnabled()

virtual bool IVideoSettingContext::IsHardwareEncodeEnabled ( VIDEO_HARDWARE_ENCODE_TYPE encodeType)
pure virtual

Get the flag to enable/disable the hardware acceleration.

Returns
Enabled or disabled.

◆ IsHDVideoEnabled()

virtual bool IVideoSettingContext::IsHDVideoEnabled ( )
pure virtual

Get the flag to enable/disable the HD video.

Returns
Enabled or disabled.

◆ IsHideNoVideoUsersOnWallViewEnabled()

virtual bool IVideoSettingContext::IsHideNoVideoUsersOnWallViewEnabled ( )
pure virtual

Get the flag to enable/disable to hide non-video participants.

Returns
Enabled or disabled.

◆ IsHideSelfViewEnabled()

virtual SDKError IVideoSettingContext::IsHideSelfViewEnabled ( bool & bEnabled)
pure virtual

Get the flag to enable/disable to hide userself's view.

Returns
Enabled or disabled.
Remarks
Valid only for Zoom style user interface mode.

◆ IsLightAdaptionEnabled()

virtual bool IVideoSettingContext::IsLightAdaptionEnabled ( )
pure virtual

Get the flag to enable/disable the light adaption of the video.

Returns
Enabled or disabled.

◆ IsOptimizeVideoQualityEnabled()

virtual bool IVideoSettingContext::IsOptimizeVideoQualityEnabled ( )
pure virtual

Determine if optimizing received video quality is enabled.

Returns
true indicates that optimization is enabled. False means optimization is not enabled.

◆ IsOptimizeVideoQualitySupported()

virtual bool IVideoSettingContext::IsOptimizeVideoQualitySupported ( )
pure virtual

Determine if optimizing received video quality is supported.

Returns
true indicates that it is supported, false means that it isn't.

◆ IsSpotlightSelfEnabled()

virtual bool IVideoSettingContext::IsSpotlightSelfEnabled ( )
pure virtual

Get the flag to enable/disable to spotlight video.

Returns
Enabled or disabled.

◆ IsStopIncomingVideoEnabled()

virtual bool IVideoSettingContext::IsStopIncomingVideoEnabled ( )
pure virtual

Get the flag to enable/disable to stop in coming video.

Returns
Enabled or disabled.

◆ IsTemporalDeNoiseEnabled()

virtual bool IVideoSettingContext::IsTemporalDeNoiseEnabled ( )
pure virtual

Get the flag to enable/disable the video de-noise.

Returns
Enabled or disabled.

◆ IsVideoAutoFramingEnabled()

virtual bool IVideoSettingContext::IsVideoAutoFramingEnabled ( )
pure virtual

Determine whether auto-framing is enabled.

Returns
true indicates enabled. False not.

◆ IsVideoMirrorEffectEnabled()

virtual bool IVideoSettingContext::IsVideoMirrorEffectEnabled ( )
pure virtual

Get the flag to enable/disable the video mirror effect.

Returns
Enabled or disabled.

◆ IsVideoPreviewDialogEnabled()

virtual bool IVideoSettingContext::IsVideoPreviewDialogEnabled ( )
pure virtual

Get the flag to enable to show the video preview dialog when join meeting.

Returns
Enabled or disabled.

◆ SelectCamera()

virtual SDKError IVideoSettingContext::SelectCamera ( const zchar_t * deviceId)
pure virtual

Select camera device.

Parameters
deviceIdSpecify a device to be selected.
Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

◆ SetFaceBeautyStrengthValue()

virtual SDKError IVideoSettingContext::SetFaceBeautyStrengthValue ( unsigned int beautyStrengthValue)
pure virtual

Set the video facial beauty strength value.

Parameters
beautyStrengthValueThe value is only effective when the video facial beauty effect is enabled. The value should between 0 to 100.
Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

◆ SetFaceRecognitionFailStrategy()

virtual SDKError IVideoSettingContext::SetFaceRecognitionFailStrategy ( FaceRecognitionFailStrategy strategy)
pure virtual

Set the fail strategy of face recognition when auto-framing is enabled(mode is "AutoFramingMode_face_recognition")

Parameters
strategythe fail strategy of face recognition.
Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise the function fails and return an error. To get extended error information, see SDKError enum.

◆ SetVideoAutoFramingMode()

virtual SDKError IVideoSettingContext::SetVideoAutoFramingMode ( AutoFramingMode mode)
pure virtual

Set the mode of auto-framing when auto-framing is enabled.

Parameters
modethe auto-framing mode.
Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise the function fails and return an error. To get extended error information, see SDKError enum.

◆ SetVideoAutoFramingRatio()

virtual SDKError IVideoSettingContext::SetVideoAutoFramingRatio ( float ratio)
pure virtual

Set the zoom in ratio of auto-framing when auto-framing is enabled.

Parameters
ratiothe zoom in ratio of auto-framing, valid range of ratio: a. mode is "AutoFramingMode_center_coordinates", 1~10 b. mode is "AutoFramingMode_face_recognition", 0.1~10
Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise the function fails and return an error. To get extended error information, see SDKError enum.

◆ SetVideoDeviceEvent()

virtual SDKError IVideoSettingContext::SetVideoDeviceEvent ( IVideoSettingContextEvent * pEvent)
pure virtual

Video device monitor callback event.

Parameters
pEventA pointer to the IVideoSettingContextEvent.
Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum. For more details, see IVideoSettingContextEvent.
Remarks
You must call the function if you want to monitor the video device plugged in/out.