Table of Contents

Class RippleBlock

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

Ripple effect block that creates water-like wave distortions and undulating visual patterns. This block applies dynamic ripple distortion effects that simulate water surface waves, heat shimmer, or liquid distortions across the video content. Features configurable amplitude, frequency, wave speed, and center point parameters for creating realistic fluid motion effects. Essential for artistic video production, liquid simulations, dream sequences, and creative effects requiring organic wave-based distortions. Implements the VisioForge.Core.MediaBlocks.MediaBlock. Implements the VisioForge.Core.MediaBlocks.IMediaBlockInternals. Implements the IDisposable.

public class RippleBlock : MediaBlock, IMediaBlock, IDisposable, IMediaBlockInternals

Inheritance

Implements

Inherited Members

Extension Methods

Constructors

RippleBlock(RippleVideoEffect)

Initializes a new instance of the VisioForge.Core.MediaBlocks.VideoProcessing.RippleBlock class with specified ripple effect settings.

public RippleBlock(RippleVideoEffect settings)

Parameters

settings RippleVideoEffect

The ripple effect configuration settings.

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[]

Settings

Gets or sets the ripple effect settings. Contains parameters for controlling wave amplitude, frequency, speed, center point, and other characteristics of the ripple distortion effect.

public RippleVideoEffect Settings { get; set; }

Property Value

RippleVideoEffect

Type

Gets the type.

public override MediaBlockType Type { get; }

Property Value

MediaBlockType

Methods

Build()

Constructs and initializes the ripple filter and its associated GStreamer elements. This method creates the filter with the specified ripple settings, establishes input and output pads, and prepares the block for creating water-like wave distortions and organic undulating visual patterns.

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 ripple effect 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 ripple filter element.

public BaseElement GetCore()

Returns

BaseElement

The BaseElement wrapper instance that encapsulates the GStreamer ripple filter.

GetElement()

Gets the underlying GStreamer element that performs the ripple wave distortion processing.

public Element GetElement()

Returns

Element

The GStreamer Element instance representing the ripple 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 ripple effect 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