Inheritance diagram for ExtensionDefinition:
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 () |
Detailed Description
Base class for defining any kind of extension for Bitwig Studio.
Definition at line 6 of file ExtensionDefinition.java.
Member Function Documentation
◆ getAuthor()
|
abstract |
The author of the extension.
◆ getErrorReportingEMail()
| 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 75 of file ExtensionDefinition.java.
◆ getHelpFilePath()
| 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.
Definition at line 43 of file ExtensionDefinition.java.
◆ getId()
|
abstract |
A unique id that identifies this extension.
◆ getName()
|
abstract |
The name of the extension.
◆ getRequiredAPIVersion()
|
abstract |
The minimum API version number that this extensions requires.
◆ getSupportFolderPath()
| 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.
- Since
- API version 13
Definition at line 57 of file ExtensionDefinition.java.
◆ getVersion()
|
abstract |
The version of the extension.
◆ isUsingBetaAPI()
| 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.
- Returns
- true if the extension wants to use Beta APIs.
Definition at line 33 of file ExtensionDefinition.java.
◆ shouldFailOnDeprecatedUse()
| 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 66 of file ExtensionDefinition.java.
The documentation for this class was generated from the following file: