Video setting interface. More...

#include <setting_service_interface.h>

Public Member Functions
virtual IList< ICameraInfo * > *	GetCameraList ()=0
	Gets the camera device list.
virtual SDKError	SelectCamera (const zchar_t *deviceId)=0
	Selects a camera device.
virtual SDKError	EnableFaceBeautyEffect (bool bEnable)=0
	Enables or disables the video facial beauty effect.
virtual bool	IsFaceBeautyEffectEnabled ()=0
	Determines whether the video facial beauty effect is enabled.
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 disables light adaption of the video.
virtual bool	IsLightAdaptionEnabled ()=0
	Determines whether light adaption of the video is enabled.
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 light adaption of the video.
virtual SDKError	EnableHDVideo (bool bEnable)=0
	Enables or disables HD video.
virtual bool	IsHDVideoEnabled ()=0
	Determines whether HD video is enabled.
virtual SDKError	EnableAlwaysUseOriginalSizeVideo (bool bEnable)=0
	Enables or disables always using original size video.
virtual bool	IsAlwaysUseOriginalSizeVideo ()=0
	Determines whether always using original size video is enabled.
virtual SDKError	EnableTemporalDeNoise (bool bEnable)=0
	Enables or disables video de-noise.
virtual bool	IsTemporalDeNoiseEnabled ()=0
	Determines whether video de-noise is enabled.
virtual SDKError	EnableAlwaysShowNameOnVideo (bool bEnable)=0
	Enables or disables showing the username on the video.
virtual bool	IsAlwaysShowNameOnVideoEnabled ()=0
	Determines whether showing the username on video is enabled.
virtual SDKError	EnableAutoTurnOffVideoWhenJoinMeeting (bool bEnable)=0
	Enables or disables turning off the video when joining the meeting.
virtual bool	IsAutoTurnOffVideoWhenJoinMeetingEnabled ()=0
	Determines whether turning off the video when joining the meeting is enabled.
virtual SDKError	SetVideoDeviceEvent (IVideoSettingContextEvent *pEvent)=0
	Sets the 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 the 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 disables optimizing received video quality when facing network issues for a variety of reasons.
virtual bool	IsOptimizeVideoQualityEnabled ()=0
	Determines whether optimizing received video quality is enabled.
virtual bool	IsOptimizeVideoQualitySupported ()=0
	Determines whether optimizing received video quality is supported.

Detailed Description

Video setting interface.

Definition at line 961 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, it returns SDKERR_SUCCESS. Otherwise, this function returns an error.

◆ EnableAlwaysShowNameOnVideo()

virtual SDKError IVideoSettingContext::EnableAlwaysShowNameOnVideo ( bool bEnable )

pure virtual

Enables or disables showing the username on the video.

Parameters

bEnable true to enable, false to disable.

Returns: If the function succeeds, it returns SDKERR_SUCCESS. Otherwise, this function returns an error.

◆ EnableAlwaysUseOriginalSizeVideo()

virtual SDKError IVideoSettingContext::EnableAlwaysUseOriginalSizeVideo ( bool bEnable )

pure virtual

Enables or disables always using original size video.

Parameters

bEnable true to enable, false to disable.

Returns: If the function succeeds, it returns SDKERR_SUCCESS. Otherwise, this function returns an error.

◆ EnableAutoTurnOffVideoWhenJoinMeeting()

virtual SDKError IVideoSettingContext::EnableAutoTurnOffVideoWhenJoinMeeting ( bool bEnable )

pure virtual

Enables or disables turning off the video when joining the meeting.

Parameters

bEnable true to enable, false to disable.

Returns: If the function succeeds, it returns SDKERR_SUCCESS. Otherwise, this function returns an error.

◆ EnableFaceBeautyEffect()

virtual SDKError IVideoSettingContext::EnableFaceBeautyEffect ( bool bEnable )

pure virtual

Enables or disables the video facial beauty effect.

Parameters

bEnable true to enable, false to disable.

Returns: If the function succeeds, it returns SDKERR_SUCCESS. Otherwise, this function returns an error.

◆ EnableHDVideo()

virtual SDKError IVideoSettingContext::EnableHDVideo ( bool bEnable )

pure virtual

Enables or disables HD video.

Parameters

bEnable true to enable, false to disable.

Returns: If the function succeeds, it returns 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 disables light adaption of the video.

Parameters

bEnable	true to enable, false to disable.
lightAdaptionType	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 bAutoAdaption is false. The value ranges from 0 to 100.

Returns: If the function succeeds, it returns SDKERR_SUCCESS. Otherwise, this function returns an error.

◆ EnableOptimizeVideoQuality()

virtual SDKError IVideoSettingContext::EnableOptimizeVideoQuality ( bool bEnable )

