Control Surface API  2.2.2
ExtensionDefinition Class Referenceabstract
Inheritance diagram for ExtensionDefinition:

Public Member Functions

abstract String getName ()
 
abstract String getAuthor ()
 
abstract String getVersion ()
 
abstract UUID getId ()
 
abstract int getRequiredAPIVersion ()
 
String getHelpFilePath ()
 
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

abstract String getAuthor ( )
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 46 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 28 of file ExtensionDefinition.java.

abstract UUID getId ( )
abstract

A unique id that identifies this extension.

abstract String getName ( )
abstract

The name of the extension.

abstract int getRequiredAPIVersion ( )
abstract

The minimum API version number that this extensions requires.

abstract String getVersion ( )
abstract

The version of the extension.

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 37 of file ExtensionDefinition.java.


The documentation for this class was generated from the following file: