Video SDK for MacOS API Reference
Loading...
Searching...
No Matches
ZMVideoSDKVideoSettingHelper Class Reference

Provides settings-related functions to configure video enhancement options. More...

#include <ZMVideoSDKVideoSettingHelper.h>

Inherits NSObject.

Instance Methods

(ZMVideoSDKErrors- enableTemporalDeNoise:
 Enables or disables temporal video denoising. This process reduces noise between frames of video.
(BOOL) - isTemporalDeNoiseEnabled
 Query if the option to optimize video quality with de-noise is enabled.
(ZMVideoSDKErrors- enableFaceBeautyEffect:
 Enables or disables the face beauty effect for the video stream.
(BOOL) - isFaceBeautyEffectEnabled
 Determines whether the face beauty effect is currently enabled.
(ZMVideoSDKErrors- setFaceBeautyStrengthValue:
 Sets the intensity level of the face beauty effect (the strength value).
(unsigned int) - getFaceBeautyStrengthValue
 Retrieves the current intensity level of the face beauty effect (the strength value).

Detailed Description

Provides settings-related functions to configure video enhancement options.

Definition at line 13 of file ZMVideoSDKVideoSettingHelper.h.

Method Documentation

◆ enableFaceBeautyEffect:

- (ZMVideoSDKErrors) enableFaceBeautyEffect: (BOOL) enable

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

Parameters
enableYES to enable the face beauty effect, NO to disable it.
Returns
If the function succeeds, it returns ZMVideoSDKErrors_Success. Otherwise, this function returns an error.

◆ enableTemporalDeNoise:

- (ZMVideoSDKErrors) enableTemporalDeNoise: (BOOL) enable

Enables or disables temporal video denoising. This process reduces noise between frames of video.

Parameters
enableYES to enable the temporal de-noise of video, NO to disable it.
Returns
If the function succeeds, it returns ZMVideoSDKErrors_Success. Otherwise, this function returns an error.

◆ getFaceBeautyStrengthValue

- (unsigned int) getFaceBeautyStrengthValue

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

Returns
The current face beauty strength value (0-100).
Note
A higher value indicates a stronger beauty effect.

References getFaceBeautyStrengthValue.

Referenced by getFaceBeautyStrengthValue.

◆ isFaceBeautyEffectEnabled

- (BOOL) isFaceBeautyEffectEnabled

Determines whether the face beauty effect is currently enabled.

Returns
YES if the face beauty effect is enabled. Otherwise, NO.

References isFaceBeautyEffectEnabled.

Referenced by isFaceBeautyEffectEnabled.

◆ isTemporalDeNoiseEnabled

- (BOOL) isTemporalDeNoiseEnabled

Query if the option to optimize video quality with de-noise is enabled.

Returns
YES if temporal video denoising is enabled. Otherwise, NO.

References isTemporalDeNoiseEnabled.

Referenced by isTemporalDeNoiseEnabled.

◆ setFaceBeautyStrengthValue:

- (ZMVideoSDKErrors) setFaceBeautyStrengthValue: (unsigned int) strengthValue

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

Parameters
strengthValueThe desired face beauty strength value (0-100).
Returns
If the function succeeds, it returns ZMVideoSDKErrors_Success. Otherwise, this function returns an error.
Note
The face beauty effect must be enabled before adjusting its strength.