Class RSAudioEchoBlock

Namespace

VisioForge.Core.MediaBlocks.AudioProcessing

Assembly

VisioForge.Core.dll

RS Audio Echo effect block using rsaudioecho from rsaudiofx plugin. Provides echo and reverb effects with configurable delay, intensity, and feedback parameters. Features precise control over echo characteristics for creating spatial effects, ambience, and classic echo sounds. Essential for audio enhancement and creative audio processing. Implements the VisioForge.Core.MediaBlocks.MediaBlock. Implements the VisioForge.Core.MediaBlocks.IMediaBlockInternals. Implements the IDisposable.

public class RSAudioEchoBlock : MediaBlock, IMediaBlock, IDisposable, IMediaBlockInternals

Inheritance

object

MediaBlock

RSAudioEchoBlock

Implements

IMediaBlock

IDisposable

IMediaBlockInternals

Inherited Members

MediaBlock._isBuilt

MediaBlock._pipeline

MediaBlock._pipelineCtx

MediaBlock.GetPipelineContext()

MediaBlock.SetPipelineContext(BlockPipelineContext)

MediaBlock.SetPipeline(MediaBlocksPipeline)

MediaBlock.Context

MediaBlock.Name

MediaBlock.IsBuilt

MediaBlock.Owner

MediaBlock.Type

MediaBlock.ID

MediaBlock.Input

MediaBlock.Inputs

MediaBlock.Output

MediaBlock.Outputs

MediaBlock.HasInputs

MediaBlock.HasOutputs

MediaBlock.Build()

MediaBlock.CreateElements()

MediaBlock.AddElementsToPipeline()

MediaBlock.RemoveElementsFromPipeline()

MediaBlock.DeepCopy(string)

MediaBlock.Reset()

MediaBlock.ToYAMLBlock()

MediaBlock.ClearPads()

MediaBlock.Dispose(bool)

MediaBlock.Dispose()

object.Equals(object?)

object.Equals(object?, object?)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object?, object?)

object.ToString()

Extension Methods

MediaBlockExtensions.GetInputPadByType(IMediaBlock, MediaBlockPadMediaType)

MediaBlockExtensions.GetOutputPadByType(IMediaBlock, MediaBlockPadMediaType)

MediaBlockHelper.SendEndOfStream(MediaBlock)

MediaBlockHelper.SendEvent(MediaBlock, Event)

MediaBlockHelper.SetState(MediaBlock, State)

Constructors

RSAudioEchoBlock()

Initializes a new instance of the VisioForge.Core.MediaBlocks.AudioProcessing.RSAudioEchoBlock class with default echo settings for general-purpose use.

public RSAudioEchoBlock()

Properties

Delay

Gets or sets the echo delay time between the original signal and its repetitions. Shorter delays create tight slapback effects, while longer delays produce distinct echoes. Typical values range from 50ms to 500ms. Default: 500ms.

public TimeSpan Delay { get; set; }

Property Value

TimeSpan

Feedback

Gets or sets the feedback amount that controls echo repetitions. Higher values create more repetitions with gradual decay, while lower values produce fewer repetitions. Values typically range from 0.0 to 0.9. Caution: Values close to 1.0 can create infinite feedback.

public double Feedback { get; set; }

Property Value

double

Input

Gets the input.

public override MediaBlockPad Input { get; }

Property Value

MediaBlockPad

Inputs

Gets the inputs.

public override MediaBlockPad[] Inputs { get; }

Property Value

MediaBlockPad[]

Intensity

Gets or sets the echo intensity determining the volume of the delayed signal. Values range from 0.0 (no echo) to 1.0 (full volume echo). Lower values create subtle echoes while higher values produce prominent effects.

public double Intensity { get; set; }

Property Value

double

MaxDelay

Gets or sets the maximum echo delay time that can be used. This value determines the internal buffer size and should be set higher than the actual delay to allow for real-time adjustments. Default: 1000ms.

public TimeSpan MaxDelay { get; set; }

Property Value

TimeSpan

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 RS audio echo filter and its associated GStreamer elements. This method creates the filter with the specified echo parameters, establishes input and output pads, and prepares the block for creating echo effects with configurable delay, intensity, and feedback.

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 RS audio echo effect 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 RS audio echo filter element.

public BaseElement GetCore()

Returns

BaseElement

The BaseElement wrapper instance that encapsulates the GStreamer RS audio echo filter.

GetElement()

Gets the underlying GStreamer element that performs the echo effect processing.

public Element GetElement()

Returns

Element

The GStreamer Element instance representing the RS audio echo 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 RS audio echo effect 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

MediaBlock

IMediaBlockInternals

IDisposable