This project is a template/example for building Drumstick::RT plugins, as an out-of-tree 1 project.
There are already a number of in-tree Drumstick::RT plugins, the Dummy ones among them. Nothing forbids to build and distribute other independent plugins, and this project may be a template for that projects.
The rules for creating and deploying Drumstick::RT plugins are the same as other Qt Plugins. Deployment rules mandate that plugins must share the same build and runtime Qt library major version with the applications using the plugins, and not be built with a higher minor version.
A plugin may implement MIDI OUT or MIDI IN functionality for applications. To do so, the plugins must extend either the MIDIOutput or the MIDIInput interfaces.
You may want to read also the documentation about Drumstick and some of the utilities and examples.
Two plugins are included here: drumstick-rt-dummy-in and drumstick-rt-dummy-out, that implement the MIDIInput and MIDIOutput interfaces respectively, but without functionality.
When installed, both plugins should be found and used by any Drumstick::RT based application, like VMPK and dmidiplayer.
External RT plugins may have their own configuration dialogs and be developed and distributed like the in-tree ones. The same rules and functions for configuration dialogs should apply to them.
The plugins including an internal configuration dialog should expose the property:
Q_PROPERTY(bool isconfigurable ...)
And also a public slot with this name and signature:
bool configure(QWidget *parent);
Use this template to write your own plugins and enjoy!
Footnotes
-
Located outside of a source tree. Antonym: in-tree. (Definition source). This software engineering term was originated in the Linux kernel development community, probably as a pun. ↩