This guide assumes that a development environment with all required dependencies has been set-up. Check the “hacking on score” guide for more information on how to do that.
ossia score provides two plug-in APIs:
A simple API that can be used to implement quick audio / midi / control effects and generators in a single file.
This is the API to use if you want to provide for instance a new audio or video processor to use as an ossia object.
The documentation of the Avendish API is available here: note in particular that the plug-ins written with Avendish are independent from ossia score and can also be exported to other systems, such as VST, etc. ossia score is however the implementation that provides most of the features :-)
Read the score avendish plug-in documentation to get started.
A more advanced API that allows to customize pretty much every aspect of the software, but requires more work.
The major part of the software is built with that API: every process in score comes from plug-ins. These plug-ins are located in the score git repository.
To develop new plug-ins that way, we provide a set of Github templates. Simply create a repository from the template, and follow the steps in the README.
A simple API that can be used to implement quick audio / midi / control effects and generators in a single file. Replaced by the Avendish API which is strictly superior in all points.
Processes implemented with that API are available at the following address.
To create a new plug-in, simply duplicate one of the files, change the metadata (name, UUID, etc. to differentiate it from other score plug-ins), and add it to the list in this file.
When building score again, the plug-in should appear in the process list.