Table of Contents

Namespace VisioForge.Core.Types.X.VideoEffects

Classes

AgingVideoEffect

Represents an aging video effect that simulates old, deteriorated film or video footage.

AspectRatioCropVideoEffect

Represents an aspect ratio crop effect that automatically crops video to match a target aspect ratio.

AutoDeinterlaceSettings

Auto deinterlace settings.

BaseVideoEffect

Base video effect.

BoxVideoEffect

Represents a box effect that adds borders/padding or crops video with flexible fill options.

ChromaKeySettingsX

Represents a chroma key (green/blue screen) settings class for removing background colors from video.

CircleVideoEffect

Represents a circular arc perspective effect that maps the video onto a circular arc segment creating cylindrical distortion.

ColorEffectsVideoEffect

Represents a color effects video effect that applies artistic color transformations using preset filters.

CropVideoEffect

Represents a video crop effect that removes pixels from the edges of video frames.

CustomVideoSampleGrabberEffect

Custom video sample grabber effect that allows capturing video frames for processing.

DeinterlaceSettings

Deinterlace settings.

DeinterlaceVideoEffect

Represents a cross-platform deinterlacing video effect that converts interlaced video to progressive.

DiceVideoEffect

Represents a dice/pixelation effect that divides the video into a grid of square blocks with randomly shuffled positions.

EdgeVideoEffect

Represents an edge detection effect that highlights boundaries and contours in video.

FishEyeVideoEffect

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

FlipRotateVideoEffect

Represents a cross-platform video flip and rotation effect for geometric transformations.

FontSettings

Font settings.

GammaVideoEffect

Represents a gamma correction video effect that adjusts the overall brightness/darkness curve of the video.

GaussianBlurVideoEffect

Represents a cross-platform Gaussian blur video effect with adjustable blur intensity.

GrayscaleVideoEffect

Represents a cross-platform grayscale (black and white) video effect that converts color video to monochrome.

ImageOverlayCairoVideoEffect

Cairo-based image overlay video effect that provides high-quality rendering and cross-platform compatibility. This effect uses the Cairo graphics library for overlaying images onto video streams, offering superior rendering quality and better support across different platforms compared to the standard GdkPixbuf-based implementation. Supports all standard overlay features including positioning, scaling, transparency, and timing control, while providing smoother alpha blending and better performance for complex overlay scenarios.

ImageOverlaySettings

Image overlay settings.

ImageOverlayVideoEffect

Represents an image overlay effect that composites static images (watermarks, logos) onto video frames.

InterlaceSettings

Interlace settings.

KaleidoscopeVideoEffect

Represents a kaleidoscope effect that creates symmetrical, mirrored patterns from video content.

LUTVideoEffect

Represents a LUT (Look-Up Table) effect for professional color grading and color correction. Supported formats: 3dl (AfterEffects), cube (Iridas), dat (DaVinci), m3d (Pandora), csp (cineSpace).

MarbleVideoEffect

Represents a marble texture distortion effect that applies procedural marble-like patterns to video.

MovingBlurVideoEffect

Represents a motion-sensitive blur effect that creates radioactive or strobe-like visual distortions.

MovingEchoVideoEffect

Represents a motion echo effect that creates visible trails following moving objects in the video.

MovingZoomEchoVideoEffect

Represents a moving zoom echo effect that combines radial motion with zooming for a vertigo-inducing visual distortion.

OpticalAnimationBWVideoEffect

Represents a black and white optical animation effect that creates dynamic, pulsating monochrome patterns triggered by luminance thresholds.

OverlayManagerBackgroundImage

Represents a background image for the overlay manager that can be stretched and rendered behind other overlay elements. Implements the VisioForge.Core.Types.X.VideoEffects.IOverlayManagerBackground

OverlayManagerBackgroundRectangle

Represents a rectangular background for the overlay manager with configurable color, fill mode, and margins. Implements the VisioForge.Core.Types.X.VideoEffects.IOverlayManagerBackground

OverlayManagerBackgroundSquare

Represents a square background for the overlay manager with configurable color, fill mode, and margins. Implements the VisioForge.Core.Types.X.VideoEffects.IOverlayManagerBackground

OverlayManagerBackgroundStar

Represents a star-shaped background for the overlay manager with configurable stroke color, fill color, and zoom ratio. Implements the VisioForge.Core.Types.X.VideoEffects.IOverlayManagerBackground

OverlayManagerBackgroundTriangle

Represents a triangular background for the overlay manager defined by three points. Implements the VisioForge.Core.Types.X.VideoEffects.IOverlayManagerBackground

