This interface is implemented by synthclone
plugins.
More...
#include <synthclone/iplugin.h>
This interface is implemented by synthclone
plugins.
virtual synthclone::IPlugin::~IPlugin |
( |
| ) |
|
|
inlinevirtual |
virtual QByteArray synthclone::IPlugin::getId |
( |
| ) |
const |
|
pure virtual |
Gets the root Participant id.
The id is used to identify Participant objects, to create child Participant ids, and to save/load Participant and Component data.
- Valid Participant Identifiers
- A valid Participant id is a dot-delimited string containing one or more sub-id parts. Each sub-id part must start and end with a number or letter, and contain only numbers, letters, and hyphens.
- The following ids are considered valid:
- The following ids are considered invalid:
- a.
- .a.b
- a..b
- a.b.
- a.-b
- a.-
- -
- Identifier Recommendations
- Ids should be formatted using the following sub-ids:
- A top-level domain appropriate to the plugin distributor.
- A sub-domain appropriate to the plugin distributor.
- The sub-id 'synthclone'.
- The sub-id 'plugins'.
- A sub-id containing the name of the plugin.
- For example, a plugin named 'test' created by a developer from 'example.com' would have the id 'com.example.synthclone.plugins.test'.
- Ids of plugins distributed within synthclone will take the form 'com.googlecode.synthclone.plugins.[name]'.
- Ids of the form 'com.googlecode.synthclone.*' are reserved for future use.
- Returns
- The root Participant id.
virtual Participant* synthclone::IPlugin::getParticipant |
( |
| ) |
|
|
pure virtual |
Gets the root Participant for this plugin.
The root Participant will be registered with the application.
- Returns
- The root participant.
The documentation for this class was generated from the following file: