Module and function definitions and documentation for the FL Studio Python API
Project description
FL Studio MIDI Python API
This project contains simple stub functions to provide intellisense while working on scripts for FL Studio's MIDI Python API.
Currently, it only provides function definitions and docstrings, but these functions don't do anything. It is NOT a complete testing framework, and it cannot guarantee your script will work correctly. However, it may help you to resolve issues with incorrect function calls when interacting with the API.
Important Note
Although the stubs are mostly complete, there are a few functions where I don't
fully understand how they work. These functions have a HELP WANTED:
label in
their documentation. If you happen to know how to use one, I'd love it if you
helped out by improving the documentation!
Differences to Official Implementation
A small number of tweaks have been made to these stubs in order to ease code writing. These shouldn't have any functional impact on the behaviour of the API compared to the implied behaviour from the stubs, but should help clarify some properties of certain functions.
- Functions whose returns are boolean by nature are listed as returning a
bool
type, even though the implementation returns the integers0
and1
. This change should help to describe the context in which the functions should be called when writing scripts, which in a language like Python is far more important than the actual implementation of the functions.
Installation
To avoid module conflicts with other Python projects, it is recommended that you install this script in a virtual environment by following these instructions in the official Python documentation.
After activating the environment in your editor, you can install the stub
modules by running the command pip install FL-Studio-API-Stubs
on Windows or
pip3 install FL-Studio-API-Stubs
on MacOS or Linux.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for FL_Studio_API_Stubs-14.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 44587d4fea3a2ce1a8b114843fcce25eb8a185493a8e864742a5c8b12b15082c |
|
MD5 | 7f8df55dfc1cbe4c12879edd94a1d0a8 |
|
BLAKE2b-256 | 4eae9e29e94af5a5efd5cc877910dcb32481fcc9ec1aff218eef11529b9af21e |