`unreal.SubmixEffectDynamicsProcessorSettings`¶

class unreal.SubmixEffectDynamicsProcessorSettings(dynamics_processor_type: SubmixEffectDynamicsProcessorType = Ellipsis, peak_mode: SubmixEffectDynamicsPeakMode = Ellipsis, link_mode: SubmixEffectDynamicsChannelLinkMode = Ellipsis, input_gain_db: float = 0.0, threshold_db: float = 0.0, ratio: float = 0.0, knee_bandwidth_db: float = 0.0, look_ahead_msec: float = 0.0, attack_time_msec: float = 0.0, release_time_msec: float = 0.0, key_source: SubmixEffectDynamicsKeySource = Ellipsis, external_audio_bus: AudioBus = Ellipsis, external_submix: SoundSubmix = Ellipsis, analog_mode: bool = False, bypass: bool = False, key_audition: bool = False, key_gain_db: float = 0.0, output_gain_db: float = 0.0, key_highshelf: SubmixEffectDynamicProcessorFilterSettings = Ellipsis, key_lowshelf: SubmixEffectDynamicProcessorFilterSettings = Ellipsis)¶

Bases: StructBase

Submix dynamics processor settings

C++ Source:

Module: AudioMixer
File: AudioMixerSubmixEffectDynamicsProcessor.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 (SubmixEffectDynamicsProcessorType): [Read-Write] Type of processor to apply
external_audio_bus (AudioBus): [Read-Write] If set, uses output of provided audio bus as modulator of input signal for dynamics processor (Uses input signal as default modulator)
external_submix (SoundSubmix): [Read-Write] If set, uses output of provided submix as modulator of input signal for dynamics processor (Uses input signal as default modulator)
input_gain_db (float): [Read-Write] The input gain of the dynamics processor
key_audition (bool): [Read-Write] Audition the key modulation signal, bypassing enveloping and processing the input signal.
key_gain_db (float): [Read-Write] Gain to apply to key signal if key source not set to default (input).
key_highshelf (SubmixEffectDynamicProcessorFilterSettings): [Read-Write] High Shelf filter settings for key signal (external signal if supplied or input signal if not)
key_lowshelf (SubmixEffectDynamicProcessorFilterSettings): [Read-Write] Low Shelf filter settings for key signal (external signal if supplied or input signal if not)
key_source (SubmixEffectDynamicsKeySource): [Read-Write]
knee_bandwidth_db (float): [Read-Write] The knee bandwidth of the processor to use
link_mode (SubmixEffectDynamicsChannelLinkMode): [Read-Write] Mode of peak detection if key signal is multi-channel
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 (SubmixEffectDynamicsPeakMode): [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
threshold_db (float): [Read-Write] The threshold at which to perform a dynamics processing operation