Video setting interface. More...

#include <setting_service_interface.h>

Public Member Functions
virtual IList< ICameraInfo * > *	GetCameraList ()=0
	Gets camera device list.

virtual SDKError	SelectCamera (const zchar_t *deviceId)=0
	Select camera device.

virtual SDKError	EnableFaceBeautyEffect (bool bEnable)=0
	Enables or disable the video facial beauty effect.

virtual bool	IsFaceBeautyEffectEnabled ()=0
	Gets the flag to enable/disable the video facial beauty effect.

virtual unsigned int	GetFaceBeautyStrengthValue ()=0
	Gets the video facial beauty strength value.

virtual SDKError	SetFaceBeautyStrengthValue (unsigned int beautyStrengthValue)=0
	Sets the video facial beauty strength value.

virtual SDKError	EnableLightAdaption (bool bEnable, VIDEO_LIGHT_ADAPTION_TYPE lightAdaptionType, double manualValue)=0
	Enables or disable the light adaption of the video.

virtual bool	IsLightAdaptionEnabled ()=0
	Gets the flag to enable/disable the light adaption of the video.

virtual VIDEO_LIGHT_ADAPTION_TYPE	GetLightAdaptionType ()=0
	Gets the light adaption type of the video.

virtual double	GetLightAdaptionManualValue ()=0
	Gets the manual setting value for the light adaption of the video.

virtual SDKError	EnableHDVideo (bool bEnable)=0
	Enables or disable HD video.

virtual bool	IsHDVideoEnabled ()=0
	Gets the flag to enable/disable the HD video.

virtual SDKError	EnableAlwaysUseOriginalSizeVideo (bool bEnable)=0
	Enables or disable always use original size video.

virtual bool	IsAlwaysUseOriginalSizeVideo ()=0
	Gets the flag to enable/disable always use original size video.

virtual SDKError	EnableTemporalDeNoise (bool bEnable)=0
	Enables or disable video de-noise.

virtual bool	IsTemporalDeNoiseEnabled ()=0
	Gets the flag to enable/disable the video de-noise.

virtual SDKError	EnableAlwaysShowNameOnVideo (bool bEnable)=0
	Enables or disable to show the username on the video.

virtual bool	IsAlwaysShowNameOnVideoEnabled ()=0
	Gets the flag to enable/disable to show the username on video.

virtual SDKError	EnableAutoTurnOffVideoWhenJoinMeeting (bool bEnable)=0
	Enables or disable to turn off the video when join meeting.

virtual bool	IsAutoTurnOffVideoWhenJoinMeetingEnabled ()=0
	Gets 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
	Enables my video auto-framing.

virtual bool	IsVideoAutoFramingEnabled ()=0
	Determines whether auto-framing is enabled.

virtual SDKError	GetVideoAutoFramingMode (AutoFramingMode &mode)=0
	Gets current mode of auto-framing.

virtual SDKError	SetVideoAutoFramingMode (AutoFramingMode mode)=0
	Sets the mode of auto-framing when auto-framing is enabled.

virtual SDKError	SetVideoAutoFramingRatio (float ratio)=0
	Sets the zoom in ratio of auto-framing when auto-framing is enabled.

virtual SDKError	SetFaceRecognitionFailStrategy (FaceRecognitionFailStrategy strategy)=0
	Sets the fail strategy of face recognition when auto-framing is enabled(mode is "AutoFramingMode_face_recognition")

virtual SDKError	GetVideoAutoFramingSetting (AutoFramingMode mode, AutoFramingParameter &param)=0
	Gets the setting of auto-framing.

virtual SDKError	DisableVideoAutoFraming ()=0
	Stops video auto-framing.

virtual SDKError	EnableOptimizeVideoQuality (bool bEnable)=0
	Enables or disable optimizing received video quality when facing network issues for a variety of reasons.

virtual bool	IsOptimizeVideoQualityEnabled ()=0
	Determines if optimizing received video quality is enabled.

virtual bool	IsOptimizeVideoQualitySupported ()=0
	Determines if optimizing received video quality is supported.

Detailed Description

Video setting interface.

Definition at line 965 of file setting_service_interface.h.

Member Function Documentation

◆ DisableVideoAutoFraming()

virtual SDKError IVideoSettingContext::DisableVideoAutoFraming ( )