OverlayManagerCallback

Overlay Manager callback element. Provides a way to draw custom overlay using Cairo. Implements the VisioForge.Core.Types.X.VideoEffects.IOverlayManagerElement.

OverlayManagerCallbackEventArgs

Overlay Manager callback args. Implements the EventArgs.

OverlayManagerCircle

Overlay Manager circle element. Implements the VisioForge.Core.Types.X.VideoEffects.IOverlayManagerElement.

OverlayManagerDateTime

Overlay Manager Date/Time overlay. Set Text to "some text [DATETIME] other text" string to use date/time. Implements the VisioForge.Core.Types.X.VideoEffects.OverlayManagerText.

OverlayManagerDecklinkVideo

Decklink video overlay element that captures video from Decklink devices in the overlay manager.

OverlayManagerFade

Fade effect for overlay manager that fades the video in from black or out to black. Implements the VisioForge.Core.Types.X.VideoEffects.IOverlayManagerElement interface.

OverlayManagerGIF

Overlay Manager GIF element. Implements the VisioForge.Core.Types.X.VideoEffects.IOverlayManagerElement. Implements the IDisposable.

OverlayManagerGroup

A group of overlay elements that start and stop synchronously. This is particularly useful for video overlays that need to be preloaded and started at the exact same time. Implements the VisioForge.Core.Types.X.VideoEffects.IOverlayManagerElement.

OverlayManagerImage

Overlay Manager image. Implements the IDisposable.

OverlayManagerLine

Overlay Manager line element. Implements the VisioForge.Core.Types.X.VideoEffects.IOverlayManagerElement.

OverlayManagerNDIVideo

NDI video overlay element that captures video from NDI sources in the overlay manager.

OverlayManagerPan

Pan effect for overlay manager that animates the visible area between a start rectangle and a stop rectangle over time. This creates a smooth panning and zooming effect commonly used in Ken Burns-style video presentations. Implements the VisioForge.Core.Types.X.VideoEffects.IOverlayManagerElement interface.

OverlayManagerRectangle

Overlay Manager rectangle element. Implements the VisioForge.Core.Types.X.VideoEffects.IOverlayManagerElement.

OverlayManagerSVG

Overlay Manager SVG image. Implements the IDisposable.

OverlayManagerScrollingText

Overlay Manager Scrolling Text element for displaying scrolling text overlays. Implements the VisioForge.Core.Types.X.VideoEffects.IOverlayManagerElement.

OverlayManagerShadowSettings

Shadow settings for overlay manager elements.

OverlayManagerSqueezeback

Squeezeback effect element that scales the video to a custom rectangle and draws an image overlay on top with alpha transparency support. The typical use case is a full-frame PNG image with transparent areas where the scaled video shows through. Implements the VisioForge.Core.Types.X.VideoEffects.IOverlayManagerElement interface.

OverlayManagerStar

Overlay Manager star element. Implements the VisioForge.Core.Types.X.VideoEffects.IOverlayManagerElement.

OverlayManagerText

Overlay Manager Text element. Implements the VisioForge.Core.Types.X.VideoEffects.IOverlayManagerElement.

OverlayManagerTriangle

Overlay Manager triangle element. Implements the VisioForge.Core.Types.X.VideoEffects.IOverlayManagerElement.

OverlayManagerVideo

Video overlay element that plays video files in the overlay manager.

OverlayManagerZoom

Zoom effect for overlay manager that scales and shifts the video content. This effect allows zooming into the video with configurable X/Y scaling ratios and pixel-based shift offsets for positioning the zoomed area. Implements the VisioForge.Core.Types.X.VideoEffects.IOverlayManagerElement interface.

Pseudo3DVideoEffect

Represents a pseudo-3D depth effect that creates a TV scanline-style appearance with motion-triggered updates.

QuarkVideoEffect

Represents a quark effect that divides the video into multiple moving color planes creating a segmented, layered appearance.

ResizeVideoEffect

Represents a video resize effect that scales video to a target resolution with high-quality scaling algorithms.

RippleVideoEffect

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

SMPTEAlphaVideoEffect

Represents a SMPTE alpha transition effect that creates wipe transitions with full alpha channel support for transparency control.

SMPTEVideoEffect

Represents a SMPTE (Society of Motion Picture and Television Engineers) transition effect that creates professional wipe transitions between two video sources.

SVGOverlayVideoEffect

Represents an SVG overlay effect that renders scalable vector graphics on top of video content.

SmoothVideoEffect

Represents a smooth/median filter effect that reduces noise and softens video while preserving edges.

SquareVideoEffect

