FConvolutionReverb

[FConvolutionReverb](API\Plugins\Synthesis\FConvolutionReverb) applies an impulse response to audio.

Windows
MacOS
Linux

References

Module

Synthesis

Header

/Engine/Plugins/Runtime/Synthesis/Source/Synthesis/Public/ConvolutionReverb.h

Include

#include "ConvolutionReverb.h"

Syntax

class FConvolutionReverb

Remarks

FConvolutionReverb applies an impulse response to audio.

The audio pipeline within an FConvolutionReverb is described in ascii art here. 

    |
    v
    |
    v
    |
    v
    |
    v
    |
    v
    |
    v

Constructors

No constructors are accessible with public or protected access.

Functions

Name Description

Public function Static

TUniquePtr< ...

 

CreateConvolutionReverb

(
    const FConvolutionReverbInitData& ...,
    const FConvolutionReverbSettings& ...
)

Create a convolution reverb object.

Public function Static

void

 

DeinterleaveBuffer

(
    TArray< AlignedFloatBuffer >& Outp...,
    TArrayView< const float > InputBuff...,
    const int32 NumChannels
)

Public function Const

int32

 

GetNumInputChannels()

Public function Const

int32

 

GetNumOutputChannels()

Public function Const

const FConvo...

 

GetSettings()

Public function Static

void

 

InterleaveBuffer

(
    AlignedFloatBuffer& OutBuffer,
    const TArray< AlignedFloatBuffer > ...,
    const int32 NumChannels
)

Public function

void

 

ProcessAudio

(
    int32 InNumInputChannels,
    AlignedFloatBuffer& InputAudio,
    int32 InNumOutputChannels,
    AlignedFloatBuffer& OutputAudio
)

If the number of input frames changes between callbacks, the output may contain discontinuities.

Public function

void

 

SetSettings

(
    const FConvolutionReverbSettings& ...
)

Typedefs

Name

Description

FInputFormat

FOutputFormat
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss