setVideoDenoiserOptions abstract method

Future<void> setVideoDenoiserOptions({
  1. required bool enabled,
  2. required VideoDenoiserOptions options,
  3. MediaSourceType type = MediaSourceType.primaryCameraSource,
})

Sets the video denoising feature.

You can call this method to enable the video denoising feature and configure its effects. If the denoising strength provided by this method does not meet your needs, Agora recommends calling the setBeautyEffectOptions method to enable the skin smoothing feature for better video denoising. Recommended BeautyOptions settings for strong denoising: lighteningContrastLevel : lighteningContrastNormal lighteningLevel : 0.0 smoothnessLevel : 0.5 rednessLevel : 0.0 sharpnessLevel : 0.1 This method depends on the video enhancement dynamic library libagora_clear_vision_extension.dll. If this library is removed, the feature cannot be enabled properly. Video denoising has certain performance requirements. After enabling it, if the device experiences severe overheating, it is recommended to lower the denoising level to a less performance-intensive one or disable the feature.

  • enabled Whether to enable the video denoising feature: true : Enables video denoising. false : (Default) Disables video denoising.
  • options Video denoising options for configuring the effect. See VideoDenoiserOptions.
  • type The type of media source to which the effect is applied. See MediaSourceType. In this method, this parameter only supports the following two settings: When using the camera to capture local video, keep the default value primaryCameraSource. If you want to use custom captured video, set this parameter to customVideoSource.

Returns When the method call succeeds, there is no return value; when fails, the AgoraRtcException exception is thrown. You need to catch the exception and handle it accordingly. See Error Codes for details and resolution suggestions.

Implementation

Future<void> setVideoDenoiserOptions(
    {required bool enabled,
    required VideoDenoiserOptions options,
    MediaSourceType type = MediaSourceType.primaryCameraSource});