Table of Contents

Class RippleVideoEffect

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

Represents a ripple effect that creates water-like distortions triggered by motion detection or simulated rain drops.

public class RippleVideoEffect : BaseVideoEffect, IBaseVideoEffect, IVideoEditXVideoEffect

Inheritance

Implements

Inherited Members

Remarks

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

Platforms: Windows, Linux, macOS, Android, iOS

This effect simulates ripple distortions on the video surface, similar to dropping objects into water or waves propagating across a liquid surface. The effect can operate in two modes:

  • Motion Detection Mode: Ripples are created dynamically where motion is detected in the video, creating interactive distortions that respond to movement in the scene.
  • Rain Mode: Ripples are generated randomly across the frame to simulate rain drops hitting a water surface, creating continuous wave patterns.

The ripple effect is commonly used for:

  • Artistic Expression: Create surreal, dream-like visuals
  • Interactive Video: Ripples respond to on-screen movement
  • Transitions: Add liquid-like transition effects between scenes
  • Music Videos: Create dynamic, fluid visual effects synchronized with music
  • Reflections: Simulate water surface reflections

This is a cross-platform effect using the rippletv element. The effect automatically generates and propagates ripple patterns based on the selected mode.

Performance: Real-time capable on most modern hardware. Motion detection mode requires additional CPU for motion analysis. GPU-accelerated for distortion rendering. Mobile devices may experience slight performance impact depending on resolution and motion complexity.

Constructors

RippleVideoEffect(string)

Initializes a new instance of the VisioForge.Core.Types.X.VideoEffects.RippleVideoEffect class with specified name.

public RippleVideoEffect(string name = "ripple")

Parameters

name string

The unique name for this effect instance. Defaults to "ripple".

Fields

DefaultName

The default name for ripple effects.

public static string DefaultName

Field Value

string

Properties

Mode

Gets or sets the ripple generation mode.

public RippleMode Mode { get; set; }

Property Value

RippleMode

Remarks

Motion Detection Mode: Analyzes frame-to-frame differences to detect movement. Ripples appear at locations where motion occurs, creating an interactive effect. More CPU-intensive due to motion analysis.

Rain Mode: Generates ripples at random locations across the frame continuously, simulating rain drops hitting a water surface. Less CPU-intensive as it doesn't require motion analysis.

StartTime

Gets or sets the start time for the ripple effect (VideoEditCoreX only).

public TimeSpan StartTime { get; set; }

Property Value

TimeSpan

Remarks

This property is only used in VideoEditCoreX for time-based effect control.

StopTime

Gets or sets the stop time for the ripple effect (VideoEditCoreX only).

public TimeSpan StopTime { get; set; }

Property Value

TimeSpan

Remarks

This property is only used in VideoEditCoreX for time-based effect control.

Methods

GenerateDescription()

Generates the description.

public string GenerateDescription()

Returns

string

System.String.