Bitwig Studio Control Surface API
5.0.11
|
Public Member Functions | |
abstract String | getName () |
abstract String | getAuthor () |
abstract String | getVersion () |
abstract UUID | getId () |
abstract int | getRequiredAPIVersion () |
boolean | isUsingBetaAPI () |
String | getHelpFilePath () |
String | getSupportFolderPath () |
boolean | shouldFailOnDeprecatedUse () |
String | getErrorReportingEMail () |
String | toString () |
Base class for defining any kind of extension for Bitwig Studio.
|
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.
String getHelpFilePath | ( | ) |
Gets a remote URI or a path within the extension's jar file where documentation for this extension can be found or null if there is none. If the path is not a URI then it is assumed to be a path below the directory "Documentation" within the extension's jar file.
|
abstract |
A unique id that identifies this extension.
|
abstract |
The name of the extension.
|
abstract |
The minimum API version number that this extensions requires.
String getSupportFolderPath | ( | ) |
Gets a remote URI or a path within the extension's jar file where support files for this extension can be found or null if there is none. If the path is not a URI then it is assumed to be a path below the directory "Documentation" within the extension's jar file.
Support files are for example a configuration file that one has use with a configuration software.
|
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.
boolean shouldFailOnDeprecatedUse | ( | ) |
If true then this extension should fail when it calls a deprecated method in the API. This is useful during development.