Table of Contents

Class FishEyeVideoEffect

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

Represents a fish-eye lens distortion effect that simulates wide-angle lens distortion.

public class FishEyeVideoEffect : 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 the spherical distortion characteristic of fish-eye camera lenses, creating a bulging, convex appearance where the center of the image appears to push outward while the edges are compressed inward. This produces a hemispherical or ultra-wide-angle view.

The fish-eye effect is commonly used for:

  • Artistic Expression: Create dramatic, distorted perspectives
  • POV Shots: Simulate action camera or surveillance camera views
  • Creative Transitions: Add visual interest between scenes
  • 360° Video Processing: Simulate spherical camera views
  • VR Content: Pre-distort footage for VR display correction

This effect applies a fixed fish-eye distortion pattern with no adjustable parameters. The distortion strength is automatically calculated based on the video dimensions to provide a natural-looking fish-eye effect.

This is a cross-platform effect using the fisheye element. The effect is GPU-accelerated where available for real-time performance.

Performance: Real-time capable on most hardware. GPU-accelerated for efficient geometric transformation. Mobile devices may experience slight performance impact at higher resolutions.

Constructors

FishEyeVideoEffect(string)

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

public FishEyeVideoEffect(string name = "fish_eye")

Parameters

name string

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

Fields

DefaultName

The default name for fish-eye effects.

public static string DefaultName

Field Value

string

Properties

StartTime

Gets or sets the start time for the fish-eye effect (VideoEditCoreX only).

public TimeSpan StartTime { get; set; }

Property Value

TimeSpan

Remarks

This property is only used in VideoEditCoreX for time-based effect control. In live processing scenarios, the effect is applied continuously.

StopTime

Gets or sets the stop time for the fish-eye effect (VideoEditCoreX only).

public TimeSpan StopTime { get; set; }

Property Value

TimeSpan

Remarks

This property is only used in VideoEditCoreX for time-based effect control. In live processing scenarios, the effect is applied continuously.

Methods

GenerateDescription()

Generates the description.

public string GenerateDescription()

Returns

string

A string containing the GStreamer element description for the fisheye effect.