FAcousticEchoCancellation

This class uses an adaptive filter to cancel out any rendered audio signal that might be picked up by the mic.

Windows
MacOS
Linux

References

Module

SignalProcessing

Header

/Engine/Source/Runtime/SignalProcessing/Public/DSP/VoiceProcessing.h

Include

#include "DSP/VoiceProcessing.h"

Syntax

class FAcousticEchoCancellation

Remarks

This class uses an adaptive filter to cancel out any rendered audio signal that might be picked up by the mic. To add a new patch to a rendered audio signal, user AddNewSignalPatch. See FPatchInput for how to push audio. ProcessAudio then filters the microphone signal accordingly.

Constructors

Name Description

Public function

FAcousticEchoCancellation

(
    float InConvergenceRate,
    int32 CallbackSize,
    int32 InFilterLength,
    int32 InFilterUpdateRate
)

Convergence Rate should be a number between 0 and 1.

Functions

Name Description

Public function

FPatchInput

 

AddNewSignalPatch

(
    int32 ExpectedLatency,
    float Gain
)

This is how any signal that may be picked up by the microphone may be added to the echo cancellation here:

Public function

void

 

ProcessAudio

(
    float* InAudio,
    int32 NumSamples
)

Callback function for outgoing audio signal.

Public function

void

 

RemoveSignalPatch

(
    const FPatchInput& Patch
)
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss