unreal.SubmixEffectMultibandCompressorSettings

class unreal.SubmixEffectMultibandCompressorSettings(dynamics_processor_type: SubmixEffectDynamicsProcessorType = Ellipsis, peak_mode: SubmixEffectDynamicsPeakMode = Ellipsis, link_mode: SubmixEffectDynamicsChannelLinkMode = Ellipsis, look_ahead_msec: float = 0.0, analog_mode: bool = False, four_pole: bool = False, bypass: bool = False, key_source: SubmixEffectDynamicsKeySource = Ellipsis, external_audio_bus: AudioBus = Ellipsis, external_submix: SoundSubmix = Ellipsis, key_gain_db: float = 0.0, key_audition: bool = False, bands: None = [])

Bases: StructBase

A submix dynamics processor

C++ Source:

  • Plugin: Synthesis

  • Module: Synthesis

  • File: SubmixEffectMultiBandCompressor.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.

  • bands (Array[DynamicsBandSettings]): [Read-Write] Each band is a full dynamics processor, affecting at a unique frequency range

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

  • dynamics_processor_type (SubmixEffectDynamicsProcessorType): [Read-Write] Controls how each band will react to audio above its threshold

  • external_audio_bus (AudioBus): [Read-Write] If set, uses output of provided submix 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)

  • four_pole (bool): [Read-Write] Turning off FourPole mode will use cheaper, shallower 2-pole crossovers

  • 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 external input is supplied

  • key_source (SubmixEffectDynamicsKeySource): [Read-Write]

  • link_mode (SubmixEffectDynamicsChannelLinkMode): [Read-Write] Whether to compress all channels equally, and how to evaluate the overall level

  • 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.

  • peak_mode (SubmixEffectDynamicsPeakMode): [Read-Write] Controls how quickly the bands will react to a signal above its threshold

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 bands: None

[Read-Write] Each band is a full dynamics processor, affecting at a unique frequency range

Type:

(Array[DynamicsBandSettings])

property bypass: bool

[Read-Write] Whether or not to bypass effect

Type:

(bool)

property dynamics_processor_type: SubmixEffectDynamicsProcessorType

[Read-Write] Controls how each band will react to audio above its threshold

Type:

(SubmixEffectDynamicsProcessorType)

property external_audio_bus: AudioBus

[Read-Write] If set, uses output of provided submix as modulator of input signal for dynamics processor (Uses input signal as default modulator)

Type:

(AudioBus)

property 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)

Type:

(SoundSubmix)

property four_pole: bool

[Read-Write] Turning off FourPole mode will use cheaper, shallower 2-pole crossovers

Type:

(bool)

property key_audition: bool

[Read-Write] Audition the key modulation signal, bypassing enveloping and processing the input signal.

Type:

(bool)

property key_gain_db: float

[Read-Write] Gain to apply to key signal if external input is supplied

Type:

(float)

property key_source: SubmixEffectDynamicsKeySource

[Read-Write]

Type:

(SubmixEffectDynamicsKeySource)

[Read-Write] Whether to compress all channels equally, and how to evaluate the overall level

Type:

(SubmixEffectDynamicsChannelLinkMode)

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 peak_mode: SubmixEffectDynamicsPeakMode

[Read-Write] Controls how quickly the bands will react to a signal above its threshold

Type:

(SubmixEffectDynamicsPeakMode)