FSubmixEffectConvolutionReverb

Audio render thread effect object.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

FSoundEffectBase

FSoundEffectSubmix

FSubmixEffectConvolutionReverb

References

Module

Synthesis

Header

/Engine/Plugins/Runtime/Synthesis/Source/Synthesis/Classes/SubmixEffects/SubmixEffectConvolutionReverb.h

Include

#include "SubmixEffects/SubmixEffectConvolutionReverb.h"

Syntax

class FSubmixEffectConvolutionReverb : public FSoundEffectSubmix

Remarks

Audio render thread effect object.

Constructors

Name Description

Public function

FSubmixEffectConvolutionReverb()

Public function

FSubmixEffectConvolutionReverb

(
    const USubmixEffectConvolutionRever...
)

Construct a convolution object with an existing preset.

Destructors

Functions

Name Description

Public function

Audio::FConv...

 

CreateConvolutionReverbInitData()

Returns the data needed to build a convolution reverb.

Public function Const

Audio::FConv...

 

GetParameters()

Public function

void

 

SetConvolutionReverbIfCurrent

(
    TUniquePtr< Audio::FConvolutionReve...,
    const FVersionData& InVersionData
)

Sets the convolution algorithm object used if the version data matches the most up-to-date version data tracked within this object.

Public function

FVersionData

 

UpdateConvolutionReverb

(
    const USubmixEffectConvolutionRever...
)

Call on the game thread in order to update the impulse response and hardware acceleration used in this submix effect.

Overridden from FSoundEffectSubmix

Name Description

Public function Virtual

void

 

Init

(
    const FSoundEffectSubmixInitData& ...
)

Called on an audio effect at initialization on main thread before audio processing begins.

Public function Virtual

void

 

OnProcessAudio

(
    const FSoundEffectSubmixInputData&...,
    FSoundEffectSubmixOutputData& OutD...
)

Process the input block of audio. Called on audio thread.

Overridden from FSoundEffectBase

Name Description

Public function Virtual

void

 

OnPresetChanged()

Called when an audio effect preset settings is changed.

Classes

Name

Description

Public struct

FVersionData

Data used to track versions of current running convolution.

Typedefs

Name

Description

FConvolutionReverbID