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 effectdynamics_processor_type
(SubmixEffectDynamicsProcessorType): [Read-Write] Type of processor to applyexternal_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 processorkey_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 suppliedkey_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 uselink_mode
(SubmixEffectDynamicsChannelLinkMode): [Read-Write] Mode of peak detection if key signal is multi-channellook_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 processorpeak_mode
(SubmixEffectDynamicsPeakMode): [Read-Write] Mode of peak detection used on input key signalratio
(float): [Read-Write] The dynamics processor ratio used for compression/expansionrelease_time_msec
(float): [Read-Write] The amount of time to release the dynamics processing effectthreshold_db
(float): [Read-Write] The threshold at which to perform a dynamics processing operation
-
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
attack_time_msec
¶ [Read-Write] The amount of time to ramp into any dynamics processing effect
- Type
(float)
-
property
dynamics_processor_type
¶ [Read-Write] Type of processor to apply
-
property
external_submix
¶ [Read-Write] If set, uses output of provided submix as modulator of input signal for dynamics processor (Uses input signal as default modulator)
- Type
-
property
key_audition
¶ [Read-Write] Audition the key modulation signal, bypassing enveloping and processing the input signal.
- Type
(bool)
-
property
key_gain_db
¶ [Read-Write] Gain to apply to key signal if external input is supplied
- Type
(float)
-
property
key_highshelf
¶ [Read-Write] High Shelf filter settings for key signal (external signal if supplied or input signal if not)
-
property
key_lowshelf
¶ [Read-Write] Low Shelf filter settings for key signal (external signal if supplied or input signal if not)
-
property
link_mode
¶ [Read-Write] Mode of peak detection if key signal is multi-channel
-
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] Mode of peak detection used on input key signal
- Type
-
property
ratio
¶ [Read-Write] The dynamics processor ratio used for compression/expansion
- Type
(float)