`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: Array[EpicSynth1Patch] = [])¶

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] Attack Time: The amplitude envelope attack time (in ms) [0.0, 10000]
chorus_depth (float): [Read-Write] Chorus Depth: The depth of the chorus effect [0.0, 1.0]
chorus_enabled (bool): [Read-Write] Chorus Enabled: Whether or not the chorus effect is enabled
chorus_feedback (float): [Read-Write] Chorus Feedback: The amount of feedback in the chorus effect [0.0, 1.0]
chorus_frequency (float): [Read-Write] Chorus Frequency: The chorus LFO frequency [0.0, 20.0]
decay_time (float): [Read-Write] Decay Time: The amplitude envelope decay time (in ms)[0.0, 10000]
enable_oscillator_sync (bool): [Read-Write] Enable Oscillator Sync: 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] Enable Polyphony: Whether or not to allow multiple synth voices.
enable_unison (bool): [Read-Write] Enable Unison: Enables forcing the oscillators to have no stereo spread.
filter_algorithm (SynthFilterAlgorithm): [Read-Write] Filter Algorithm: The output filter circuit/algorithm type (one-pole ladder, ladder, state-variable)
filter_frequency (float): [Read-Write] Filter Frequency: The output filter cutoff frequency (hz) [0.0, 20000.0]
filter_q (float): [Read-Write] Filter Q: The output filter resonance (Q) [0.5, 10]
filter_type (SynthFilterType): [Read-Write] Filter Type: The output filter type (lowpass, highpass, bandpass, bandstop)
gain_db (float): [Read-Write] Gain Db: The overall gain to use for the synthesizer in dB [-90.0, 20.0]
invert_modulation_envelope (bool): [Read-Write] Invert Modulation Envelope: Whether or not to invert the modulation envelope
invert_modulation_envelope_bias (bool): [Read-Write] Invert Modulation Envelope Bias: Whether or not to invert the modulation envelope bias output
legato (bool): [Read-Write] Legato: Whether or not to use legato mode.
lfo1_frequency (float): [Read-Write] LFO1Frequency: The frequency to use for LFO 1 (in hz) [0.0, 50.0]
lfo1_gain (float): [Read-Write] LFO1Gain: The linear gain to use for LFO 1 [0.0, 1.0]
lfo1_mode (SynthLFOMode): [Read-Write] LFO1Mode: The mode to use for LFO 1
lfo1_patch_type (SynthLFOPatchType): [Read-Write] LFO1Patch Type: 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] LFO1Type: The type of LFO to use for LFO 1
lfo2_frequency (float): [Read-Write] LFO2Frequency: The frequency to use for LFO 2 (in hz) [0.0, 50.0]
lfo2_gain (float): [Read-Write] LFO2Gain: The linear gain to use for LFO 2 [0.0, 1.0]
lfo2_mode (SynthLFOMode): [Read-Write] LFO2Mode: The mode to use for LFO 2
lfo2_patch_type (SynthLFOPatchType): [Read-Write] LFO2Patch Type: 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] LFO2Type: The type of LFO to use for LFO 2
mod_env_bias_patch_type (SynthModEnvBiasPatch): [Read-Write] Mod Env Bias Patch Type: 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] Mod Env Patch Type: The built-in patch type for the envelope modulator
modulation_envelope_attack_time (float): [Read-Write] Modulation Envelope Attack Time: The modulation envelope attack time (in ms) [0.0, 10000]
modulation_envelope_decay_time (float): [Read-Write] Modulation Envelope Decay Time: The modulation envelope decay time (in ms) [0.0, 10000]
modulation_envelope_depth (float): [Read-Write] Modulation Envelope Depth: 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] Modulation Envelope Release Time: The modulation envelope release time (in ms) [0.0, 10000]
modulation_envelope_sustain_gain (float): [Read-Write] Modulation Envelope Sustain Gain: The modulation envelope sustain gain (linear gain) [0.0, 1.0]
osc1_cents (float): [Read-Write] Osc 1Cents: The cents (hundreds of a semitone) of oscillator 1. [-100.0, 100.0]
osc1_gain (float): [Read-Write] Osc 1Gain: The linear gain of oscillator 1 [0.0, 1.0]
osc1_octave (float): [Read-Write] Osc 1Octave: The octave of oscillator 1. [-8.0, 8.0]
osc1_pulse_width (float): [Read-Write] Osc 1Pulse Width: The pulsewidth of oscillator 1 (when using a square wave type oscillator). [0.0, 1.0]
osc1_semitones (float): [Read-Write] Osc 1Semitones: The semi-tones of oscillator 1. [-12.0, 12.0]
osc1_type (Synth1OscType): [Read-Write] Osc 1Type: What type of oscillator to use for oscillator 1
osc2_cents (float): [Read-Write] Osc 2Cents: The cents (hundreds of a semitone) of oscillator 2. [-100.0, 100.0]
osc2_gain (float): [Read-Write] Osc 2Gain: The linear gain of oscillator 2 [0.0, 1.0]
osc2_octave (float): [Read-Write] Osc 2Octave: The octave of oscillator 2. [-8.0, 8.0]
osc2_pulse_width (float): [Read-Write] Osc 2Pulse Width: The pulsewidth of oscillator 2 (when using a square wave type oscillator). [0.0, 1.0]
osc2_semitones (float): [Read-Write] Osc 2Semitones: The semi-tones of oscillator 2. [-12.0, 12.0]
osc2_type (Synth1OscType): [Read-Write] Osc 2Type: What type of oscillator to use for oscillator 2
pan (float): [Read-Write] Pan: The stereo pan to use. 0.0 is center. -1.0 is left, 1.0 is right.
patches (Array[EpicSynth1Patch]): [Read-Write] Patches: 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] Portamento: 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] Release Time: The amplitude envelope release time (in ms) [0.0, 10000]
retrigger (bool): [Read-Write] Retrigger: Whether or not to use retrigger mode.
spread (float): [Read-Write] Spread: The amount of stereo spread to use between oscillator 1 and oscillator 2 [0.0, 1.0]
stereo_delay_enabled (bool): [Read-Write] Stereo Delay Enabled: Whether or not stereo delay is enabled on the synth
stereo_delay_feedback (float): [Read-Write] Stereo Delay Feedback: The amount of feedback in the stereo delay line [0.0, 1.0]
stereo_delay_mode (SynthStereoDelayMode): [Read-Write] Stereo Delay Mode: The stereo delay mode of the synth
stereo_delay_ratio (float): [Read-Write] Stereo Delay Ratio: The ratio between left and right stereo delay lines (wider value is more separation) [0.0, 1.0]
stereo_delay_time (float): [Read-Write] Stereo Delay Time: The stereo delay time (in ms) [0.0, 2000.0]
stereo_delay_wetlevel (float): [Read-Write] Stereo Delay Wetlevel: The output wet level to use for the stereo delay time [0.0, 1.0]
sustain_gain (float): [Read-Write] Sustain Gain: The amplitude envelope sustain amount (linear gain) [0.0, 1.0]

property attack_time: float¶

[Read-Write] Attack Time: The amplitude envelope attack time (in ms) [0.0, 10000]

Type:: (float)

property chorus_depth: float¶

[Read-Write] Chorus Depth: The depth of the chorus effect [0.0, 1.0]

Type:: (float)

property chorus_enabled: bool¶

[Read-Write] Chorus Enabled: Whether or not the chorus effect is enabled

Type:: (bool)

property chorus_feedback: float¶

[Read-Write] Chorus Feedback: The amount of feedback in the chorus effect [0.0, 1.0]

Type:: (float)

property chorus_frequency: float¶

[Read-Write] Chorus Frequency: The chorus LFO frequency [0.0, 20.0]

Type:: (float)

property decay_time: float¶

[Read-Write] Decay Time: The amplitude envelope decay time (in ms)[0.0, 10000]

Type:: (float)

property enable_oscillator_sync: bool¶

[Read-Write] Enable Oscillator Sync: 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] Enable Polyphony: Whether or not to allow multiple synth voices.

Type:: (bool)

property enable_unison: bool¶

[Read-Write] Enable Unison: Enables forcing the oscillators to have no stereo spread.

Type:: (bool)

property filter_algorithm: SynthFilterAlgorithm¶

[Read-Write] Filter Algorithm: The output filter circuit/algorithm type (one-pole ladder, ladder, state-variable)

Type:: (SynthFilterAlgorithm)

property filter_frequency: float¶

[Read-Write] Filter Frequency: The output filter cutoff frequency (hz) [0.0, 20000.0]

Type:: (float)

property filter_q: float¶

[Read-Write] Filter Q: The output filter resonance (Q) [0.5, 10]

Type:: (float)

property filter_type: SynthFilterType¶

[Read-Write] Filter Type: The output filter type (lowpass, highpass, bandpass, bandstop)

Type:: (SynthFilterType)

property gain_db: float¶

[Read-Write] Gain Db: The overall gain to use for the synthesizer in dB [-90.0, 20.0]

Type:: (float)

property invert_modulation_envelope: bool¶

[Read-Write] Invert Modulation Envelope: Whether or not to invert the modulation envelope

Type:: (bool)

property invert_modulation_envelope_bias: bool¶

[Read-Write] Invert Modulation Envelope Bias: Whether or not to invert the modulation envelope bias output

Type:: (bool)

property legato: bool¶

[Read-Write] Legato: Whether or not to use legato mode.

Type:: (bool)

property lfo1_frequency: float¶

[Read-Write] LFO1Frequency: The frequency to use for LFO 1 (in hz) [0.0, 50.0]

Type:: (float)

property lfo1_gain: float¶

[Read-Write] LFO1Gain: The linear gain to use for LFO 1 [0.0, 1.0]

Type:: (float)

property lfo1_mode: SynthLFOMode¶

[Read-Write] LFO1Mode: The mode to use for LFO 1

Type:: (SynthLFOMode)

property lfo1_patch_type: SynthLFOPatchType¶

[Read-Write] LFO1Patch Type: The built-in patch type to use for LFO 1 (you can route this to any patchable parameter using the Patches parameter)

Type:: (SynthLFOPatchType)

property lfo1_type: SynthLFOType¶

[Read-Write] LFO1Type: The type of LFO to use for LFO 1

Type:: (SynthLFOType)

property lfo2_frequency: float¶

[Read-Write] LFO2Frequency: The frequency to use for LFO 2 (in hz) [0.0, 50.0]

Type:: (float)

property lfo2_gain: float¶

[Read-Write] LFO2Gain: The linear gain to use for LFO 2 [0.0, 1.0]

Type:: (float)

property lfo2_mode: SynthLFOMode¶

[Read-Write] LFO2Mode: The mode to use for LFO 2

Type:: (SynthLFOMode)

property lfo2_patch_type: SynthLFOPatchType¶

[Read-Write] LFO2Patch Type: The built-in patch type to use for LFO 2 (you can route this to any patchable parameter using the Patches parameter)

Type:: (SynthLFOPatchType)

property lfo2_type: SynthLFOType¶

[Read-Write] LFO2Type: The type of LFO to use for LFO 2

Type:: (SynthLFOType)

property mod_env_bias_patch_type: SynthModEnvBiasPatch¶

[Read-Write] Mod Env Bias Patch Type: The built-in patch type for the envelope modulator bias output. Bias is when the envelope output is offset by the sustain gain.

Type:: (SynthModEnvBiasPatch)

property mod_env_patch_type: SynthModEnvPatch¶

[Read-Write] Mod Env Patch Type: The built-in patch type for the envelope modulator

Type:: (SynthModEnvPatch)

property modulation_envelope_attack_time: float¶

[Read-Write] Modulation Envelope Attack Time: The modulation envelope attack time (in ms) [0.0, 10000]

Type:: (float)

property modulation_envelope_decay_time: float¶

[Read-Write] Modulation Envelope Decay Time: The modulation envelope decay time (in ms) [0.0, 10000]

Type:: (float)

property modulation_envelope_depth: float¶

[Read-Write] Modulation Envelope Depth: 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] Modulation Envelope Release Time: The modulation envelope release time (in ms) [0.0, 10000]

Type:: (float)

property modulation_envelope_sustain_gain: float¶

[Read-Write] Modulation Envelope Sustain Gain: The modulation envelope sustain gain (linear gain) [0.0, 1.0]

Type:: (float)

property osc1_cents: float¶

[Read-Write] Osc 1Cents: The cents (hundreds of a semitone) of oscillator 1. [-100.0, 100.0]

Type:: (float)

property osc1_gain: float¶

[Read-Write] Osc 1Gain: The linear gain of oscillator 1 [0.0, 1.0]

Type:: (float)

property osc1_octave: float¶

[Read-Write] Osc 1Octave: The octave of oscillator 1. [-8.0, 8.0]

Type:: (float)

property osc1_pulse_width: float¶

[Read-Write] Osc 1Pulse Width: The pulsewidth of oscillator 1 (when using a square wave type oscillator). [0.0, 1.0]

Type:: (float)

property osc1_semitones: float¶

[Read-Write] Osc 1Semitones: The semi-tones of oscillator 1. [-12.0, 12.0]

Type:: (float)

property osc1_type: Synth1OscType¶

[Read-Write] Osc 1Type: What type of oscillator to use for oscillator 1

Type:: (Synth1OscType)

property osc2_cents: float¶

[Read-Write] Osc 2Cents: The cents (hundreds of a semitone) of oscillator 2. [-100.0, 100.0]

Type:: (float)

property osc2_gain: float¶

[Read-Write] Osc 2Gain: The linear gain of oscillator 2 [0.0, 1.0]

Type:: (float)

property osc2_octave: float¶

[Read-Write] Osc 2Octave: The octave of oscillator 2. [-8.0, 8.0]

Type:: (float)

property osc2_pulse_width: float¶

[Read-Write] Osc 2Pulse Width: The pulsewidth of oscillator 2 (when using a square wave type oscillator). [0.0, 1.0]

Type:: (float)

property osc2_semitones: float¶

[Read-Write] Osc 2Semitones: The semi-tones of oscillator 2. [-12.0, 12.0]

Type:: (float)

property osc2_type: Synth1OscType¶

[Read-Write] Osc 2Type: What type of oscillator to use for oscillator 2

Type:: (Synth1OscType)

property pan: float¶

[Read-Write] Pan: The stereo pan to use. 0.0 is center. -1.0 is left, 1.0 is right.

Type:: (float)

property patches: Array[EpicSynth1Patch]¶

[Read-Write] Patches: The modular synth patch cords to use for the synth. Allows routing the LFO1/LFO2 and Modulation Envelope to any patchable destination.

Type:: (Array[EpicSynth1Patch])

property portamento: float¶

[Read-Write] Portamento: 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] Release Time: The amplitude envelope release time (in ms) [0.0, 10000]

Type:: (float)

property retrigger: bool¶

[Read-Write] Retrigger: Whether or not to use retrigger mode.

Type:: (bool)

property spread: float¶

[Read-Write] Spread: 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] Stereo Delay Enabled: Whether or not stereo delay is enabled on the synth

Type:: (bool)

property stereo_delay_feedback: float¶

[Read-Write] Stereo Delay Feedback: The amount of feedback in the stereo delay line [0.0, 1.0]

Type:: (float)

property stereo_delay_mode: SynthStereoDelayMode¶

[Read-Write] Stereo Delay Mode: The stereo delay mode of the synth

Type:: (SynthStereoDelayMode)

property stereo_delay_ratio: float¶

[Read-Write] Stereo Delay Ratio: 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] Stereo Delay Time: The stereo delay time (in ms) [0.0, 2000.0]

Type:: (float)

property stereo_delay_wetlevel: float¶

[Read-Write] Stereo Delay Wetlevel: The output wet level to use for the stereo delay time [0.0, 1.0]

Type:: (float)

property sustain_gain: float¶

[Read-Write] Sustain Gain: The amplitude envelope sustain amount (linear gain) [0.0, 1.0]

Type:: (float)

`unreal.ModularSynthPreset`¶

Table of Contents

Previous topic

Next topic

unreal.ModularSynthPreset¶

`unreal.ModularSynthPreset`¶