unreal.SubmixEffectDynamicsProcessorSettings
¶
- class unreal.SubmixEffectDynamicsProcessorSettings(dynamics_processor_type: SubmixEffectDynamicsProcessorType = Ellipsis, peak_mode: SubmixEffectDynamicsPeakMode = Ellipsis, link_mode: SubmixEffectDynamicsChannelLinkMode = Ellipsis, input_gain_db: float = 0.0, threshold_db: float = 0.0, ratio: float = 0.0, knee_bandwidth_db: float = 0.0, look_ahead_msec: float = 0.0, attack_time_msec: float = 0.0, release_time_msec: float = 0.0, key_source: SubmixEffectDynamicsKeySource = Ellipsis, external_audio_bus: AudioBus = Ellipsis, external_submix: SoundSubmix = Ellipsis, analog_mode: bool = False, bypass: bool = False, key_audition: bool = False, key_gain_db: float = 0.0, output_gain_db: float = 0.0, key_highshelf: SubmixEffectDynamicProcessorFilterSettings = Ellipsis, key_lowshelf: SubmixEffectDynamicProcessorFilterSettings = Ellipsis)¶
Bases:
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] Analog Mode: 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] Attack Time Msec: The amount of time to ramp into any dynamics processing effectbypass
(bool): [Read-Write] Bypass: Whether or not to bypass effectdynamics_processor_type
(SubmixEffectDynamicsProcessorType): [Read-Write] Dynamics Processor Type: Type of processor to applyexternal_audio_bus
(AudioBus): [Read-Write] External Audio Bus: If set, uses output of provided audio bus 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)input_gain_db
(float): [Read-Write] Input Gain Db: The input gain of the dynamics processorkey_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 key source not set to default (input).key_highshelf
(SubmixEffectDynamicProcessorFilterSettings): [Read-Write] Key Highshelf: High Shelf filter settings for key signal (external signal if supplied or input signal if not)key_lowshelf
(SubmixEffectDynamicProcessorFilterSettings): [Read-Write] Key Lowshelf: Low Shelf filter settings for key signal (external signal if supplied or input signal if not)key_source
(SubmixEffectDynamicsKeySource): [Read-Write] Key Sourceknee_bandwidth_db
(float): [Read-Write] Knee Bandwidth Db: The knee bandwidth of the processor to uselink_mode
(SubmixEffectDynamicsChannelLinkMode): [Read-Write] Link Mode: Mode of peak detection if key signal is multi-channellook_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)output_gain_db
(float): [Read-Write] Output Gain Db: The output gain of the dynamics processorpeak_mode
(SubmixEffectDynamicsPeakMode): [Read-Write] Peak Mode: Mode of peak detection used on input key signalratio
(float): [Read-Write] Ratio: The dynamics processor ratio used for compression/expansionrelease_time_msec
(float): [Read-Write] Release Time Msec: The amount of time to release the dynamics processing effectthreshold_db
(float): [Read-Write] Threshold Db: The threshold at which to perform a dynamics processing operation
- 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)
- Type:
(bool)
- property attack_time_msec: float¶
[Read-Write] Attack Time Msec: The amount of time to ramp into any dynamics processing effect
- Type:
(float)
- property dynamics_processor_type: SubmixEffectDynamicsProcessorType¶
[Read-Write] Dynamics Processor Type: Type of processor to apply
- property external_audio_bus: AudioBus¶
[Read-Write] External Audio Bus: If set, uses output of provided audio bus as modulator of input signal for dynamics processor (Uses input signal as default modulator)
- Type:
(AudioBus)
- property 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)
- Type:
- property input_gain_db: float¶
[Read-Write] Input Gain Db: The input gain of the dynamics processor
- Type:
(float)
- property key_audition: bool¶
[Read-Write] Key Audition: Audition the key modulation signal, bypassing enveloping and processing the input signal.
- Type:
(bool)
- property key_gain_db: float¶
[Read-Write] Key Gain Db: Gain to apply to key signal if key source not set to default (input).
- Type:
(float)
- property key_highshelf: SubmixEffectDynamicProcessorFilterSettings¶
[Read-Write] Key Highshelf: High Shelf filter settings for key signal (external signal if supplied or input signal if not)
- property key_lowshelf: SubmixEffectDynamicProcessorFilterSettings¶
[Read-Write] Key Lowshelf: Low Shelf filter settings for key signal (external signal if supplied or input signal if not)
- property key_source: SubmixEffectDynamicsKeySource¶
[Read-Write] Key Source
- Type:
- property knee_bandwidth_db: float¶
[Read-Write] Knee Bandwidth Db: The knee bandwidth of the processor to use
- Type:
(float)
- property link_mode: SubmixEffectDynamicsChannelLinkMode¶
[Read-Write] Link Mode: Mode of peak detection if key signal is multi-channel
- property look_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)
- Type:
(float)
- property output_gain_db: float¶
[Read-Write] Output Gain Db: The output gain of the dynamics processor
- Type:
(float)
- property peak_mode: SubmixEffectDynamicsPeakMode¶
[Read-Write] Peak Mode: Mode of peak detection used on input key signal
- Type:
- property ratio: float¶
[Read-Write] Ratio: The dynamics processor ratio used for compression/expansion
- Type:
(float)