Bitwig Studio Control Surface API  5.0.11
DeviceChain Interface Reference
+ Inheritance diagram for DeviceChain:

Public Member Functions

void selectInEditor ()
 
SettableStringValue name ()
 
void addNameObserver (int numChars, String textWhenUnassigned, StringValueChangedCallback callback)
 
void addIsSelectedInEditorObserver (BooleanValueChangedCallback callback)
 
void addIsSelectedObserver (BooleanValueChangedCallback callback)
 
DeviceBank createDeviceBank (int numDevices)
 
Browser createDeviceBrowser (final int numFilterColumnEntries, final int numResultsColumnEntries)
 
void select ()
 
void browseToInsertAtStartOfChain ()
 
void browseToInsertAtEndOfChain ()
 
InsertionPoint startOfDeviceChainInsertionPoint ()
 
InsertionPoint endOfDeviceChainInsertionPoint ()
 
- Public Member Functions inherited from ObjectProxy
BooleanValue exists ()
 
BooleanValue createEqualsValue (ObjectProxy other)
 
- Public Member Functions inherited from Subscribable
boolean isSubscribed ()
 
void setIsSubscribed (boolean value)
 
void subscribe ()
 
void unsubscribe ()
 

Detailed Description

The foundation of all interfaces that contain devices, such as tracks, device layers, drum pads or FX slots.

Since
API version 1

Member Function Documentation

◆ addIsSelectedInEditorObserver()

void addIsSelectedInEditorObserver ( BooleanValueChangedCallback  callback)

Registers an observer that reports if the device chain is selected in Bitwig Studio editors.

Parameters
callbacka callback function that takes a single boolean parameter.
Since
API version 1

◆ addIsSelectedObserver()

void addIsSelectedObserver ( BooleanValueChangedCallback  callback)
Deprecated:
Use addIsSelectedInEditorObserver instead.
Since
API version 1

◆ addNameObserver()

void addNameObserver ( int  numChars,
String  textWhenUnassigned,
StringValueChangedCallback  callback 
)

Registers an observer that reports the name of the device chain, such as the track name or the drum pad name.

Parameters
numCharsthe maximum number of characters used for the reported name
textWhenUnassignedthe default text that gets reported when the device chain is not associated with an object in Bitwig Studio yet.
callbacka callback function that receives a single name parameter (string).
Since
API version 1
Deprecated:
Use name() instead.

◆ browseToInsertAtEndOfChain()

void browseToInsertAtEndOfChain ( )

Starts browsing for content that can be inserted at the end of this device chain.

Since
API version 2
Deprecated:
Use endOfDeviceChainInsertionPoint() instead.

◆ browseToInsertAtStartOfChain()

void browseToInsertAtStartOfChain ( )

Starts browsing for content that can be inserted at the start of this device chain.

Since
API version 2
Deprecated:
Use startOfDeviceChainInsertionPoint() instead.

◆ createDeviceBank()

DeviceBank createDeviceBank ( int  numDevices)

Returns an object that provides bank-wise navigation of devices.

Parameters
numDevicesthe number of devices should be accessible simultaneously
Returns
the requested device bank object
Since
API version 1

◆ createDeviceBrowser()

Browser createDeviceBrowser ( final int  numFilterColumnEntries,
final int  numResultsColumnEntries 
)

Returns an object used for browsing devices, presets and other content. Committing the browsing session will load or create a device from the selected resource and insert it into the device chain.

Parameters
numFilterColumnEntriesthe size of the window used to navigate the filter column entries.
numResultsColumnEntriesthe size of the window used to navigate the results column entries.
Returns
the requested device browser object.
Since
API version 1

◆ endOfDeviceChainInsertionPoint()

InsertionPoint endOfDeviceChainInsertionPoint ( )

InsertionPoint that can be used to insert at the end of the device chain.

Since
API version 7

◆ name()

Value that reports the name of the device chain, such as the track name or the drum pad name.

Since
API version 2

◆ select()

void select ( )
Deprecated:
Use selectInEditor() or Channel#selectInMixer() instead.
Since
API version 1

◆ selectInEditor()

void selectInEditor ( )

Selects the device chain in Bitwig Studio, in case it is a selectable object.

Since
API version 1

◆ startOfDeviceChainInsertionPoint()

InsertionPoint startOfDeviceChainInsertionPoint ( )

InsertionPoint that can be used to insert at the start of the device chain.

Since
API version 7

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