Table of Contents

Class MKVOutputBlock

Namespace
VisioForge.Core.MediaBlocks.Sinks
Assembly
VisioForge.Core.dll

MKV (Matroska Video) multimedia container output block for creating versatile video files with advanced encoding capabilities. Provides comprehensive MKV file creation with support for multiple video encoders (H.264, HEVC, VP8/VP9, AV1) and audio encoders (AAC, MP3, Vorbis, OPUS, Speex) for professional video production, streaming content preparation, and multimedia archival storage with industry-leading container format flexibility. Implements the VisioForge.Core.MediaBlocks.MediaBlock. Implements the VisioForge.Core.MediaBlocks.IMediaBlockInternals. Implements the IDisposable.

public class MKVOutputBlock : MediaBlock, IMediaBlock, IDisposable, IMediaBlockInternals, IMediaBlockDynamicInputs

Inheritance

Implements

Inherited Members

Extension Methods

Constructors

MKVOutputBlock(MKVSinkSettings, IVideoEncoder, IAudioEncoder)

Initializes a new instance of the VisioForge.Core.MediaBlocks.Sinks.MKVOutputBlock class with custom video and audio encoder settings. Provides full control over video and audio compression parameters for professional MKV file creation.

public MKVOutputBlock(MKVSinkSettings sinkSettings, IVideoEncoder videoSettings, IAudioEncoder audioSettings)

Parameters

sinkSettings MKVSinkSettings

The MKV container sink settings defining output file configuration.

videoSettings IVideoEncoder

The video encoder settings controlling video compression quality and parameters.

audioSettings IAudioEncoder

The audio encoder settings controlling audio compression quality and parameters.

Properties

Input

Gets the primary input pad (first in the collection of dynamic inputs).

public override MediaBlockPad Input { get; }

Property Value

MediaBlockPad

Inputs

Gets all input pads available on this block (dynamic collection for video and audio).

public override MediaBlockPad[] Inputs { get; }

Property Value

MediaBlockPad[]

Output

Gets the primary output pad (none for output blocks that write to files).

public override MediaBlockPad Output { get; }

Property Value

MediaBlockPad

Outputs

Gets all output pads available on this block (none for output blocks).

public override MediaBlockPad[] Outputs { get; }

Property Value

MediaBlockPad[]

Type

Gets the media block type identifier for MKV output operations.

public override MediaBlockType Type { get; }

Property Value

MediaBlockType

Methods

Build()

Builds and initializes the MKV output block within the pipeline context. Creates the MKV sink, video and audio encoders, and establishes all necessary connections for encoding and writing multimedia content to the MKV file.

public override bool Build()

Returns

bool

true if the MKV output block was successfully built and configured; otherwise, false.

CleanUp()

Cleans up all resources associated with the MKV output operations, including encoders, sink, and file handles.

public void CleanUp()

CreateNewInput(MediaBlockPadMediaType)

Creates a new input pad for the specified media type, enabling dynamic addition of video and audio streams.

public MediaBlockPad CreateNewInput(MediaBlockPadMediaType mediaType)

Parameters

mediaType MediaBlockPadMediaType

The type of media (Video, Audio, or Subtitle) for the new input pad.

Returns

MediaBlockPad

A new MediaBlockPad configured for the specified media type.

Dispose(bool)

Releases unmanaged and managed resources used by the MKV output block. Properly disposes of GStreamer elements, encoders, and file writing 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 GStreamer element wrapper for advanced configuration and monitoring.

public BaseElement GetCore()

Returns

BaseElement

Always null for composite output blocks with multiple internal elements.

GetElement()

Gets the native GStreamer element for direct GStreamer pipeline integration.

public Element GetElement()

Returns

Element

Always null for composite output blocks with multiple internal elements.

GetFilenameOrURL()

Gets the current output filename or URL where the MKV content is being written.

public string GetFilenameOrURL()

Returns

string

The file path or URL string for the MKV output destination.

GetInput(MediaBlockPadMediaType)

Retrieves an existing input pad for the specified media type from the current collection.

public MediaBlockPad GetInput(MediaBlockPadMediaType mediaType)

Parameters

mediaType MediaBlockPadMediaType

The type of media (Video, Audio, or Subtitle) to search for.

Returns

MediaBlockPad

The first matching MediaBlockPad for the specified media type, or null if not found.

IsAvailable(IH264EncoderSettings, IAACEncoderSettings)

Determines whether MKV output functionality is available on the current system with the specified encoder settings. Requires GStreamer MKV muxer and the specified video and audio encoder plugins to be installed and functional.

public static bool IsAvailable(IH264EncoderSettings h264settings, IAACEncoderSettings aacSettings)

Parameters

h264settings IH264EncoderSettings

The H.264 video encoder settings to validate for availability.

aacSettings IAACEncoderSettings

The AAC audio encoder settings to validate for availability.

Returns

bool

true if MKV output with the specified encoders is supported; otherwise, false.

SetFilenameOrURL(string)

Updates the output filename or URL for the MKV file destination, allowing dynamic output redirection.

public void SetFilenameOrURL(string value)

Parameters

value string

The new file path or URL where MKV content should be written.

IMediaBlockInternals.SetContext(MediaBlocksPipeline)

Sets the pipeline context for this MKV output block, providing access to the parent pipeline and logging context.

void IMediaBlockInternals.SetContext(MediaBlocksPipeline pipeline)

Parameters

pipeline MediaBlocksPipeline

The parent MediaBlocks pipeline containing this MKV output block.

See Also