Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

Light Theme

Dark Theme

FSubmixEffectConvolutionReverb

Audio render thread effect object.

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
	FSubmixEffectConvolutionReverb()
	FSubmixEffectConvolutionReverb ( const USubmixEffectConvolutionRever... )	Construct a convolution object with an existing preset.

Destructors

	Name	Description
	~FSubmixEffectConvolutionReverb()

Functions

	Name	Description
FConvolution...	GetConvolutionAlgorithmInitData()	Returns the data needed to build a convolution algorithm.
void	SetConvolutionAlgorithmIfCurrent ( TUniquePtr< Audio::IConvolutionAlgo..., 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.
FVersionData	UpdateConvolutionAlgorithm ( 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
uint32	GetDesiredInputChannelCountOverride()	We want to receive down-mixed submix audio to stereo input for the reverb effect.
void	Init ( const FSoundEffectSubmixInitData& ... )	Called on an audio effect at initialization on main thread before audio processing begins.
void	OnProcessAudio ( const FSoundEffectSubmixInputData&..., FSoundEffectSubmixOutputData& OutD... )	Process the input block of audio. Called on audio thread.

Overridden from FSoundEffectBase

		Name	Description
	void	OnPresetChanged()	Called when an audio effect preset settings is changed.

Classes

	Name	Description
	FConvolutionAlgorithmInitData	Data used to initialize the convolution algorithm.
	FConvolutionGainEntry	Gain entry into convolution matrix.
	FVersionData	Data used to track versions of current running convolution.

Typedefs

Name	Description
FConvolutionAlgorithmID

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

Take our survey

Dismiss