FSubmixEffectDynamicsProcessorSettings

Submix dynamics processor settings.

Choose your operating system:

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

Public variable

float

 

AttackTimeMsec

The amount of time to ramp into any dynamics processing effect.

Public variable

uint8: 1

 

bAnalogMode

Toggles treating the attack and release envelopes as analog-style vs digital-style (Analog will respond a bit more naturally/slower)

Public variable

uint8: 1

 

bBypass

Whether or not to bypass effect.

Public variable

uint8: 1

 

bKeyAudition

Audition the key modulation signal, bypassing enveloping and processing the input signal.

Public variable

 

ClampMax

Public variable

 

ClampMin

Public variable

 

DisplayName

Gain to apply to key signal if key source not set to default (input).

Public variable

ESubmixEffectDy...

 

DynamicsProcessorType

Type of processor to apply.

Public variable

 

EditCondition

The dynamics processor ratio used for compression/expansion.

Public variable

TObjectPtr< UAu...

 

ExternalAudioBus

If set, uses output of provided audio bus as modulator of input signal for dynamics processor (Uses input signal as default modulator)

Public variable

TObjectPtr< USo...

 

ExternalSubmix

If set, uses output of provided submix as modulator of input signal for dynamics processor (Uses input signal as default modulator)

Public variable

float

 

InputGainDb

The input gain of the dynamics processor.

Public variable

FSubmixEffectDy...

 

KeyHighshelf

High Shelf filter settings for key signal (external signal if supplied or input signal if not)

Public variable

FSubmixEffectDy...

 

KeyLowshelf

Low Shelf filter settings for key signal (external signal if supplied or input signal if not)

Public variable

ESubmixEffectDy...

 

KeySource

Public variable

float

 

KneeBandwidthDb

The knee bandwidth of the processor to use.

Public variable

ESubmixEffectDy...

 

LinkMode

Mode of peak detection if key signal is multi-channel.

Public variable

float

 

LookAheadMsec

The amount of time to look ahead of the current audio (Allows for transients to be included in dynamics processing)

Public variable

float

 

OutputGainDb

The output gain of the dynamics processor.

Public variable

ESubmixEffectDy...

 

PeakMode

Mode of peak detection used on input key signal.

Public variable

float

 

ReleaseTimeMsec

The amount of time to release the dynamics processing effect.

Public variable

float

 

ThresholdDb

The threshold at which to perform a dynamics processing operation.

Public variable

 

UIMax

Public variable

 

UIMin

Constructors

Deprecated Variables

Name Description

Public variable

uint8: 1

 

bChannelLinked_DEPRECATED