pure virtual

Stops video auto-framing.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

◆ EnableAlwaysShowNameOnVideo()

virtual SDKError IVideoSettingContext::EnableAlwaysShowNameOnVideo ( bool bEnable )

pure virtual

Enables or disable to show the username on the video.

Parameters

bEnable true indicates to show the username on the video.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

◆ EnableAlwaysUseOriginalSizeVideo()

virtual SDKError IVideoSettingContext::EnableAlwaysUseOriginalSizeVideo ( bool bEnable )

pure virtual

Enables or disable always use original size video.

Parameters

bEnable true indicates to enable always use original size video.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

◆ EnableAutoTurnOffVideoWhenJoinMeeting()

virtual SDKError IVideoSettingContext::EnableAutoTurnOffVideoWhenJoinMeeting ( bool bEnable )

pure virtual

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

Parameters

bEnable true indicates to enable to turn off the video when join meeting

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

◆ EnableFaceBeautyEffect()

virtual SDKError IVideoSettingContext::EnableFaceBeautyEffect ( bool bEnable )

pure virtual

Enables or disable the video facial beauty effect.

Parameters

bEnable true indicates to enable the video facial beauty effect.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

◆ EnableHDVideo()

virtual SDKError IVideoSettingContext::EnableHDVideo ( bool bEnable )

pure virtual

Enables or disable HD video.

Parameters

bEnable true indicates to enable the HD video.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

◆ EnableLightAdaption()

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

pure virtual

Enables or disable the light adaption of the video.

Parameters

bEnable	true indicates to enable the light adaption of the video.
lightAdaptionType	true indicates the type to adjust the low light. If bEnable is true, the default value of lightAdaptionType is Light_Adaption_Auto.
manualValue	The 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, this function returns an error.

◆ EnableOptimizeVideoQuality()

virtual SDKError IVideoSettingContext::EnableOptimizeVideoQuality ( bool bEnable )

pure virtual

Enables or disable optimizing received video quality when facing network issues for a variety of reasons.

Note: Applies to the window in focus: speaker view, pinned / spotlighted videos, gallery view with a small number of videos.

Parameters

bEnable true indicates to enable this feature. Otherwise disable this feature.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

◆ EnableTemporalDeNoise()

virtual SDKError IVideoSettingContext::EnableTemporalDeNoise ( bool bEnable )

pure virtual

Enables or disable video de-noise.

Parameters

bEnable true indicates to enable video de-noise.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

◆ EnableVideoAutoFraming()

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

pure virtual

Enables my video auto-framing.

Parameters

mode	the auto-framing mode.
param	the auto-framing parameter.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

◆ GetCameraList()

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

pure virtual

Gets camera device list.

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

◆ GetFaceBeautyStrengthValue()

virtual unsigned int IVideoSettingContext::GetFaceBeautyStrengthValue ( )

pure virtual

Gets 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

Gets 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

Gets 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.

◆ GetVideoAutoFramingMode()

virtual SDKError IVideoSettingContext::GetVideoAutoFramingMode ( AutoFramingMode & mode )

pure virtual

Gets current mode of auto-framing.

Parameters

mode	the auto-framing mode.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

◆ GetVideoAutoFramingSetting()

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

pure virtual

Gets the setting of auto-framing.

Parameters

mode	the auto-framing mode.
param	the auto-framing parameter.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

◆ IsAlwaysShowNameOnVideoEnabled()

virtual bool IVideoSettingContext::IsAlwaysShowNameOnVideoEnabled ( )

pure virtual

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

Returns: true indicates enabled.

◆ IsAlwaysUseOriginalSizeVideo()

virtual bool IVideoSettingContext::IsAlwaysUseOriginalSizeVideo ( )

pure virtual

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

Returns: true indicates to use.

◆ IsAutoTurnOffVideoWhenJoinMeetingEnabled()

virtual bool IVideoSettingContext::IsAutoTurnOffVideoWhenJoinMeetingEnabled ( )

pure virtual

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

Returns: true indicates enabled.

◆ IsFaceBeautyEffectEnabled()

virtual bool IVideoSettingContext::IsFaceBeautyEffectEnabled ( )

pure virtual

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

Returns: true indicates enabled.

◆ IsHDVideoEnabled()

virtual bool IVideoSettingContext::IsHDVideoEnabled ( )

