Table of Contents

Class WavescopeBlock

Namespace
VisioForge.Core.MediaBlocks.AudioVisualizers
Assembly
VisioForge.Core.dll

Wavescope audio visualizer block that creates an oscilloscope-style waveform visualization of audio.

public class WavescopeBlock : MediaBlock, IMediaBlock, IDisposable, IMediaBlockInternals

Inheritance

Implements

Inherited Members

Extension Methods

Remarks

The Wavescope visualizer displays the audio waveform in real-time, similar to an oscilloscope:

  • Shows the amplitude of the audio signal over time
  • Displays waveform shape that represents the actual audio samples
  • Can show both channels of stereo audio either combined or separately
  • Useful for monitoring audio levels, clipping detection, and waveform analysis This is the most basic and direct visualization of audio signals.

Constructors

WavescopeBlock(WavescopeSettings)

Initializes a new instance of the VisioForge.Core.MediaBlocks.AudioVisualizers.WavescopeBlock class.

public WavescopeBlock(WavescopeSettings settings)

Parameters

settings WavescopeSettings

The settings to configure the wavescope visualization appearance and behavior.

Properties

Input

Gets the primary input pad for audio data.

public override MediaBlockPad Input { get; }

Property Value

MediaBlockPad

Inputs

Gets all input pads available on this block.

public override MediaBlockPad[] Inputs { get; }

Property Value

MediaBlockPad[]

Output

Gets the primary output pad for video data.

public override MediaBlockPad Output { get; }

Property Value

MediaBlockPad

Outputs

Gets all output pads available on this block.

public override MediaBlockPad[] Outputs { get; }

Property Value

MediaBlockPad[]

Settings

Gets or sets the settings that configure the wavescope visualization appearance and behavior.

public WavescopeSettings Settings { get; set; }

Property Value

WavescopeSettings

Type

Gets the media block type.

public override MediaBlockType Type { get; }

Property Value

MediaBlockType

Methods

Build()

Builds and initializes the wavescope visualization block.

public override bool Build()

Returns

bool

true if the block was successfully built and configured; false if an error occurred.

Remarks

This method creates the underlying GStreamer waveform visualization elements, configures the visualization settings, and establishes the input/output pads for audio/video data flow.

CleanUp()

Cleans up and releases all resources used by the wavescope block.

public void CleanUp()

Remarks

This method disposes of the underlying GStreamer elements and resets the build state.

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 GStreamer base element wrapped by this block.

public BaseElement GetCore()

Returns

BaseElement

The underlying VisioForge.Core.GStreamer.Base.BaseElement instance.

GetElement()

Gets the raw GStreamer element for advanced manipulation.

public Element GetElement()

Returns

Element

The native GStreamer Gst.Element instance.

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)

Sets the media pipeline context for this block.

void IMediaBlockInternals.SetContext(MediaBlocksPipeline pipeline)

Parameters

pipeline MediaBlocksPipeline

The parent media pipeline that will contain this block.

See Also