Table of Contents

Class WaterRippleBlock

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

Video water ripple distortion effect block that creates fluid wave-like animations. This block simulates water surface ripples by applying dynamic wave distortions to video content. Features configurable wave amplitude, frequency, and center point for realistic water effects. Creates animated concentric ripples emanating from a specified point, perfect for artistic transitions, fluid simulations, and dynamic visual effects requiring liquid-like distortion. Essential for creating water drop effects, pond ripples, and animated distortion sequences. Implements the VisioForge.Core.MediaBlocks.MediaBlock. Implements the VisioForge.Core.MediaBlocks.IMediaBlockInternals. Implements the IDisposable.

public class WaterRippleBlock : MediaBlock, IMediaBlock, IDisposable, IMediaBlockInternals

Inheritance

Implements

Inherited Members

Extension Methods

Constructors

WaterRippleBlock(WaterRippleVideoEffect)

Initializes a new instance of the VisioForge.Core.MediaBlocks.VideoProcessing.WaterRippleBlock class with specified water ripple distortion settings.

public WaterRippleBlock(WaterRippleVideoEffect settings)

Parameters

settings WaterRippleVideoEffect

The water ripple distortion 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 water ripple distortion settings. Contains wave parameters including amplitude, frequency, center point coordinates, and animation speed for creating realistic water surface effects.

public WaterRippleVideoEffect Settings { get; set; }

Property Value

WaterRippleVideoEffect

Type

Gets the type.

public override MediaBlockType Type { get; }

Property Value

MediaBlockType

Methods

Build()

Constructs and initializes the water ripple distortion 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 video wave distortion processing.

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

public BaseElement GetCore()

Returns

BaseElement

The BaseElement wrapper instance that encapsulates the GStreamer water ripple filter.

GetElement()

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

public Element GetElement()

Returns

Element

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