1. Epic GamesDeveloper
  3. FSubmixEffectDynamicsProcessorSettings

FSubmixEffectDynamicsProcessorSettings

Submix dynamics processor settings.

API > API/Runtime > API/Runtime/AudioMixer

Submix dynamics processor settings.

   
Name FSubmixEffectDynamicsProcessorSettings
Type struct
Header File /Engine/Source/Runtime/AudioMixer/Classes/SubmixEffects/AudioMixerSubmixEffectDynamicsProcessor.h
Include Path #include "SubmixEffects/AudioMixerSubmixEffectDynamicsProcessor.h"

Syntax

USTRUCT (BlueprintType )  
struct FSubmixEffectDynamicsProcessorSettings

Constructors

Name Remarks Include Path Unreal Specifiers

FSubmixEffectDynamicsProcessorSettings()

   SubmixEffects/AudioMixerSubmixEffectDynamicsProcessor.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
AttackTimeMsec float The amount of time to ramp into any dynamics processing effect. SubmixEffects/AudioMixerSubmixEffectDynamicsProcessor.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Response
  • Meta=(DisplayName="AttackTime (ms)", ClampMin="1.0", ClampMax="300.0", UIMin="1.0", UIMax="200.0", EditCondition="!bBypass")
bAnalogMode uint8 Toggles treating the attack and release envelopes as analog-style vs digital-style (Analog will respond a bit more naturally/slower) SubmixEffects/AudioMixerSubmixEffectDynamicsProcessor.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Response
  • Meta=(EditCondition="!bBypass")
bBypass uint8 Whether or not to bypass effect. SubmixEffects/AudioMixerSubmixEffectDynamicsProcessor.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=General
  • Meta=(DisplayName="Bypass", DisplayAfter="DynamicsProcessorType")
bKeyAudition uint8 Audition the key modulation signal, bypassing enveloping and processing the input signal. SubmixEffects/AudioMixerSubmixEffectDynamicsProcessor.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Sidechain
  • Meta=(DisplayName="Key Audition", EditCondition="!bBypass")
ClampMax     SubmixEffects/AudioMixerSubmixEffectDynamicsProcessor.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Dynamics
  • Meta=(EditCondition="!bBypass && DynamicsProcessorType == ESubmixEffectDynamicsProcessorType::Compressor || DynamicsProcessorType == ESubmixEffectDynamicsProcessorType::Expander || DynamicsProcessorType == ESubmixEffectDynamicsProcessorType::UpwardsCompressor", ClampMin="1.0", ClampMax="20.0", UIMin="1.0", UIMax="20.0")
ClampMin     SubmixEffects/AudioMixerSubmixEffectDynamicsProcessor.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Dynamics
  • Meta=(EditCondition="!bBypass && DynamicsProcessorType == ESubmixEffectDynamicsProcessorType::Compressor || DynamicsProcessorType == ESubmixEffectDynamicsProcessorType::Expander || DynamicsProcessorType == ESubmixEffectDynamicsProcessorType::UpwardsCompressor", ClampMin="1.0", ClampMax="20.0", UIMin="1.0", UIMax="20.0")
DisplayName   Gain to apply to key signal if key source not set to default (input). SubmixEffects/AudioMixerSubmixEffectDynamicsProcessor.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Sidechain
  • Meta=(DisplayName="External Input Gain (dB)", EditCondition="!bBypass && KeySource != ESubmixEffectDynamicsKeySource::Default", UIMin="-60.0", UIMax="30.0")
DynamicsProcessorType ESubmixEffectDynamicsProcessorType Type of processor to apply. SubmixEffects/AudioMixerSubmixEffectDynamicsProcessor.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=General
  • Meta=(DisplayName="Type")
EditCondition   The dynamics processor ratio used for compression/expansion. SubmixEffects/AudioMixerSubmixEffectDynamicsProcessor.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Dynamics
  • Meta=(EditCondition="!bBypass && DynamicsProcessorType == ESubmixEffectDynamicsProcessorType::Compressor || DynamicsProcessorType == ESubmixEffectDynamicsProcessorType::Expander || DynamicsProcessorType == ESubmixEffectDynamicsProcessorType::UpwardsCompressor", ClampMin="1.0", ClampMax="20.0", UIMin="1.0", UIMax="20.0")
ExternalAudioBus TObjectPtr< UAudioBus > If set, uses output of provided audio bus as modulator of input signal for dynamics processor (Uses input signal as default modulator) SubmixEffects/AudioMixerSubmixEffectDynamicsProcessor.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Sidechain
  • Meta=(EditCondition="!bBypass && KeySource == ESubmixEffectDynamicsKeySource::AudioBus", EditConditionHides)
