Table of Contents

Class ColorEffectsBlock

Namespace
VisioForge.Core.MediaBlocks.VideoProcessing
Assembly
VisioForge.Core.dll

Color effects block providing preset-based color manipulation and artistic filtering. This block applies predefined color effects and artistic filters to video content including color temperature adjustments, saturation changes, hue shifts, contrast enhancement, and creative color grading presets. Features various built-in presets for common color effects such as sepia, black and white, vintage, high contrast, and cinematic color grading. Essential for video post-production, creative content creation, broadcast enhancement, and artistic video filtering applications. Implements the VisioForge.Core.MediaBlocks.MediaBlock. Implements the VisioForge.Core.MediaBlocks.IMediaBlockInternals. Implements the IDisposable.

public class ColorEffectsBlock : MediaBlock, IMediaBlock, IDisposable, IMediaBlockInternals

Inheritance

Implements

Inherited Members

Extension Methods

Constructors

ColorEffectsBlock(ColorEffectsPreset)

Initializes a new instance of the VisioForge.Core.MediaBlocks.VideoProcessing.ColorEffectsBlock class with the specified color effects preset.

public ColorEffectsBlock(ColorEffectsPreset preset)

Parameters

preset ColorEffectsPreset

The color effects preset to apply.

Properties

Input

Gets the input.

public override MediaBlockPad Input { get; }

Property Value

MediaBlockPad

Inputs

Gets the inputs.

public override MediaBlockPad[] Inputs { get; }

Property Value

MediaBlockPad[]

Output

Gets the output.

public override MediaBlockPad Output { get; }

Property Value

MediaBlockPad

Outputs

Gets the outputs.

public override MediaBlockPad[] Outputs { get; }

Property Value

MediaBlockPad[]

Preset

Gets or sets the color effects preset. Specifies which predefined color effect or artistic filter to apply to the video.

public ColorEffectsPreset Preset { get; set; }

Property Value

ColorEffectsPreset

Type

Gets the type.

public override MediaBlockType Type { get; }

Property Value

MediaBlockType

Methods

Build()

Constructs and initializes the color effects filter and its associated GStreamer elements. This method creates the filter with the specified preset, establishes input and output pads, and prepares the block for applying artistic color transformations to video content.

public override bool Build()

Returns

bool

true if the filter was successfully built and configured; false if initialization failed.

CleanUp()

Releases all resources and performs cleanup operations for this color effects block. This method disposes of the GStreamer elements and resets the build state.

public void CleanUp()

Dispose(bool)

Releases unmanaged and - optionally - managed resources.

protected override void Dispose(bool disposing)

Parameters

disposing bool

true to release both managed and unmanaged resources; false to release only unmanaged resources.

GetCore()

Gets the core BaseElement wrapper that provides additional functionality around the GStreamer color effects filter element.

public BaseElement GetCore()

Returns

BaseElement

The BaseElement wrapper instance that encapsulates the GStreamer color effects filter.

GetElement()

Gets the underlying GStreamer element that performs the color effects processing.

public Element GetElement()

Returns

Element

The GStreamer Element instance representing the color effects filter.

IsAvailable()

Determines whether this media block is available. Correct NuGet SDK redist should be included into your project.

public static bool IsAvailable()

Returns

bool

true if this media block is available; otherwise, false.

IMediaBlockInternals.SetContext(MediaBlocksPipeline)

Associates this color effects block with a pipeline and initializes its internal context. This method is called internally when the block is added to a pipeline.

void IMediaBlockInternals.SetContext(MediaBlocksPipeline pipeline)

Parameters

pipeline MediaBlocksPipeline

The MediaBlocksPipeline instance that will manage this block.

See Also