Table of Contents

Class WMAEncoderBlock

Namespace
VisioForge.Core.MediaBlocks.AudioEncoders
Assembly
VisioForge.Core.dll

MediaBlock that encodes raw audio into WMA (Windows Media Audio) format. WMA is Microsoft's proprietary lossy audio compression format that offers good compression efficiency and quality. The format supports variable bitrate encoding, lossless compression modes, and advanced features like digital rights management (DRM). WMA is widely supported on Windows platforms and provides excellent integration with Microsoft's media ecosystem, making it suitable for Windows-based applications and Windows Media streaming. Implements the VisioForge.Core.MediaBlocks.MediaBlock. Implements the VisioForge.Core.MediaBlocks.IMediaBlockInternals. Implements the IDisposable.

public class WMAEncoderBlock : MediaBlock, IMediaBlock, IDisposable, IMediaBlockInternals

Inheritance

Implements

Inherited Members

Extension Methods

Constructors

WMAEncoderBlock(WMAEncoderSettings)

Initializes a new instance of the VisioForge.Core.MediaBlocks.AudioEncoders.WMAEncoderBlock class with the specified encoding settings.

public WMAEncoderBlock(WMAEncoderSettings settings)

Parameters

settings WMAEncoderSettings

The WMAEncoderSettings that define bitrate, quality, and Windows Media-specific encoding behavior.

Properties

Input

Gets the single audio input pad for this encoder block.

public override MediaBlockPad Input { get; }

Property Value

MediaBlockPad

Inputs

Gets all input pads for this encoder block.

public override MediaBlockPad[] Inputs { get; }

Property Value

MediaBlockPad[]

Output

Gets the single audio output pad for this encoder block.

public override MediaBlockPad Output { get; }

Property Value

MediaBlockPad

Outputs

Gets all output pads for this encoder block.

public override MediaBlockPad[] Outputs { get; }

Property Value

MediaBlockPad[]

Settings

Gets or sets the WMA encoder settings that control compression quality and Microsoft-specific features. These settings include bitrate mode, quality level, and WMA-specific encoding parameters optimized for Windows Media applications and streaming scenarios.

public WMAEncoderSettings Settings { get; set; }

Property Value

WMAEncoderSettings

Type

Gets the MediaBlock type identifier for this encoder.

public override MediaBlockType Type { get; }

Property Value

MediaBlockType

Methods

Build()

Constructs and initializes the WMA encoder and its associated GStreamer elements. This method creates the encoder with the specified settings, establishes input and output pads, and prepares the block for Windows Media audio encoding.

public override bool Build()

Returns

bool

true if the encoder was successfully built and configured; false if initialization failed.

CleanUp()

Releases all resources and performs cleanup operations for this WMA encoder 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 WMA encoder element.

public BaseElement GetCore()

Returns

BaseElement

The BaseElement wrapper instance that encapsulates the GStreamer WMA encoder.

GetDefaultSettings()

Creates a new instance of WMAEncoderSettings with default values optimized for general-purpose encoding. These default settings provide a good balance between quality and file size for most Windows Media applications.

public static WMAEncoderSettings GetDefaultSettings()

Returns

WMAEncoderSettings

A WMAEncoderSettings instance configured with recommended default values for WMA encoding.

GetElement()

Gets the underlying GStreamer element that performs the WMA encoding.

public Element GetElement()

Returns

Element

The GStreamer Element instance representing the WMA encoder.

IsAvailable()

Determines whether the WMA encoder is available on the current system. This checks if the required Windows Media Format SDK and GStreamer WMA encoder plugin are installed and accessible. The correct NuGet SDK redistribution package should be included in your project.

public static bool IsAvailable()

Returns

bool

true if the WMA encoder is available and can be used; otherwise, false.

IMediaBlockInternals.SetContext(MediaBlocksPipeline)

Associates this WMA encoder 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