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

FSoundEffectSubmix

Windows

MacOS

Linux

Inheritance Hierarchy

FSoundEffectBase

FSoundEffectSubmix

	FSubmixEffectConvolutionReverb
	FSubmixEffectDelay
	FSubmixEffectDynamicsProcessor
	FSubmixEffectFilter
	FSubmixEffectFlexiverb
	FSubmixEffectMultibandCompressor
	FSubmixEffectReverb
	FSubmixEffectStereoDelay
	FSubmixEffectSubmixEQ
	FSubmixEffectTapDelay

References

Module	Engine
Header	/Engine/Source/Runtime/Engine/Classes/Sound/SoundEffectSubmix.h
Include	#include "Sound/SoundEffectSubmix.h"

Syntax

class FSoundEffectSubmix : public FSoundEffectBase

Constructors

	Name	Description
	FSoundEffectSubmix()

Destructors

	Name	Description
	~FSoundEffectSubmix()

Functions

	Name	Description
uint32	GetDesiredInputChannelCountOverride()	Override to down mix input audio to a desired channel count.
float	GetDryLevel()	Allow effects to supply a drylevel.
const FSound...	GetInitData()	Returns the data that was given to the source effect when initialized.
void	OnProcessAudio ( const FSoundEffectSubmixInputData&..., FSoundEffectSubmixOutputData& OutD... )	Process the input block of audio. Called on audio thread.
void	ProcessAudio ( FSoundEffectSubmixInputData& InDat..., FSoundEffectSubmixOutputData& OutD... )	Processes audio in the submix effect.
bool	SetParameters ( const FAudioEffectParameters& InPa... )	Provided for interpolating parameters from audio volume system, enabling transition between various settings.
void	Setup ( const FSoundEffectSubmixInitData& ... )	Called by the audio engine or systems internally. This function calls the virtual Init function implemented by derived classes.
bool	SupportsDefaultEQ()	Whether or not effect supports default EQ system.
bool	SupportsDefaultReverb()	Whether or not effect supports default reverb system.
void	Tick()	Called on game thread to allow submix effect to query game data if needed.

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

Take our survey

Dismiss