Table of Contents

Class WebMOutputBlock

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

WebM multimedia container output block for creating modern web-optimized video files with integrated encoding capabilities. Provides comprehensive WebM file creation with VP8/VP9 video encoding and Vorbis audio compression optimized for web streaming, HTML5 video playback, and browser compatibility with royalty-free codec support for modern web applications and content delivery. Implements the VisioForge.Core.MediaBlocks.MediaBlock. Implements the VisioForge.Core.MediaBlocks.IMediaBlockInternals. Implements the IDisposable.

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

Inheritance

Implements

Inherited Members

Extension Methods

Constructors

WebMOutputBlock(WebMSinkSettings, IVPXEncoderSettings, VorbisEncoderSettings)

Initializes a new instance of the VisioForge.Core.MediaBlocks.Sinks.WebMOutputBlock class with custom VP8/VP9 and Vorbis encoder settings. Provides full control over video and audio compression parameters for professional WebM file creation optimized for web delivery.

public WebMOutputBlock(WebMSinkSettings sinkSettings, IVPXEncoderSettings videoEncoderSettings, VorbisEncoderSettings vorbisSettings)

Parameters

sinkSettings WebMSinkSettings

The WebM container sink settings defining output file configuration and metadata options.

videoEncoderSettings IVPXEncoderSettings

The VP8/VP9 video encoder settings controlling video compression quality and web optimization parameters.

vorbisSettings VorbisEncoderSettings

The Vorbis audio encoder settings controlling audio compression quality and web streaming 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 WebM output operations.

public override MediaBlockType Type { get; }

Property Value

MediaBlockType

Methods

Build()

Builds and initializes the WebM output block within the pipeline context. Creates the WebM sink, VP8/VP9 and Vorbis encoders, and establishes all necessary connections for encoding and writing multimedia content to the WebM file.

public override bool Build()

Returns

bool

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

CleanUp()

Cleans up all resources associated with the WebM 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 WebM 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 WebM content is being written.

public string GetFilenameOrURL()

Returns

string

The file path or URL string for the WebM 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(IVPXEncoderSettings)

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

public static bool IsAvailable(IVPXEncoderSettings videoEncoderSettings)

Parameters

videoEncoderSettings IVPXEncoderSettings

The VP8/VP9 video encoder settings to validate for availability.

Returns

bool

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

SetFilenameOrURL(string)

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

public void SetFilenameOrURL(string value)

Parameters

value string

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

IMediaBlockInternals.SetContext(MediaBlocksPipeline)

Sets the pipeline context for this WebM 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 WebM output block.

See Also