IZoomVideoSDKVideoSettingHelper Class Reference

Helper interface for configuring video settings. More...

#include <zoom_video_sdk_video_setting_interface.h>

Public Member Functions
virtual ZoomVideoSDKErrors	enableTemporalDeNoise (bool bEnable)=0
	Call this method to enable or disable the temporal de-noise of video.
virtual ZoomVideoSDKErrors	isTemporalDeNoiseEnabled (bool &bEnable)=0
	Determines whether the temporal de-noise of video is enabled.
virtual ZoomVideoSDKErrors	enableFaceBeautyEffect (bool bEnable)=0
	Enables or disables the face beauty effect for the video stream.
virtual ZoomVideoSDKErrors	isFaceBeautyEffectEnabled (bool &bEnable)=0
	Determines whether the face beauty effect is currently enabled.
virtual ZoomVideoSDKErrors	setFaceBeautyStrengthValue (unsigned int strengthValue)=0
	Sets the intensity level of the face beauty effect (the strength value).
virtual ZoomVideoSDKErrors	getFaceBeautyStrengthValue (unsigned int &strengthValue)=0
	Gets the current intensity level of the face beauty effect (the strength value).

Detailed Description

Helper interface for configuring video settings.

Definition at line 17 of file zoom_video_sdk_video_setting_interface.h.

Member Function Documentation

enableFaceBeautyEffect()

virtual ZoomVideoSDKErrors IZoomVideoSDKVideoSettingHelper::enableFaceBeautyEffect ( bool bEnable )

pure virtual

Enables or disables the face beauty effect for the video stream.

Parameters

bEnable

true to enable the face beauty effect, false to disable it.

Returns

If the function succeeds, it returns ZoomVideoSDKErrors_Success. Otherwise, this function returns an error.

enableTemporalDeNoise()

virtual ZoomVideoSDKErrors IZoomVideoSDKVideoSettingHelper::enableTemporalDeNoise ( bool bEnable )

pure virtual

Call this method to enable or disable the temporal de-noise of video.

Parameters

bEnable

true to enable the temporal de-noise of video or false to disable it.

Returns

If the function succeeds, it returns ZoomVideoSDKErrors_Success. Otherwise, this function returns an error.

getFaceBeautyStrengthValue()

virtual ZoomVideoSDKErrors IZoomVideoSDKVideoSettingHelper::getFaceBeautyStrengthValue ( unsigned int & strengthValue )

pure virtual

Gets the current intensity level of the face beauty effect (the strength value).

Parameters

[out]

strengthValue

The current face beauty strength value (0-100).

Returns

If the function succeeds, it returns ZoomVideoSDKErrors_Success. Otherwise, this function returns an error.

Note

A higher value indicates a stronger beauty effect.

isFaceBeautyEffectEnabled()

virtual ZoomVideoSDKErrors IZoomVideoSDKVideoSettingHelper::isFaceBeautyEffectEnabled ( bool & bEnable )

pure virtual

Determines whether the face beauty effect is currently enabled.

Parameters

[out]

bEnable

true if the face beauty effect is enabled, false otherwise.

Returns

If the function succeeds, it returns ZoomVideoSDKErrors_Success. Otherwise, this function returns an error.

isTemporalDeNoiseEnabled()

virtual ZoomVideoSDKErrors IZoomVideoSDKVideoSettingHelper::isTemporalDeNoiseEnabled ( bool & bEnable )

pure virtual

Determines whether the temporal de-noise of video is enabled.

Parameters

[out]

bEnable

true if the temporal de-noise of video is enabled, otherwise false.

Returns

If the function succeeds, it returns ZoomVideoSDKErrors_Success. Otherwise, this function returns an error.

setFaceBeautyStrengthValue()

virtual ZoomVideoSDKErrors IZoomVideoSDKVideoSettingHelper::setFaceBeautyStrengthValue ( unsigned int strengthValue )

pure virtual

Sets the intensity level of the face beauty effect (the strength value).

Parameters

strengthValue

The desired face beauty strength value (0-100).

Returns

If the function succeeds, it returns ZoomVideoSDKErrors_Success. Otherwise, this function returns an error.

Note

The face beauty effect must be enabled before adjusting its strength.