Table of Contents

Interface IEchoCanceller

Namespace
VAST.Audio
Assembly
VAST.Common.dll

Defines an interface for acoustic echo cancellation in audio processing pipelines.

public interface IEchoCanceller : IDisposable
Inherited Members

Properties

CancellationLevel

Gets or sets the cancellation level. The higher the value the bigger cancellation effect. It can be updated after processing has been started. Expected range is [0..4].

int CancellationLevel { get; set; }

Property Value

int

CaptureMediaType

Gets or sets media type of capture samples.

MediaType CaptureMediaType { get; set; }

Property Value

MediaType

Delay

Gets or sets optional external estimate of the audio buffer delay including both render and capture delays.

long Delay { get; set; }

Property Value

long

IsReady

Gets whether echo canceller is completely initialized and ready for processing. AnalyzeRender and ProcessCapture should only be called when IsReady is true.

bool IsReady { get; }

Property Value

bool

RenderMediaType

Gets or sets media type of render samples.

MediaType RenderMediaType { get; set; }

Property Value

MediaType

Methods

AnalyzeRender(VersatileBuffer)

Analyzes (no changes) the render signal. Should only be called when IsReady is true.

void AnalyzeRender(VersatileBuffer sample)

Parameters

sample VersatileBuffer

Render sample

ProcessCapture(VersatileBuffer)

Processes the capture signal in order to remove the echo. Should only be called when IsReady is true.

VersatileBuffer ProcessCapture(VersatileBuffer sample)

Parameters

sample VersatileBuffer

Captured sample

Returns

VersatileBuffer