unreal.SubmixEffectDynamicsProcessorSettings?

class unreal.SubmixEffectDynamicsProcessorSettings(dynamics_processor_type=SubmixEffectDynamicsProcessorType.COMPRESSOR, peak_mode=SubmixEffectDynamicsPeakMode.ROOT_MEAN_SQUARED, link_mode=SubmixEffectDynamicsChannelLinkMode.AVERAGE, input_gain_db=0.0, threshold_db=-6.0, ratio=1.5, knee_bandwidth_db=10.0, look_ahead_msec=3.0, attack_time_msec=10.0, release_time_msec=100.0, external_submix=None, analog_mode=True, key_audition=False, key_gain_db=0.0, output_gain_db=0.0, key_highshelf=[False, 20.0, 0.0], key_lowshelf=[False, 20000.0, 0.0])?

Bases: unreal.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
  • dynamics_processor_type (SubmixEffectDynamicsProcessorType): [Read-Write] Type of processor to apply
  • 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 (external signal if supplied or input signal if disabled)
  • 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)
  • 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
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

dynamics_processor_type?

(SubmixEffectDynamicsProcessorType) – [Read-Write] Type of processor to apply

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 (external signal if supplied or input signal if disabled)

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)

knee_bandwidth_db?

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

(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