VST#
- class pyflp.plugin.VSTPlugin[source]#
Represents a VST2 or a VST3 generator or effect.
- class _AutomationOptions[source]#
See
VSTPlugin.automation
.- notify_changes#
Record parameter changes as automation.
Notify about parameter changes. Defaults to
True
.
- class _MIDIOptions[source]#
See
VSTPlugin.midi
.- pb_range: int#
Pitch bend range MIDI RPN sent to the plugin (in semitones).
Min = 1. Max = 48. Defaults to 12.
- send_modx#
Send MOD X as polyphonic aftertouch. Defaults to
False
.
- send_pb#
Send pitch bend range (semitones). Defaults to
False
.See also
pb_range
- Sent to plugin as a MIDI RPN if this isTrue
.
- send_release#
Whether release velocity should be sent in note off messages.
Send note release velocity. Defaults to
True
.
- class _UIOptions[source]#
See
VSTPlugin.ui
.- accept_drop#
Host is bypassed when a file is dropped on the plugin editor.
Accept dropped files. Defaults to
False
.
- always_update#
Whether plugin UI should be updated when hidden; default to
False
.
- dpi_aware#
Enable if plugin editors look too big or small.
DPI aware when bridged. Defaults to
True
.
- scale_editor#
Scale dimensions of editor that appear cut-off on high-res screens.
Scale editor dimensions. Defaults to
False
.
- class _ProcessingOptions[source]#
See
VSTPlugin.processing
.- allow_sd#
Allow smart disable. Defaults to
True
.Disables the
VSTPlugin.smart_disable
feature ifFalse
.
- bridged#
Load a plugin in separate process.
Make bridged. Defaults to
False
.
- external#
Keep plugin editor in bridge process.
External window. Defaults to
False
.
- keep_state#
Donโt touch unless you have issues like DC offsets, spikes and crashes.
Ensure processor state in callbacks. Defaults to
True
.
- multithreaded#
Allow plugin to be multi-threaded by FL Studio.
Disables the
VSTPlugin.multithreaded
feature ifFalse
.Allow threaded processing. Defaults to
True
.
- notify_render#
Lets the plugin know when rendering to audio file.
This can be used by the plugin to switch to HQ processing or disable output entirely if it is in demo mode (depends on the plugin logic).
Notify about rendering mode. Defaults to
True
.
- process_inactive#
Make FL Studio also process inputs / outputs marked as inactive by plugin.
Process inactive inputs and outputs. Defaults to
True
.
- class _CompatibilityOptions[source]#
See
VSTPlugin.compatibility
.- buffers_maxsize#
Use maximum buffer size from host. Defaults to
False
.
- fast_idle: bool#
Increases idle rate - can make plugin GUI feel more responsive if its slow.
May increase CPU usage. Defaults to
False
.
- fixed_buffers#
Use fixed size buffers. Defaults to
False
.Makes FL Studio send fixed size buffers instead of variable ones when
True
. Can fix rendering errors caused by plugins. Increases latency by 2ms.
- process_maximum#
Process maximum size buffers. Defaults to
False
.
- reset_on_transport#
Reset plugin when FL Studio resets. Defaults to
True
.
- send_loop#
Lets the plugin know about
Arrangemnt.loop_pos
.Send loop position. Defaults to
True
.
- use_time_offset#
Adjust time information reported by plugin.
Can fix timing issues caused by plugins in FL Studio <20.7 project. Use time offset. Defaults to
False
.