Table of Contents

Class ImageOverlayCairoVideoEffect

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

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.

public class ImageOverlayCairoVideoEffect : BaseVideoEffect, IBaseVideoEffect, IVideoEditXVideoEffect

Inheritance

Implements

Inherited Members

Constructors

ImageOverlayCairoVideoEffect(string, string)

Initializes a new instance of the VisioForge.Core.Types.X.VideoEffects.ImageOverlayCairoVideoEffect class. Creates a Cairo-based overlay effect with the specified image file.

public ImageOverlayCairoVideoEffect(string filename, string name = "image-overlay-cairo")

Parameters

filename string

The path to the image file to overlay (supports PNG, JPEG, BMP, and other common formats).

name string

The unique name for this effect instance. Defaults to "image-overlay-cairo".

Fields

DefaultName

The default name for Cairo-based image overlay effects.

public static string DefaultName

Field Value

string

Properties

Alpha

Gets or sets the alpha transparency value [0.0-1.0]. 0.0 is fully transparent, 1.0 is fully opaque. Cairo provides smooth alpha blending for professional-quality overlays.

public double Alpha { get; set; }

Property Value

double

Filename

Gets or sets the file name of the image to overlay. Changing this property will immediately update the overlay if the effect is active.

public string Filename { get; set; }

Property Value

string

Height

Gets or sets the height of the overlay image. Set to 0 to use the original image height.

public int Height { get; set; }

Property Value

int

StartTime

Gets or sets the start time for the overlay effect. The overlay will not be visible before this time.

public TimeSpan StartTime { get; set; }

Property Value

TimeSpan

StopTime

Gets or sets the stop time for the overlay effect. The overlay will not be visible after this time.

public TimeSpan StopTime { get; set; }

Property Value

TimeSpan

Width

Gets or sets the width of the overlay image. Set to 0 to use the original image width.

public int Width { get; set; }

Property Value

int

X

Gets or sets the X coordinate position of the overlay on the video frame. The coordinate system starts at the top-left corner (0,0).

public int X { get; set; }

Property Value

int

Y

Gets or sets the Y coordinate position of the overlay on the video frame. The coordinate system starts at the top-left corner (0,0).

public int Y { get; set; }

Property Value

int

Methods

GenerateDescription()

Generates the GStreamer element description for the Cairo overlay effect. This method creates a cairooverlay element configuration string with all current settings.

public string GenerateDescription()

Returns

string

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