pure virtual

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

Parameters

bEnable true to enable, false to disable.

Returns: If the function succeeds, it returns SDKERR_SUCCESS. Otherwise, this function returns an error.

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

◆ EnableTemporalDeNoise()

virtual SDKError IVideoSettingContext::EnableTemporalDeNoise ( bool bEnable )

pure virtual

Enables or disables video de-noise.

Parameters

bEnable true to enable, false to disable.

Returns: If the function succeeds, it returns 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, it returns SDKERR_SUCCESS. Otherwise, this function returns an error.

◆ GetCameraList()

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

pure virtual

Gets the camera device list.

Returns: If the function succeeds, it returns the camera device list. Otherwise, this function fails and 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 light adaption of the video.

Returns: The manual setting value. If 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 light adaption is disabled, the return value is Light_Adaption_None.

◆ GetVideoAutoFramingMode()

virtual SDKError IVideoSettingContext::GetVideoAutoFramingMode ( AutoFramingMode & mode )

pure virtual

Gets the current mode of auto-framing.

Parameters

mode	The auto-framing mode.

Returns: If the function succeeds, it returns 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, it returns SDKERR_SUCCESS. Otherwise, this function returns an error.

◆ IsAlwaysShowNameOnVideoEnabled()

virtual bool IVideoSettingContext::IsAlwaysShowNameOnVideoEnabled ( )

pure virtual

Determines whether showing the username on video is enabled.

Returns: true if enabled. Otherwise, false.

◆ IsAlwaysUseOriginalSizeVideo()

virtual bool IVideoSettingContext::IsAlwaysUseOriginalSizeVideo ( )

pure virtual

Determines whether always using original size video is enabled.

Returns: true if enabled. Otherwise, false.

◆ IsAutoTurnOffVideoWhenJoinMeetingEnabled()

virtual bool IVideoSettingContext::IsAutoTurnOffVideoWhenJoinMeetingEnabled ( )

pure virtual

Determines whether turning off the video when joining the meeting is enabled.

Returns: true if enabled. Otherwise, false.

◆ IsFaceBeautyEffectEnabled()

virtual bool IVideoSettingContext::IsFaceBeautyEffectEnabled ( )

pure virtual

Determines whether the video facial beauty effect is enabled.

Returns: true if enabled. Otherwise, false.

◆ IsHDVideoEnabled()

virtual bool IVideoSettingContext::IsHDVideoEnabled ( )

pure virtual

Determines whether HD video is enabled.

Returns: true if enabled. Otherwise, false.

◆ IsLightAdaptionEnabled()

virtual bool IVideoSettingContext::IsLightAdaptionEnabled ( )

pure virtual

Determines whether light adaption of the video is enabled.

Returns: true if enabled. Otherwise, false.

◆ IsOptimizeVideoQualityEnabled()

virtual bool IVideoSettingContext::IsOptimizeVideoQualityEnabled ( )

pure virtual

Determines whether optimizing received video quality is enabled.

Returns: true if enabled. Otherwise, false.

◆ IsOptimizeVideoQualitySupported()

virtual bool IVideoSettingContext::IsOptimizeVideoQualitySupported ( )

pure virtual

Determines whether optimizing received video quality is supported.

Returns: true if supported. Otherwise, false.

◆ IsTemporalDeNoiseEnabled()

virtual bool IVideoSettingContext::IsTemporalDeNoiseEnabled ( )

pure virtual

Determines whether video de-noise is enabled.

Returns: true if enabled. Otherwise, false.

◆ IsVideoAutoFramingEnabled()

virtual bool IVideoSettingContext::IsVideoAutoFramingEnabled ( )

pure virtual

Determines whether auto-framing is enabled.

Returns: true if enabled. Otherwise, false.

◆ SelectCamera()

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

pure virtual

Selects a camera device.

Parameters

deviceId The device ID to be selected.

Returns: If the function succeeds, it returns 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 ranges from 0 to 100.

Returns: If the function succeeds, it returns 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, it returns 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, it returns 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: 1 to 10 when mode is AutoFramingMode_center_coordinates, 0.1 to 10 when mode is AutoFramingMode_face_recognition.

Returns: If the function succeeds, it returns SDKERR_SUCCESS. Otherwise, this function returns an error.

◆ SetVideoDeviceEvent()

virtual SDKError IVideoSettingContext::SetVideoDeviceEvent ( IVideoSettingContextEvent * pEvent )

pure virtual

Sets the video device monitor callback event.

Parameters

pEvent A pointer to the IVideoSettingContextEvent.

Returns: If the function succeeds, it returns SDKERR_SUCCESS. Otherwise, this function returns an error.

Note: You must call this function if you want to monitor the video device plugged in or 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()