Skip to content

Commit

Permalink
feat: fruity wrapper flags via #95
Browse files Browse the repository at this point in the history
  • Loading branch information
demberto committed Oct 27, 2022
1 parent e37f760 commit 807a17e
Show file tree
Hide file tree
Showing 9 changed files with 413 additions and 98 deletions.
3 changes: 3 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- Improve enum performance by using `f-enum` library (`pyflp.parse` is 50% faster).
- `Time.gate`, `Time.shift` and `Time.full_porta` [#89].
- *Experimental* Python 3.11 support is back.
- A shit ton of flags in `VSTPlugin` and refactoring [#95].

### Changed

Expand All @@ -31,6 +32,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- Rename `PlaylistItemBase` to `PLItemBase` and `PatternPlaylistItem` to `PatternPLItem`.
- Rename `Polyphony` members `is_mono` to `mono` and `is_porta` to `porta`.
- `NoModelsFound` also bases `LookupError` now.
- Compiled `VSTPluginEvent.STRUCT`.

### Fixed

Expand All @@ -40,6 +42,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

- `PlaylistItemBase.start_offset` and `PlaylistItemBase.end_offset`.
- Redundant exceptions `ExpectedValue`, `UnexpectedType`.
- Undiscovered `num_inputs`, `num_outputs` and `vst_number` from `VSTPlugin`.

[#55]: https://github.com/demberto/PyFLP/issues/55
[#84]: https://github.com/demberto/PyFLP/issues/84
Expand Down
Binary file added docs/img/plugin/wrapper/settings-gui.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/plugin/wrapper/settings-midi.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
57 changes: 40 additions & 17 deletions docs/reference/plugins.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,23 +4,6 @@
.. module:: pyflp.plugin
.. autoclass:: _PluginBase
:members:
.. autoclass:: VSTPlugin
:members:

.. tab-set::

.. tab-item:: Settings

.. image:: /img/plugin/wrapper/settings.png

.. tab-item:: Processing

.. image:: /img/plugin/wrapper/processing.png

.. tab-item:: Troubleshooting

.. image:: /img/plugin/wrapper/troubleshooting.png

.. autoclass:: PluginIOInfo
:members:

Expand Down Expand Up @@ -50,6 +33,46 @@ Effects
.. autoclass:: Soundgoodizer
:members:

VST
---

.. autoclass:: VSTPlugin
:members:

.. tab-set::

.. tab-item:: Settings

.. image:: /img/plugin/wrapper/settings.png

.. autoclass:: pyflp.plugin::VSTPlugin._AutomationOptions
:members:
.. autoclass:: pyflp.plugin::VSTPlugin._MIDIOptions
:members:
.. autoclass:: pyflp.plugin::VSTPlugin._UIOptions
:members:

.. tab-item:: Processing

.. image:: /img/plugin/wrapper/processing.png

.. autoclass:: pyflp.plugin::VSTPlugin._ProcessingOptions
:members:

.. tab-item:: Troubleshooting

.. image:: /img/plugin/wrapper/troubleshooting.png

.. autoclass:: pyflp.plugin::VSTPlugin._CompatibilityOptions
:members:


Enums
-----

.. autoclass:: WrapperPage
:members:

Event IDs
---------

Expand Down
5 changes: 4 additions & 1 deletion pyflp/arrangement.py
Original file line number Diff line number Diff line change
Expand Up @@ -566,7 +566,10 @@ def current(self) -> Arrangement | None:
raise ModelNotFound(index) from exc

loop_pos = EventProp[int](ArrangementsID.LoopPos)
"""*New in FL Studio v1.3.8*."""
"""Playlist loop start and end points,
*New in FL Studio v1.3.8*.
"""

@property
def max_tracks(self) -> Literal[500, 199]:
Expand Down
Loading

0 comments on commit 807a17e

Please sign in to comment.