Table of Contents

Class SVGOverlayBlock

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

SVG overlay block for rendering scalable vector graphics on video content. This block overlays SVG (Scalable Vector Graphics) images or animations onto video streams, providing resolution-independent graphics perfect for logos, animated graphics, diagrams, and dynamic visual elements. Features include positioning, scaling, opacity control, and support for animated SVG content. Essential for broadcast graphics, watermarking, infographics, animated overlays, and any application requiring high-quality vector graphics overlaid on video content. Implements the VisioForge.Core.MediaBlocks.MediaBlock. Implements the VisioForge.Core.MediaBlocks.IMediaBlockInternals. Implements the IDisposable.

public class SVGOverlayBlock : MediaBlock, IMediaBlock, IDisposable, IMediaBlockInternals

Inheritance

Implements

Inherited Members

Extension Methods

Constructors

SVGOverlayBlock(SVGOverlayVideoEffect)

Initializes a new instance of the VisioForge.Core.MediaBlocks.VideoProcessing.SVGOverlayBlock class with specified SVG overlay settings.

public SVGOverlayBlock(SVGOverlayVideoEffect settings)

Parameters

settings SVGOverlayVideoEffect

The SVG overlay 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 the SVG overlay settings. Contains the SVG file path or content, positioning, scaling, opacity, and other properties controlling the vector graphics overlay.

public SVGOverlayVideoEffect Settings { get; }

Property Value

SVGOverlayVideoEffect

Type

Gets the type.

public override MediaBlockType Type { get; }

Property Value

MediaBlockType

Methods

Build()

Constructs and initializes the SVG overlay filter and its associated GStreamer elements. This method creates the filter with the specified settings, establishes input and output pads, and prepares the block for rendering scalable vector graphics on video content.

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 SVG overlay 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 SVG overlay filter element.

public BaseElement GetCore()

Returns

BaseElement

The BaseElement wrapper instance that encapsulates the GStreamer SVG overlay filter.

GetElement()

Gets the underlying GStreamer element that performs the SVG rendering and overlay.

public Element GetElement()

Returns

Element

The GStreamer Element instance representing the SVG overlay 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 SVG overlay 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