Bitwig Studio Control Surface API  5.0.11
ControllerExtensionDefinition Class Referenceabstract
+ Inheritance diagram for ControllerExtensionDefinition:

Public Member Functions

String toString ()
 
abstract String getHardwareVendor ()
 
abstract String getHardwareModel ()
 
abstract int getNumMidiInPorts ()
 
abstract int getNumMidiOutPorts ()
 
final AutoDetectionMidiPortNamesList getAutoDetectionMidiPortNamesList (final PlatformType platformType)
 
abstract void listAutoDetectionMidiPortNames (AutoDetectionMidiPortNamesList list, PlatformType platformType)
 
final HardwareDeviceMatcherList getHardwareDeviceMatcherList ()
 
void listHardwareDevices (final HardwareDeviceMatcherList list)
 
abstract ControllerExtension createInstance (ControllerHost host)
 
- Public Member Functions inherited from ExtensionDefinition
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 ()
 

Detailed Description

Defines an extension that enabled a controller to work with Bitwig Studio.

Member Function Documentation

◆ createInstance()

abstract ControllerExtension createInstance ( ControllerHost  host)
abstract

Creates an instance of this extension.

◆ getAutoDetectionMidiPortNamesList()

final AutoDetectionMidiPortNamesList getAutoDetectionMidiPortNamesList ( final PlatformType  platformType)

Obtains a AutoDetectionMidiPortNamesList that defines the names of the MIDI in and out ports that can be used for auto detection of the controller for the supplied platform type.

◆ getHardwareModel()

abstract String getHardwareModel ( )
abstract

The model name of the controller that this extension is for.

◆ getHardwareVendor()

abstract String getHardwareVendor ( )
abstract

The vendor of the controller that this extension is for.

◆ getNumMidiInPorts()

abstract int getNumMidiInPorts ( )
abstract

The number of MIDI in ports that this controller extension has.

◆ getNumMidiOutPorts()

abstract int getNumMidiOutPorts ( )
abstract

The number of MIDI out ports that this controller extension has.

◆ listAutoDetectionMidiPortNames()

abstract void listAutoDetectionMidiPortNames ( AutoDetectionMidiPortNamesList  list,
PlatformType  platformType 
)
abstract

Lists the AutoDetectionMidiPortNames that defines the names of the MIDI in and out ports that can be used for auto detection of the controller for the supplied platform type.

◆ listHardwareDevices()

void listHardwareDevices ( final HardwareDeviceMatcherList  list)

Lists the hardware devices that this controller needs to function. For each device that is listed the user will see a chooser in the preferences for this extension that allows them to choose a connected device. The HardwareDeviceMatcher will also be used during auto detection to automatically add and select the device if possible.

Since
API version 7

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