ExternalSubmix TObjectPtr< USoundSubmix > If set, uses output of provided submix as modulator of input signal for dynamics processor (Uses input signal as default modulator) SubmixEffects/AudioMixerSubmixEffectDynamicsProcessor.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Sidechain
  • Meta=(EditCondition="!bBypass && KeySource == ESubmixEffectDynamicsKeySource::Submix", EditConditionHides)
InputGainDb float The input gain of the dynamics processor. SubmixEffects/AudioMixerSubmixEffectDynamicsProcessor.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=General
  • Meta=(DisplayName="Input Gain (dB)", UIMin="-12.0", UIMax="20.0", EditCondition="!bBypass")
KeyHighshelf FSubmixEffectDynamicProcessorFilterSettings High Shelf filter settings for key signal (external signal if supplied or input signal if not) SubmixEffects/AudioMixerSubmixEffectDynamicsProcessor.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Sidechain
  • Meta=(DisplayName="Key Highshelf", EditCondition="!bBypass")
KeyLowshelf FSubmixEffectDynamicProcessorFilterSettings Low Shelf filter settings for key signal (external signal if supplied or input signal if not) SubmixEffects/AudioMixerSubmixEffectDynamicsProcessor.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Sidechain
  • Meta=(DisplayName="Key Lowshelf", EditCondition="!bBypass")
KeySource ESubmixEffectDynamicsKeySource   SubmixEffects/AudioMixerSubmixEffectDynamicsProcessor.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Sidechain
  • Meta=(EditCondition="!bBypass")
KneeBandwidthDb float The knee bandwidth of the processor to use. SubmixEffects/AudioMixerSubmixEffectDynamicsProcessor.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Dynamics
  • Meta=(DisplayName="Knee (dB)", ClampMin="0.0", ClampMax="20.0", UIMin="0.0", UIMax="20.0", EditCondition="!bBypass")
LinkMode ESubmixEffectDynamicsChannelLinkMode Mode of peak detection if key signal is multi-channel. SubmixEffects/AudioMixerSubmixEffectDynamicsProcessor.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Dynamics
  • Meta=(EditCondition="!bBypass")
LookAheadMsec float The amount of time to look ahead of the current audio (Allows for transients to be included in dynamics processing) SubmixEffects/AudioMixerSubmixEffectDynamicsProcessor.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Response
  • Meta=(DisplayName="Look Ahead (ms)", ClampMin="0.0", ClampMax="50.0", UIMin="0.0", UIMax="50.0", EditCondition="!bBypass")
OutputGainDb float The output gain of the dynamics processor. SubmixEffects/AudioMixerSubmixEffectDynamicsProcessor.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Output
  • Meta=(DisplayName="Output Gain (dB)", UIMin="-60.0", UIMax="30.0", EditCondition="!bBypass")
PeakMode ESubmixEffectDynamicsPeakMode Mode of peak detection used on input key signal. SubmixEffects/AudioMixerSubmixEffectDynamicsProcessor.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Dynamics
  • Meta=(EditCondition="!bBypass")
ReleaseTimeMsec float The amount of time to release the dynamics processing effect. SubmixEffects/AudioMixerSubmixEffectDynamicsProcessor.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Response
  • Meta=(DisplayName="Release Time (ms)", ClampMin="20.0", ClampMax="5000.0", UIMin="20.0", UIMax="5000.0", EditCondition="!bBypass")
ThresholdDb float The threshold at which to perform a dynamics processing operation. SubmixEffects/AudioMixerSubmixEffectDynamicsProcessor.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Dynamics
  • Meta=(DisplayName="Threshold (dB)", ClampMin="-60.0", ClampMax="0.0", UIMin="-60.0", UIMax="0.0", EditCondition="!bBypass")
UIMax     SubmixEffects/AudioMixerSubmixEffectDynamicsProcessor.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Dynamics
  • Meta=(EditCondition="!bBypass && DynamicsProcessorType == ESubmixEffectDynamicsProcessorType::Compressor || DynamicsProcessorType == ESubmixEffectDynamicsProcessorType::Expander || DynamicsProcessorType == ESubmixEffectDynamicsProcessorType::UpwardsCompressor", ClampMin="1.0", ClampMax="20.0", UIMin="1.0", UIMax="20.0")
UIMin     SubmixEffects/AudioMixerSubmixEffectDynamicsProcessor.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Dynamics
  • Meta=(EditCondition="!bBypass && DynamicsProcessorType == ESubmixEffectDynamicsProcessorType::Compressor || DynamicsProcessorType == ESubmixEffectDynamicsProcessorType::Expander || DynamicsProcessorType == ESubmixEffectDynamicsProcessorType::UpwardsCompressor", ClampMin="1.0", ClampMax="20.0", UIMin="1.0", UIMax="20.0")

Functions

Public

Deprecated Variables

Name Type Remarks Include Path Unreal Specifiers
bChannelLinked_DEPRECATED uint8   SubmixEffects/AudioMixerSubmixEffectDynamicsProcessor.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page