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

> Unreal Engine API Reference > Runtime > AudioMixer > SubmixEffects > FSubmixEffectDynamicsProcessorSettings

Light Theme

Dark Theme

FSubmixEffectDynamicsProcessorSettings

Submix dynamics processor settings.

Windows

MacOS

Linux

References

Module	AudioMixer
Header	/Engine/Source/Runtime/AudioMixer/Classes/SubmixEffects/AudioMixerSubmixEffectDynamicsProcessor.h
Include	#include "SubmixEffects/AudioMixerSubmixEffectDynamicsProcessor.h"

Syntax

struct FSubmixEffectDynamicsProcessorSettings

Remarks

Submix dynamics processor settings.

Variables

	Name	Description
float	AttackTimeMsec	The amount of time to ramp into any dynamics processing effect.
uint8: 1	bAnalogMode	Toggles treating the attack and release envelopes as analog-style vs digital-style (Analog will respond a bit more naturally/slower)
uint8: 1	bBypass	Whether or not to bypass effect.
uint8: 1	bKeyAudition	Audition the key modulation signal, bypassing enveloping and processing the input signal.
	ClampMax
	ClampMin
	DisplayName	Gain to apply to key signal if key source not set to default (input).
ESubmixEffectDy...	DynamicsProcessorType	Type of processor to apply.
	EditCondition	The dynamics processor ratio used for compression/expansion.
UAudioBus *	ExternalAudioBus	If set, uses output of provided audio bus as modulator of input signal for dynamics processor (Uses input signal as default modulator)
USoundSubmix &#...	ExternalSubmix	If set, uses output of provided submix as modulator of input signal for dynamics processor (Uses input signal as default modulator)
float	InputGainDb	The input gain of the dynamics processor.
FSubmixEffectDy...	KeyHighshelf	High Shelf filter settings for key signal (external signal if supplied or input signal if not)
FSubmixEffectDy...	KeyLowshelf	Low Shelf filter settings for key signal (external signal if supplied or input signal if not)
ESubmixEffectDy...	KeySource
float	KneeBandwidthDb	The knee bandwidth of the processor to use.
ESubmixEffectDy...	LinkMode	Mode of peak detection if key signal is multi-channel.
float	LookAheadMsec	The amount of time to look ahead of the current audio (Allows for transients to be included in dynamics processing)
float	OutputGainDb	The output gain of the dynamics processor.
ESubmixEffectDy...	PeakMode	Mode of peak detection used on input key signal.
float	ReleaseTimeMsec	The amount of time to release the dynamics processing effect.
float	ThresholdDb	The threshold at which to perform a dynamics processing operation.
	UIMax
	UIMin

Constructors

	Name	Description
	FSubmixEffectDynamicsProcessorSettings()

Deprecated Variables

		Name	Description
	uint8: 1	bChannelLinked_DEPRECATED

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

Take our survey

Dismiss