Table of Contents

Class SmoothVideoEffect

Namespace
VisioForge.Core.Types.X.VideoEffects
Assembly
VisioForge.Core.dll

Represents a smooth/median filter effect that reduces noise and softens video while preserving edges.

public class SmoothVideoEffect : BaseVideoEffect, IBaseVideoEffect, IVideoEditXVideoEffect

Inheritance

Implements

Inherited Members

Remarks

SDK Availability: VideoCaptureCoreX, MediaPlayerCoreX, VideoEditCoreX, Media Blocks SDK

Platform Support: Windows, Linux, macOS, Android, iOS

The smooth effect applies a median filter that reduces noise and artifacts while attempting to preserve edges. Unlike Gaussian blur which smooths uniformly, the median filter is edge-preserving and particularly effective at removing salt-and-pepper noise and compression artifacts.

Key Features:

  • Edge-Preserving: Maintains sharp edges while smoothing flat areas
  • Noise Reduction: Excellent for reducing random noise and artifacts
  • Luma-Only Mode: Option to smooth only brightness, preserving color detail
  • Adjustable Tolerance: Controls how aggressively to smooth based on contrast
  • Variable Filter Size: Larger filters = more smoothing

Parameters:

  • FilterSize: Median filter kernel size (3, 5, 7, etc. - larger = more smoothing)
  • Tolerance: Contrast threshold (0-255) - higher = more aggressive smoothing
  • LumaOnly: When true, only smooth brightness (preserves color)

Common Use Cases:

  • Reducing compression artifacts from heavily compressed video
  • Cleaning up noisy low-light footage
  • Smoothing skin tones for beauty filter effects
  • Removing salt-and-pepper noise from old footage
  • Softening video while maintaining edge sharpness

For Classic SDK, see VideoEffectSmooth (Windows only). For Gaussian blur, see VisioForge.Core.Types.X.VideoEffects.GaussianBlurVideoEffect. For AI-based noise reduction, see MaxineDenoiseVideoEffect (Windows, RTX GPU).

Performance Note: Median filtering is CPU-intensive, especially with large filter sizes. Use smaller filter sizes (3-5) for real-time applications. LumaOnly=true improves performance by ~40%.

Constructors

SmoothVideoEffect(string)

Initializes a new instance of the VisioForge.Core.Types.X.VideoEffects.SmoothVideoEffect class.

public SmoothVideoEffect(string name = "smooth")

Parameters

name string

The name.

Fields

DefaultName

The default name.

public static string DefaultName

Field Value

string

Properties

Active

Gets or sets a value indicating whether filter is active.

public bool Active { get; set; }

Property Value

bool

FilterSize

Gets or sets the size of media filter.

public int FilterSize { get; set; }

Property Value

int

LumaOnly

Gets or sets a value indicating whether only filter luma part.

public bool LumaOnly { get; set; }

Property Value

bool

StartTime

Gets or sets the start time.

public TimeSpan StartTime { get; set; }

Property Value

TimeSpan

StopTime

Gets or sets the stop time.

public TimeSpan StopTime { get; set; }

Property Value

TimeSpan

Tolerance

Gets or sets the contrast tolerance for smoothing.

public int Tolerance { get; set; }

Property Value

int

Methods

GenerateDescription()

Generates the description.

public string GenerateDescription()

Returns

string

System.String.

Exceptions

NotImplementedException