Plugins#

Contents:

class pyflp.plugin._PluginBase[source]#
compact: bool | None#

Whether plugin page toolbar (Detailed settings) is hidden.

demo_mode: bool | None#

Whether the plugin state was saved in a demo / trial version.

detached: bool | None#

Plugin editor can be moved between different monitors when detached.

directx: bool | None#

Whether the plugin is a DirectX plugin or not.

disabled: bool | None#

This is a legacy property; DONโ€™T use it.

Check Channel.enabled or Slot.enabled instead.

generator: bool | None#

Whether the plugin is a generator or an effect.

height: int | None#

Height of the plugin editor (in pixels).

minimized: bool | None#

Whether the plugin editor is maximized or minimized.

multithreaded: bool | None#

Whether threaded processing is enabled or not.

page: WrapperPage | None#

Active / selected / current page.

smart_disable: bool | None#

Whether smart disable is enabled or not.

visible: bool | None#

Whether the editor of the plugin is visible or closed.

width: int | None#

Width of the plugin editor (in pixels).

class pyflp.plugin.PluginIOInfo[source]#
flags: int | None#

Properties obtained from a construct.Struct.

mixer_offset: int | None#

Properties obtained from a construct.Struct.

Enums#

class pyflp.plugin.WrapperPage[source]#
Editor = 0#

Plugin editor.

Envelope = 4#

Envelope / instrument settings.

Miscellaneous = 5#

Miscallenous functions.

Sample = 3#

Sample settings.

Settings = 1#

VST wrapper settings.

class pyflp.plugin.PluginID[source]#

IDs shared by pyflp.channel.Channel and pyflp.mixer.Slot.

Color = 128#
Icon = 155#
InternalName = 201#
Name = 203#

3.3.0+ for pyflp.mixer.Slot.

Wrapper = 212#
Data = 213#
https://img.shields.io/badge/FL%20Studio-1.6.5+-5f686d?labelColor=ff7629&style=for-the-badge