pure virtual

Gets the flag to enable/disable the HD video.

Returns: true indicates enabled.

◆ IsLightAdaptionEnabled()

virtual bool IVideoSettingContext::IsLightAdaptionEnabled ( )

pure virtual

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

Returns: true indicates enabled.

◆ IsOptimizeVideoQualityEnabled()

virtual bool IVideoSettingContext::IsOptimizeVideoQualityEnabled ( )

pure virtual

Determines if optimizing received video quality is enabled.

Returns: true if that optimization is enabled. Otherwise, false.

◆ IsOptimizeVideoQualitySupported()

virtual bool IVideoSettingContext::IsOptimizeVideoQualitySupported ( )

pure virtual

Determines if optimizing received video quality is supported.

Returns: true indicates that it is supported.

◆ IsTemporalDeNoiseEnabled()

virtual bool IVideoSettingContext::IsTemporalDeNoiseEnabled ( )

pure virtual

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

Returns: true indicates enabled.

◆ IsVideoAutoFramingEnabled()

virtual bool IVideoSettingContext::IsVideoAutoFramingEnabled ( )

pure virtual

Determines whether auto-framing is enabled.

Returns: true indicates enabled.

◆ SelectCamera()

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

pure virtual

Select camera device.

Parameters

deviceId Specify a device to be selected.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

◆ SetFaceBeautyStrengthValue()

virtual SDKError IVideoSettingContext::SetFaceBeautyStrengthValue ( unsigned int beautyStrengthValue )

pure virtual

Sets the video facial beauty strength value.

Parameters

beautyStrengthValue The 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, this function returns an error.

◆ SetFaceRecognitionFailStrategy()

virtual SDKError IVideoSettingContext::SetFaceRecognitionFailStrategy ( FaceRecognitionFailStrategy strategy )

pure virtual

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

Parameters

strategy the fail strategy of face recognition.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

◆ SetVideoAutoFramingMode()

virtual SDKError IVideoSettingContext::SetVideoAutoFramingMode ( AutoFramingMode mode )

pure virtual

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

Parameters

mode	the auto-framing mode.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

◆ SetVideoAutoFramingRatio()

virtual SDKError IVideoSettingContext::SetVideoAutoFramingRatio ( float ratio )

pure virtual

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

Parameters

ratio the 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, this function returns an error.

◆ SetVideoDeviceEvent()

virtual SDKError IVideoSettingContext::SetVideoDeviceEvent ( IVideoSettingContextEvent * pEvent )

pure virtual

Video device monitor callback event.

Parameters

pEvent A pointer to the IVideoSettingContextEvent.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

Remarks: You must call the function if you want to monitor the video device plugged in/out.

Public Member Functions

Detailed Description

Member Function Documentation

◆ DisableVideoAutoFraming()

◆ EnableAlwaysShowNameOnVideo()

◆ EnableAlwaysUseOriginalSizeVideo()

◆ EnableAutoTurnOffVideoWhenJoinMeeting()

◆ EnableFaceBeautyEffect()

◆ EnableHDVideo()

◆ EnableLightAdaption()

◆ EnableOptimizeVideoQuality()

◆ EnableTemporalDeNoise()

◆ EnableVideoAutoFraming()

◆ GetCameraList()

◆ GetFaceBeautyStrengthValue()

◆ GetLightAdaptionManualValue()

◆ GetLightAdaptionType()

◆ GetVideoAutoFramingMode()

◆ GetVideoAutoFramingSetting()

◆ IsAlwaysShowNameOnVideoEnabled()

◆ IsAlwaysUseOriginalSizeVideo()

◆ IsAutoTurnOffVideoWhenJoinMeetingEnabled()

◆ IsFaceBeautyEffectEnabled()

◆ IsHDVideoEnabled()

◆ IsLightAdaptionEnabled()

◆ IsOptimizeVideoQualityEnabled()

◆ IsOptimizeVideoQualitySupported()

◆ IsTemporalDeNoiseEnabled()

◆ IsVideoAutoFramingEnabled()

◆ SelectCamera()

◆ SetFaceBeautyStrengthValue()

◆ SetFaceRecognitionFailStrategy()

◆ SetVideoAutoFramingMode()

◆ SetVideoAutoFramingRatio()

◆ SetVideoDeviceEvent()