unreal.SourceEffectDynamicsProcessorSettings

class unreal.SourceEffectDynamicsProcessorSettings(dynamics_processor_type: SourceEffectDynamicsProcessorType = Ellipsis, peak_mode: SourceEffectDynamicsPeakMode = Ellipsis, look_ahead_msec: float = 0.0, attack_time_msec: float = 0.0, release_time_msec: float = 0.0, threshold_db: float = 0.0, ratio: float = 0.0, knee_bandwidth_db: float = 0.0, input_gain_db: float = 0.0, output_gain_db: float = 0.0, stereo_linked: bool = False, analog_mode: bool = False, bypass: bool = False)

Bases: StructBase

Source Effect Dynamics Processor Settings

C++ Source:

  • Plugin: Synthesis

  • Module: Synthesis

  • File: SourceEffectDynamicsProcessor.h

Editor Properties: (see get_editor_property/set_editor_property)

  • analog_mode (bool): [Read-Write] Toggles treating the attack and release envelopes as analog-style vs digital-style (Analog will respond a bit more naturally/slower)

  • attack_time_msec (float): [Read-Write] The amount of time to ramp into any dynamics processing effect

  • bypass (bool): [Read-Write] Whether or not to bypass effect

  • dynamics_processor_type (SourceEffectDynamicsProcessorType): [Read-Write] Type of processor to apply

  • input_gain_db (float): [Read-Write] The input gain of the dynamics processor

  • knee_bandwidth_db (float): [Read-Write] The knee bandwidth of the processor to use

  • look_ahead_msec (float): [Read-Write] The amount of time to look ahead of the current audio (Allows for transients to be included in dynamics processing)

  • output_gain_db (float): [Read-Write] The output gain of the dynamics processor

  • peak_mode (SourceEffectDynamicsPeakMode): [Read-Write] Mode of peak detection used on input key signal

  • ratio (float): [Read-Write] The dynamics processor ratio used for compression/expansion

  • release_time_msec (float): [Read-Write] The amount of time to release the dynamics processing effect

  • stereo_linked (bool): [Read-Write] Whether the left and right channels are linked when determining envelopes

  • threshold_db (float): [Read-Write] The threshold at which to perform a dynamics processing operation

property analog_mode: bool

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

Type:

(bool)

property attack_time_msec: float

[Read-Write] The amount of time to ramp into any dynamics processing effect

Type:

(float)

property bypass: bool

[Read-Write] Whether or not to bypass effect

Type:

(bool)

property dynamics_processor_type: SourceEffectDynamicsProcessorType

[Read-Write] Type of processor to apply

Type:

(SourceEffectDynamicsProcessorType)

property input_gain_db: float

[Read-Write] The input gain of the dynamics processor

Type:

(float)

property knee_bandwidth_db: float

[Read-Write] The knee bandwidth of the processor to use

Type:

(float)

property look_ahead_msec: float

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

Type:

(float)

property output_gain_db: float

[Read-Write] The output gain of the dynamics processor

Type:

(float)

property peak_mode: SourceEffectDynamicsPeakMode

[Read-Write] Mode of peak detection used on input key signal

Type:

(SourceEffectDynamicsPeakMode)

property ratio: float

[Read-Write] The dynamics processor ratio used for compression/expansion

Type:

(float)

property release_time_msec: float

[Read-Write] The amount of time to release the dynamics processing effect

Type:

(float)

property stereo_linked: bool

[Read-Write] Whether the left and right channels are linked when determining envelopes

Type:

(bool)

property threshold_db: float

[Read-Write] The threshold at which to perform a dynamics processing operation

Type:

(float)