unreal.ModularSynthPreset
¶
- class unreal.ModularSynthPreset(enable_polyphony: bool = False, osc1_type: Synth1OscType = Ellipsis, osc1_gain: float = 0.0, osc1_octave: float = 0.0, osc1_semitones: float = 0.0, osc1_cents: float = 0.0, osc1_pulse_width: float = 0.0, osc2_type: Synth1OscType = Ellipsis, osc2_gain: float = 0.0, osc2_octave: float = 0.0, osc2_semitones: float = 0.0, osc2_cents: float = 0.0, osc2_pulse_width: float = 0.0, portamento: float = 0.0, enable_unison: bool = False, enable_oscillator_sync: bool = False, spread: float = 0.0, pan: float = 0.0, lfo1_frequency: float = 0.0, lfo1_gain: float = 0.0, lfo1_type: SynthLFOType = Ellipsis, lfo1_mode: SynthLFOMode = Ellipsis, lfo1_patch_type: SynthLFOPatchType = Ellipsis, lfo2_frequency: float = 0.0, lfo2_gain: float = 0.0, lfo2_type: SynthLFOType = Ellipsis, lfo2_mode: SynthLFOMode = Ellipsis, lfo2_patch_type: SynthLFOPatchType = Ellipsis, gain_db: float = 0.0, attack_time: float = 0.0, decay_time: float = 0.0, sustain_gain: float = 0.0, release_time: float = 0.0, mod_env_patch_type: SynthModEnvPatch = Ellipsis, mod_env_bias_patch_type: SynthModEnvBiasPatch = Ellipsis, invert_modulation_envelope: bool = False, invert_modulation_envelope_bias: bool = False, modulation_envelope_depth: float = 0.0, modulation_envelope_attack_time: float = 0.0, modulation_envelope_decay_time: float = 0.0, modulation_envelope_sustain_gain: float = 0.0, modulation_envelope_release_time: float = 0.0, legato: bool = False, retrigger: bool = False, filter_frequency: float = 0.0, filter_q: float = 0.0, filter_type: SynthFilterType = Ellipsis, filter_algorithm: SynthFilterAlgorithm = Ellipsis, stereo_delay_enabled: bool = False, stereo_delay_mode: SynthStereoDelayMode = Ellipsis, stereo_delay_time: float = 0.0, stereo_delay_feedback: float = 0.0, stereo_delay_wetlevel: float = 0.0, stereo_delay_ratio: float = 0.0, chorus_enabled: bool = False, chorus_depth: float = 0.0, chorus_feedback: float = 0.0, chorus_frequency: float = 0.0, patches: None = [])¶
Bases:
TableRowBase
Modular Synth Preset
C++ Source:
Plugin: Synthesis
Module: Synthesis
File: EpicSynth1Component.h
Editor Properties: (see get_editor_property/set_editor_property)
attack_time
(float): [Read-Write] The amplitude envelope attack time (in ms) [0.0, 10000]chorus_depth
(float): [Read-Write] The depth of the chorus effect [0.0, 1.0]chorus_enabled
(bool): [Read-Write] Whether or not the chorus effect is enabledchorus_feedback
(float): [Read-Write] The amount of feedback in the chorus effect [0.0, 1.0]chorus_frequency
(float): [Read-Write] The chorus LFO frequency [0.0, 20.0]decay_time
(float): [Read-Write] The amplitude envelope decay time (in ms)[0.0, 10000]enable_oscillator_sync
(bool): [Read-Write] Whether or not oscillator sync is enabled. Oscillator sync forces oscillator 2’s phase to align with oscillator 1’s phase.enable_polyphony
(bool): [Read-Write] Whether or not to allow multiple synth voices.enable_unison
(bool): [Read-Write] Enables forcing the oscillators to have no stereo spread.filter_algorithm
(SynthFilterAlgorithm): [Read-Write] The output filter circuit/algorithm type (one-pole ladder, ladder, state-variable)filter_frequency
(float): [Read-Write] The output filter cutoff frequency (hz) [0.0, 20000.0]filter_q
(float): [Read-Write] The output filter resonance (Q) [0.5, 10]filter_type
(SynthFilterType): [Read-Write] The output filter type (lowpass, highpass, bandpass, bandstop)gain_db
(float): [Read-Write] The overall gain to use for the synthesizer in dB [-90.0, 20.0]invert_modulation_envelope
(bool): [Read-Write] Whether or not to invert the modulation envelopeinvert_modulation_envelope_bias
(bool): [Read-Write] Whether or not to invert the modulation envelope bias outputlegato
(bool): [Read-Write] Whether or not to use legato mode.lfo1_frequency
(float): [Read-Write] The frequency to use for LFO 1 (in hz) [0.0, 50.0]lfo1_gain
(float): [Read-Write] The linear gain to use for LFO 1 [0.0, 1.0]lfo1_mode
(SynthLFOMode): [Read-Write] The mode to use for LFO 1lfo1_patch_type
(SynthLFOPatchType): [Read-Write] The built-in patch type to use for LFO 1 (you can route this to any patchable parameter using the Patches parameter)lfo1_type
(SynthLFOType): [Read-Write] The type of LFO to use for LFO 1lfo2_frequency
(float): [Read-Write] The frequency to use for LFO 2 (in hz) [0.0, 50.0]lfo2_gain
(float): [Read-Write] The linear gain to use for LFO 2 [0.0, 1.0]lfo2_mode
(SynthLFOMode): [Read-Write] The mode to use for LFO 2lfo2_patch_type
(SynthLFOPatchType): [Read-Write] The built-in patch type to use for LFO 2 (you can route this to any patchable parameter using the Patches parameter)lfo2_type
(SynthLFOType): [Read-Write] The type of LFO to use for LFO 2mod_env_bias_patch_type
(SynthModEnvBiasPatch): [Read-Write] The built-in patch type for the envelope modulator bias output. Bias is when the envelope output is offset by the sustain gain.mod_env_patch_type
(SynthModEnvPatch): [Read-Write] The built-in patch type for the envelope modulatormodulation_envelope_attack_time
(float): [Read-Write] The modulation envelope attack time (in ms) [0.0, 10000]modulation_envelope_decay_time
(float): [Read-Write] The modulation envelope decay time (in ms) [0.0, 10000]modulation_envelope_depth
(float): [Read-Write] The “depth” (i.e. how much) modulation envelope to use. This scales the modulation envelope output. [0.0, 1.0]modulation_envelope_release_time
(float): [Read-Write] The modulation envelope release time (in ms) [0.0, 10000]modulation_envelope_sustain_gain
(float): [Read-Write] The modulation envelope sustain gain (linear gain) [0.0, 1.0]osc1_cents
(float): [Read-Write] The cents (hundreds of a semitone) of oscillator 1. [-100.0, 100.0]osc1_gain
(float): [Read-Write] The linear gain of oscillator 1 [0.0, 1.0]osc1_octave
(float): [Read-Write] The octave of oscillator 1. [-8.0, 8.0]osc1_pulse_width
(float): [Read-Write] The pulsewidth of oscillator 1 (when using a square wave type oscillator). [0.0, 1.0]osc1_semitones
(float): [Read-Write] The semi-tones of oscillator 1. [-12.0, 12.0]osc1_type
(Synth1OscType): [Read-Write] What type of oscillator to use for oscillator 1osc2_cents
(float): [Read-Write] The cents (hundreds of a semitone) of oscillator 2. [-100.0, 100.0]osc2_gain
(float): [Read-Write] The linear gain of oscillator 2 [0.0, 1.0]osc2_octave
(float): [Read-Write] The octave of oscillator 2. [-8.0, 8.0]osc2_pulse_width
(float): [Read-Write] The pulsewidth of oscillator 2 (when using a square wave type oscillator). [0.0, 1.0]osc2_semitones
(float): [Read-Write] The semi-tones of oscillator 2. [-12.0, 12.0]osc2_type
(Synth1OscType): [Read-Write] What type of oscillator to use for oscillator 2pan
(float): [Read-Write] The stereo pan to use. 0.0 is center. -1.0 is left, 1.0 is right.patches
(Array[EpicSynth1Patch]): [Read-Write] The modular synth patch cords to use for the synth. Allows routing the LFO1/LFO2 and Modulation Envelope to any patchable destination.portamento
(float): [Read-Write] The amount of portamento to use, which is the amount of pitch sliding from current note to next [0.0, 1.0]release_time
(float): [Read-Write] The amplitude envelope release time (in ms) [0.0, 10000]retrigger
(bool): [Read-Write] Whether or not to use retrigger mode.spread
(float): [Read-Write] The amount of stereo spread to use between oscillator 1 and oscillator 2 [0.0, 1.0]stereo_delay_enabled
(bool): [Read-Write] Whether or not stereo delay is enabled on the synthstereo_delay_feedback
(float): [Read-Write] The amount of feedback in the stereo delay line [0.0, 1.0]stereo_delay_mode
(SynthStereoDelayMode): [Read-Write] The stereo delay mode of the synthstereo_delay_ratio
(float): [Read-Write] The ratio between left and right stereo delay lines (wider value is more separation) [0.0, 1.0]stereo_delay_time
(float): [Read-Write] The stereo delay time (in ms) [0.0, 2000.0]stereo_delay_wetlevel
(float): [Read-Write] The output wet level to use for the stereo delay time [0.0, 1.0]sustain_gain
(float): [Read-Write] The amplitude envelope sustain amount (linear gain) [0.0, 1.0]
- property attack_time: float¶
[Read-Write] The amplitude envelope attack time (in ms) [0.0, 10000]
- Type:
(float)
- property chorus_enabled: bool¶
[Read-Write] Whether or not the chorus effect is enabled
- Type:
(bool)
- property chorus_feedback: float¶
[Read-Write] The amount of feedback in the chorus effect [0.0, 1.0]
- Type:
(float)
- property decay_time: float¶
[Read-Write] The amplitude envelope decay time (in ms)[0.0, 10000]
- Type:
(float)
- property enable_oscillator_sync: bool¶
[Read-Write] Whether or not oscillator sync is enabled. Oscillator sync forces oscillator 2’s phase to align with oscillator 1’s phase.
- Type:
(bool)
- property enable_polyphony: bool¶
[Read-Write] Whether or not to allow multiple synth voices.
- Type:
(bool)
- property enable_unison: bool¶
[Read-Write] Enables forcing the oscillators to have no stereo spread.
- Type:
(bool)
- property filter_algorithm: SynthFilterAlgorithm¶
[Read-Write] The output filter circuit/algorithm type (one-pole ladder, ladder, state-variable)
- Type:
- property filter_frequency: float¶
[Read-Write] The output filter cutoff frequency (hz) [0.0, 20000.0]
- Type:
(float)
- property filter_type: SynthFilterType¶
[Read-Write] The output filter type (lowpass, highpass, bandpass, bandstop)
- Type:
- property gain_db: float¶
[Read-Write] The overall gain to use for the synthesizer in dB [-90.0, 20.0]
- Type:
(float)
- property invert_modulation_envelope: bool¶
[Read-Write] Whether or not to invert the modulation envelope
- Type:
(bool)
- property invert_modulation_envelope_bias: bool¶
[Read-Write] Whether or not to invert the modulation envelope bias output
- Type:
(bool)
- property lfo1_frequency: float¶
[Read-Write] The frequency to use for LFO 1 (in hz) [0.0, 50.0]
- Type:
(float)
- property lfo1_mode: SynthLFOMode¶
[Read-Write] The mode to use for LFO 1
- Type:
- property lfo1_patch_type: SynthLFOPatchType¶
[Read-Write] The built-in patch type to use for LFO 1 (you can route this to any patchable parameter using the Patches parameter)
- Type:
- property lfo1_type: SynthLFOType¶
[Read-Write] The type of LFO to use for LFO 1
- Type:
- property lfo2_frequency: float¶
[Read-Write] The frequency to use for LFO 2 (in hz) [0.0, 50.0]
- Type:
(float)
- property lfo2_mode: SynthLFOMode¶
[Read-Write] The mode to use for LFO 2
- Type:
- property lfo2_patch_type: SynthLFOPatchType¶
[Read-Write] The built-in patch type to use for LFO 2 (you can route this to any patchable parameter using the Patches parameter)
- Type:
- property lfo2_type: SynthLFOType¶
[Read-Write] The type of LFO to use for LFO 2
- Type:
- property mod_env_bias_patch_type: SynthModEnvBiasPatch¶
[Read-Write] The built-in patch type for the envelope modulator bias output. Bias is when the envelope output is offset by the sustain gain.
- Type:
- property mod_env_patch_type: SynthModEnvPatch¶
[Read-Write] The built-in patch type for the envelope modulator
- Type:
- property modulation_envelope_attack_time: float¶
[Read-Write] The modulation envelope attack time (in ms) [0.0, 10000]
- Type:
(float)
- property modulation_envelope_decay_time: float¶
[Read-Write] The modulation envelope decay time (in ms) [0.0, 10000]
- Type:
(float)
- property modulation_envelope_depth: float¶
[Read-Write] The “depth” (i.e. how much) modulation envelope to use. This scales the modulation envelope output. [0.0, 1.0]
- Type:
(float)
- property modulation_envelope_release_time: float¶
[Read-Write] The modulation envelope release time (in ms) [0.0, 10000]
- Type:
(float)
- property modulation_envelope_sustain_gain: float¶
[Read-Write] The modulation envelope sustain gain (linear gain) [0.0, 1.0]
- Type:
(float)
- property osc1_cents: float¶
[Read-Write] The cents (hundreds of a semitone) of oscillator 1. [-100.0, 100.0]
- Type:
(float)
- property osc1_pulse_width: float¶
[Read-Write] The pulsewidth of oscillator 1 (when using a square wave type oscillator). [0.0, 1.0]
- Type:
(float)
- property osc1_semitones: float¶
[Read-Write] The semi-tones of oscillator 1. [-12.0, 12.0]
- Type:
(float)
- property osc1_type: Synth1OscType¶
[Read-Write] What type of oscillator to use for oscillator 1
- Type:
- property osc2_cents: float¶
[Read-Write] The cents (hundreds of a semitone) of oscillator 2. [-100.0, 100.0]
- Type:
(float)
- property osc2_pulse_width: float¶
[Read-Write] The pulsewidth of oscillator 2 (when using a square wave type oscillator). [0.0, 1.0]
- Type:
(float)
- property osc2_semitones: float¶
[Read-Write] The semi-tones of oscillator 2. [-12.0, 12.0]
- Type:
(float)
- property osc2_type: Synth1OscType¶
[Read-Write] What type of oscillator to use for oscillator 2
- Type:
- property pan: float¶
[Read-Write] The stereo pan to use. 0.0 is center. -1.0 is left, 1.0 is right.
- Type:
(float)
- property patches: None¶
[Read-Write] The modular synth patch cords to use for the synth. Allows routing the LFO1/LFO2 and Modulation Envelope to any patchable destination.
- Type:
- property portamento: float¶
[Read-Write] The amount of portamento to use, which is the amount of pitch sliding from current note to next [0.0, 1.0]
- Type:
(float)
- property release_time: float¶
[Read-Write] The amplitude envelope release time (in ms) [0.0, 10000]
- Type:
(float)
- property spread: float¶
[Read-Write] The amount of stereo spread to use between oscillator 1 and oscillator 2 [0.0, 1.0]
- Type:
(float)
- property stereo_delay_enabled: bool¶
[Read-Write] Whether or not stereo delay is enabled on the synth
- Type:
(bool)
- property stereo_delay_feedback: float¶
[Read-Write] The amount of feedback in the stereo delay line [0.0, 1.0]
- Type:
(float)
- property stereo_delay_mode: SynthStereoDelayMode¶
[Read-Write] The stereo delay mode of the synth
- Type:
- property stereo_delay_ratio: float¶
[Read-Write] The ratio between left and right stereo delay lines (wider value is more separation) [0.0, 1.0]
- Type:
(float)
- property stereo_delay_time: float¶
[Read-Write] The stereo delay time (in ms) [0.0, 2000.0]
- Type:
(float)