Table of Contents

Class VideoBalanceVideoEffect

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

Represents a comprehensive cross-platform video balance effect that controls brightness, contrast, saturation, and hue.

public sealed class VideoBalanceVideoEffect : BaseVideoEffect, IBaseVideoEffect, IVideoEditXVideoEffect

Inheritance

Implements

Inherited Members

Remarks

SDK Availability: VideoCaptureCoreX, MediaPlayerCoreX, VideoEditCoreX, Media Blocks SDK (Cross-platform)

Platforms: Windows, Linux, macOS, Android, iOS

The VideoBalanceVideoEffect provides unified control over multiple color and brightness adjustments in a single effect, making it an efficient choice for comprehensive color correction.

Properties:

  • Brightness: Adjusts overall lightness/darkness (Range: -1.0 to 1.0, Default: 0.0)
  • Contrast: Adjusts difference between light and dark areas (Range: 0.0 to 2.0, Default: 1.0)
  • Saturation: Controls color intensity (Range: 0.0 to 2.0, Default: 1.0)
  • Hue: Shifts colors around the color wheel (Range: -1.0 to 1.0, Default: 0.0)

Performance: Efficient single-pass effect suitable for real-time processing on all platforms.

See Also: For Windows-only applications, see individual Classic effects: VideoEffectDarkness, VideoEffectContrast, VideoEffectSaturation.

Constructors

VideoBalanceVideoEffect(string)

Initializes a new instance of the VisioForge.Core.Types.X.VideoEffects.VideoBalanceVideoEffect class with default balanced values.

public VideoBalanceVideoEffect(string name = "video-balance")

Parameters

name string

The unique name identifier for this effect instance. Default value is "video-balance".

Fields

DefaultName

The default name for the video balance effect.

public static string DefaultName

Field Value

string

Properties

Brightness

Gets or sets the brightness adjustment.

public double Brightness { get; set; }

Property Value

double

Remarks

Brightness adjusts the overall lightness or darkness of the image. Negative values darken, positive values lighten. This is a linear adjustment applied uniformly to all pixels.

Contrast

Gets or sets the contrast adjustment.

public double Contrast { get; set; }

Property Value

double

Remarks

Contrast adjusts the difference between light and dark areas. Higher values increase the separation between bright and dark tones, making the image appear more dramatic. Lower values reduce the difference, creating a flatter, washed-out appearance.

Hue

Gets or sets the hue shift.

public double Hue { get; set; }

Property Value

double

Remarks

Hue shift rotates all colors around the color wheel. For example, positive values shift reds towards yellows, yellows towards greens, etc. This creates artistic color effects while preserving brightness and saturation.

Saturation

Gets or sets the color saturation.

public double Saturation { get; set; }

Property Value

double

Remarks

Saturation controls the intensity of colors. A value of 0.0 removes all color, creating a grayscale image. Values above 1.0 make colors more vivid and intense.

StartTime

Gets or sets the time when the effect should start being applied.

public TimeSpan StartTime { get; set; }

Property Value

TimeSpan

StopTime

Gets or sets the time when the effect should stop being applied.

public TimeSpan StopTime { get; set; }

Property Value

TimeSpan

Methods

GenerateDescription()

Generates the description.

public string GenerateDescription()

Returns

string

System.String.

Exceptions

NotImplementedException