unreal.SubmixEffectDynamicsProcessorSettings

class unreal.SubmixEffectDynamicsProcessorSettings(dynamics_processor_type=SubmixEffectDynamicsProcessorType.COMPRESSOR, peak_mode=SubmixEffectDynamicsPeakMode.ROOT_MEAN_SQUARED, look_ahead_msec=3.0, attack_time_msec=10.0, release_time_msec=100.0, threshold_db=-6.0, ratio=1.5, knee_bandwidth_db=10.0, input_gain_db=0.0, output_gain_db=0.0, channel_linked=True, analog_mode=True)

Bases: unreal.StructBase

A submix dynamics processor

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 in milliseconds.
  • channel_linked (bool): [Read-Write] Whether or not to average all channels of audio before inputing into the dynamics processor
  • dynamics_processor_type (SubmixEffectDynamicsProcessorType): [Read-Write] Dynamics Processor Type
  • input_gain_db (float): [Read-Write] The input gain of the dynamics processor in dB
  • knee_bandwidth_db (float): [Read-Write] The knee bandwidth of the compressor to use in dB
  • 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 in dB
  • peak_mode (SubmixEffectDynamicsPeakMode): [Read-Write] Peak Mode
  • ratio (float): [Read-Write] The dynamics processor ratio – has different meaning depending on the processor type.
  • release_time_msec (float): [Read-Write] The amount of time to release the dynamics processing effect in milliseconds
  • 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 in milliseconds.

channel_linked

(bool) – [Read-Write] Whether or not to average all channels of audio before inputing into the dynamics processor

dynamics_processor_type

(SubmixEffectDynamicsProcessorType) – [Read-Write] Dynamics Processor Type

input_gain_db

(float) – [Read-Write] The input gain of the dynamics processor in dB

knee_bandwidth_db

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

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 in dB

peak_mode

(SubmixEffectDynamicsPeakMode) – [Read-Write] Peak Mode

ratio

(float) – [Read-Write] The dynamics processor ratio – has different meaning depending on the processor type.

release_time_msec

(float) – [Read-Write] The amount of time to release the dynamics processing effect in milliseconds

threshold_db

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