Table of Contents

Class QRCodeOverlayBlock

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

QR code overlay block for embedding scannable QR codes directly onto video content. This block generates and overlays QR codes containing custom data such as URLs, text, contact information, or any encoded data. Features include configurable size, position, error correction levels, and transparency settings. Essential for marketing videos, educational content, interactive media, ticketing systems, and any application requiring embedded scannable information within video streams. Implements the VisioForge.Core.MediaBlocks.MediaBlock. Implements the VisioForge.Core.MediaBlocks.IMediaBlockInternals. Implements the IDisposable.

public class QRCodeOverlayBlock : MediaBlock, IMediaBlock, IDisposable, IMediaBlockInternals

Inheritance

Implements

Inherited Members

Extension Methods

Constructors

QRCodeOverlayBlock(string)

Initializes a new instance of the VisioForge.Core.MediaBlocks.VideoProcessing.QRCodeOverlayBlock class with the specified data to encode.

public QRCodeOverlayBlock(string data)

Parameters

data string

The data to encode in the QR code (URL, text, etc.).

Properties

Data

Gets the data to be encoded in the QR code. This can be any text data including URLs, plain text, contact information, WiFi credentials, or other structured data formats.

public string Data { get; }

Property Value

string

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[]

Type

Gets the type.

public override MediaBlockType Type { get; }

Property Value

MediaBlockType

Methods

Build()

Constructs and initializes the QR code overlay filter and its associated GStreamer elements. This method creates the filter with the specified data, establishes input and output pads, and prepares the block for generating and overlaying QR codes 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 QR code 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 QR code overlay filter element.

public BaseElement GetCore()

Returns

BaseElement

The BaseElement wrapper instance that encapsulates the GStreamer QR code overlay filter.

GetElement()

Gets the underlying GStreamer element that performs the QR code generation and overlay.

public Element GetElement()

Returns

Element

The GStreamer Element instance representing the QR code 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 QR code 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