|
Control Surface API
3.0.3
|
|
Control Surface API
3.0.3
|
Public Member Functions | |
| abstract String | getName () |
| abstract String | getAuthor () |
| abstract String | getVersion () |
| abstract UUID | getId () |
| abstract int | getRequiredAPIVersion () |
| boolean | isUsingBetaAPI () |
| String | getHelpFilePath () |
| boolean | shouldFailOnDeprecatedUse () |
| String | getErrorReportingEMail () |
| String | toString () |
Base class for defining any kind of extension for Bitwig Studio.
Definition at line 6 of file ExtensionDefinition.java.
|
abstract |
The author of the extension.
| String getErrorReportingEMail | ( | ) |
An e-mail address that can be used to contact the author of this extension if a problem is detected with it or null if none.
Definition at line 61 of file ExtensionDefinition.java.
| String getHelpFilePath | ( | ) |
Gets a path within the extension's jar file where documentation for this extension can be found or null if there is none. At the moment this file needs to be a PDF file but other file formats maybe supported in the future.
Definition at line 43 of file ExtensionDefinition.java.
|
abstract |
A unique id that identifies this extension.
|
abstract |
The name of the extension.
|
abstract |
The minimum API version number that this extensions requires.
|
abstract |
The version of the extension.
| boolean isUsingBetaAPI | ( | ) |
Is this extension is using Beta APIs?
Beta APIs are still on development and might not be available in a future version of Bitwig Studio.
Turning this flag to true, will flag your extension as being a beta extension which might not work after updating Bitwig Studio.
Definition at line 33 of file ExtensionDefinition.java.
| boolean shouldFailOnDeprecatedUse | ( | ) |
If true then this extension should fail when it calls a deprecated method in the API. This is useful during development.
Definition at line 52 of file ExtensionDefinition.java.
