unreal.SubmixEffectMultibandCompressorSettings

class unreal.SubmixEffectMultibandCompressorSettings(dynamics_processor_type=SubmixEffectDynamicsProcessorType.COMPRESSOR, peak_mode=SubmixEffectDynamicsPeakMode.ROOT_MEAN_SQUARED, look_ahead_msec=3.0, link_channels=True, analog_mode=True, four_pole=True, bands=[])

Bases: unreal.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

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

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

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

  • 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

[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

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

Type

(Array(DynamicsBandSettings))

property dynamics_processor_type

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

Type

(SubmixEffectDynamicsProcessorType)

property four_pole

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

Type

(bool)

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

Type

(bool)

property look_ahead_msec

[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

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

Type

(SubmixEffectDynamicsPeakMode)