unreal.SubmixEffectMultibandCompressorSettings
¶
- class unreal.SubmixEffectMultibandCompressorSettings(dynamics_processor_type=SubmixEffectDynamicsProcessorType.COMPRESSOR, peak_mode=SubmixEffectDynamicsPeakMode.ROOT_MEAN_SQUARED, link_mode=SubmixEffectDynamicsChannelLinkMode.AVERAGE, look_ahead_msec=3.0, analog_mode=True, four_pole=True, bypass=False, key_source=SubmixEffectDynamicsKeySource.DEFAULT, external_audio_bus=None, external_submix=None, key_gain_db=0.0, key_audition=False, 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] Analog Mode: 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] Bands: Each band is a full dynamics processor, affecting at a unique frequency rangebypass
(bool): [Read-Write] Bypass: Whether or not to bypass effectdynamics_processor_type
(SubmixEffectDynamicsProcessorType): [Read-Write] Dynamics Processor Type: Controls how each band will react to audio above its thresholdexternal_audio_bus
(AudioBus): [Read-Write] External Audio Bus: 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] External Submix: 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] Four Pole: Turning off FourPole mode will use cheaper, shallower 2-pole crossoverskey_audition
(bool): [Read-Write] Key Audition: Audition the key modulation signal, bypassing enveloping and processing the input signal.key_gain_db
(float): [Read-Write] Key Gain Db: Gain to apply to key signal if external input is suppliedkey_source
(SubmixEffectDynamicsKeySource): [Read-Write] Key Sourcelink_mode
(SubmixEffectDynamicsChannelLinkMode): [Read-Write] Link Mode: Whether to compress all channels equally, and how to evaluate the overall levellook_ahead_msec
(float): [Read-Write] Look Ahead Msec: 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] Peak Mode: Controls how quickly the bands will react to a signal above its threshold
- property analog_mode¶
[Read-Write] Analog Mode: 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] Bands: Each band is a full dynamics processor, affecting at a unique frequency range
- Type
- property dynamics_processor_type¶
[Read-Write] Dynamics Processor Type: Controls how each band will react to audio above its threshold
- property external_audio_bus¶
[Read-Write] External Audio Bus: 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¶
[Read-Write] External Submix: If set, uses output of provided submix as modulator of input signal for dynamics processor (Uses input signal as default modulator)
- Type
- property four_pole¶
[Read-Write] Four Pole: Turning off FourPole mode will use cheaper, shallower 2-pole crossovers
- Type
(bool)
- property key_audition¶
[Read-Write] Key Audition: Audition the key modulation signal, bypassing enveloping and processing the input signal.
- Type
(bool)
- property key_gain_db¶
[Read-Write] Key Gain Db: Gain to apply to key signal if external input is supplied
- Type
(float)
- property key_source¶
[Read-Write] Key Source
- property link_mode¶
[Read-Write] Link Mode: Whether to compress all channels equally, and how to evaluate the overall level
- property look_ahead_msec¶
[Read-Write] Look Ahead Msec: 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] Peak Mode: Controls how quickly the bands will react to a signal above its threshold
- Type