Table of Contents

Class VideoBoxBlock

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

Video box effect block for adding borders, letterboxing, and pillarboxing to video content. This block adds configurable borders around video content, enabling letterboxing (horizontal bars), pillarboxing (vertical bars), or custom border layouts. Features include adjustable border thickness on all sides, custom border colors, and automatic aspect ratio preservation. Essential for format adaptation, cinema-style letterboxing, broadcast safe areas, video composition layouts, and professional presentations requiring precise video framing. Implements the VisioForge.Core.MediaBlocks.MediaBlock. Implements the VisioForge.Core.MediaBlocks.IMediaBlockInternals. Implements the IDisposable.

public class VideoBoxBlock : MediaBlock, IMediaBlock, IDisposable, IMediaBlockInternals

Inheritance

Implements

Inherited Members

Extension Methods

Constructors

VideoBoxBlock(BoxVideoEffect)

Initializes a new instance of the VisioForge.Core.MediaBlocks.VideoProcessing.VideoBoxBlock class with specified video box settings.

public VideoBoxBlock(BoxVideoEffect settings)

Parameters

settings BoxVideoEffect

The video box 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 or sets the video box settings. Contains border thickness for each side, border color, and other properties controlling the box effect appearance.

public BoxVideoEffect Settings { get; set; }

Property Value

BoxVideoEffect

Type

Gets the type.

public override MediaBlockType Type { get; }

Property Value

MediaBlockType

Methods

Build()

Constructs and initializes the video box 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 adding borders, letterboxing, or pillarboxing to 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 video box 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 video box filter element.

public BaseElement GetCore()

Returns

BaseElement

The BaseElement wrapper instance that encapsulates the GStreamer video box filter.

GetElement()

Gets the underlying GStreamer element that performs the box border addition.

public Element GetElement()

Returns

Element

The GStreamer Element instance representing the video box 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 video box 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