1. Epic GamesDeveloper
  3. FSourceEffectDynamicsProcessorSettings

FSourceEffectDynamicsProcessorSettings

API > API/Plugins > API/Plugins/Synthesis

   
Name FSourceEffectDynamicsProcessorSettings
Type struct
Header File /Engine/Plugins/Runtime/Synthesis/Source/Synthesis/Classes/SourceEffects/SourceEffectDynamicsProcessor.h
Include Path #include "SourceEffects/SourceEffectDynamicsProcessor.h"

Syntax

USTRUCT (BlueprintType )  
struct FSourceEffectDynamicsProcessorSettings

Constructors

Name Remarks Include Path Unreal Specifiers

FSourceEffectDynamicsProcessorSettings()

   SourceEffects/SourceEffectDynamicsProcessor.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
AttackTimeMsec float The amount of time to ramp into any dynamics processing effect. SourceEffects/SourceEffectDynamicsProcessor.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Response
  • Meta=(DisplayName="Attack Time (ms)", ClampMin="1.0", ClampMax="300.0", UIMin="1.0", UIMax="200.0", EditCondition="!bBypass")
bAnalogMode uint32 Toggles treating the attack and release envelopes as analog-style vs digital-style (Analog will respond a bit more naturally/slower) SourceEffects/SourceEffectDynamicsProcessor.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Response
  • Meta=(EditCondition="!bBypass")
bBypass uint8 Whether or not to bypass effect. SourceEffects/SourceEffectDynamicsProcessor.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=General
  • Meta=(DisplayName="Bypass", DisplayAfter="DynamicsProcessorType")
bStereoLinked uint32 Whether the left and right channels are linked when determining envelopes. SourceEffects/SourceEffectDynamicsProcessor.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Dynamics
  • Meta=(EditCondition="!bBypass")
DynamicsProcessorType ESourceEffectDynamicsProcessorType Type of processor to apply. SourceEffects/SourceEffectDynamicsProcessor.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=General
  • Meta=(DisplayName="Type")
InputGainDb float The input gain of the dynamics processor. SourceEffects/SourceEffectDynamicsProcessor.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=General
  • Meta=(DisplayName="Input Gain (dB)", ClampMin="-12.0", ClampMax="20.0", UIMin="-12.0", UIMax="20.0", EditCondition="!bBypass")
KneeBandwidthDb float The knee bandwidth of the processor to use. SourceEffects/SourceEffectDynamicsProcessor.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Dynamics
  • Meta=(DisplayName="Knee Bandwidth (dB)", ClampMin="0.0", ClampMax="20.0", UIMin="0.0", UIMax="20.0", EditCondition="!bBypass")
LookAheadMsec float The amount of time to look ahead of the current audio (Allows for transients to be included in dynamics processing) SourceEffects/SourceEffectDynamicsProcessor.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. SourceEffects/SourceEffectDynamicsProcessor.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=General
  • Meta=(DisplayName="Output Gain (dB)", ClampMin="0.0", ClampMax="20.0", UIMin="0.0", UIMax="20.0", EditCondition="!bBypass")
PeakMode ESourceEffectDynamicsPeakMode Mode of peak detection used on input key signal. SourceEffects/SourceEffectDynamicsProcessor.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Dynamics
  • Meta=(EditCondition="!bBypass")
Ratio float The dynamics processor ratio used for compression/expansion. SourceEffects/SourceEffectDynamicsProcessor.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Dynamics
  • Meta=(ClampMin="1.0", ClampMax="20.0", UIMin="1.0", UIMax="20.0", EditCondition="!bBypass")
ReleaseTimeMsec float The amount of time to release the dynamics processing effect. SourceEffects/SourceEffectDynamicsProcessor.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. SourceEffects/SourceEffectDynamicsProcessor.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Dynamics
  • Meta=(DisplayName="Threshold (dB)", ClampMin="-60.0", ClampMax="0.0", UIMin="-60.0", UIMax="0.0", EditCondition="!bBypass")

Functions

Public

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page