Represents a square perspective mapping effect that creates a zoom-in distortion within a centered rectangular region.

StretchVideoEffect

Represents a stretch distortion effect that creates non-linear scaling and warping of the video image.

SubtitleOverlaySettings

Subtitle overlay settings.

TextOverlaySettings

Text overlay settings.

TextOverlayVideoEffect

Represents a text overlay effect that renders text, timestamps, or system time on video frames.

VideoBalanceVideoEffect

Represents a comprehensive cross-platform video balance effect that controls brightness, contrast, saturation, and hue.

VideoCompositionElement

Class VideoCompositionElement. Implements the IDisposable.

VideoMixerBaseSettings

Video Mixer base settings.

VideoMixerSettings

Video mixer settings.

VideoMixerStream

Video mixer stream settings.

VideoMixerStreamChromaKey

Video mixer stream with chroma key support. Implements the VisioForge.Core.Types.X.VideoEffects.VideoMixerStream.

VideoMixerStreamPNGSource

Video mixer stream image PNG source. Implements the VisioForge.Core.Types.X.VideoEffects.VideoMixerStream.

VideoPaddingChangerSettings

Class VideoPaddingChangerSettings.

VideoStreamDynamicPanSettings

Settings for dynamic pan (translation) transformation of the original video stream. The pan values are interpolated between start and stop values based on the timestamp. This is applied before any overlays are drawn.

VideoStreamDynamicZoomSettings

Settings for dynamic zoom transformation of the original video stream. The zoom values are interpolated between start and stop values based on the timestamp. This is applied before any overlays are drawn.

VideoStreamPanSettings

Settings for static pan (translation) transformation of the original video stream. This is applied before any overlays are drawn.

VideoStreamRectSettings

Settings for drawing the video stream into a target rectangle. The video is resized and positioned to fit within the specified rectangle.

VideoStreamZoomSettings

Settings for static zoom transformation of the original video stream. This is applied before any overlays are drawn.

WarpVideoEffect

Represents a warp effect that creates dynamic, random spatial distortions simulating analog video signal degradation.

WaterRippleVideoEffect

Represents a water ripple effect that simulates light refraction through water waves with precise control over wave properties.

Interfaces

IBaseVideoEffect

Base video effect interface.

IOverlayManagerBackground

Marker interface for overlay manager background elements.

IOverlayManagerElement

Interface for overlay manager elements that can be rendered on video.

IVideoEditXVideoEffect

Interface for video effects that can be used in VideoEditX.

Enums

ChromaKeyColor

Chroma key color options.

ColorEffectsPreset

Color effects preset.

DeinterlaceFieldLayout

Deinterlace field layout.

DeinterlaceFields

Deinterlace fields.

DeinterlaceLocking

Deinterlace locking mode.

DeinterlaceMethods

Deinterlace methods.

DeinterlaceMode

Deinterlace mode.

FontStretch

The width of the font relative to other designs within a family.

FontStyle

Font style.

FontWeight

Font weight constants.

InterlacePattern

Interlace pattern.

LUTInterpolationMode

Specifies the method used for interpolating values between defined points in a 3D space. Each method offers different trade-offs between computational complexity, accuracy, and smoothness.

MirrorMode

Mirror mode.

MovingBlurColor

Moving blur effect color.

MovingBlurMode

Moving blur effect mode.

OpticalAnimationBWMode

Optical animation mode.

OverlayManagerFadeType

Type of fade effect.

OverlayManagerImageStretchMode

Defines the stretch modes for overlay manager images.

OverlayManagerInterpolationMode

Interpolation modes for scaling video content in overlay manager effects. These modes determine the quality and performance trade-offs when resizing or transforming video content.

OverlayManagerPanEasing

Easing functions for pan animation.

RippleMode

Ripple mode.

SMPTETransitionType

SMPTE transition types for professional video wipe effects. These values correspond exactly to the GStreamer SMPTE transition types. Values and descriptions are from the official GStreamer documentation.

ScrollDirection

Specifies the direction of scrolling for scrolling text overlays.

TextOverlayHAlign

Horizontal alignment of the text.

TextOverlayLineAlign

Alignment of text lines relative to each other.

TextOverlayMode

Text overlay mode.

TextOverlayVAlign

Vertical alignment of the text.

TextOverlayWrapMode

Whether to wrap the text and if so how.

VideoBoxFill

Enum VideoBoxFill.

VideoEffectID

Video effect ID.

VideoFlipRotateMethod

Video flip/rotate method.

VideoMixerBackground

Video mixer background mode.

VideoScaleMethod

The video scale method.