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 ()
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

Definition at line 12 of file DeviceChain.java.

Member Function Documentation

void addIsSelectedInEditorObserver

(

BooleanValueChangedCallback

callback

)

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

Parameters

callback

a callback function that takes a single boolean parameter.

Since

API version 1

void addIsSelectedObserver

(

BooleanValueChangedCallback

callback

)

Deprecated:

Use addIsSelectedInEditorObserver instead.

Since

API version 1

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

numChars	the maximum number of characters used for the reported name
textWhenUnassigned	the default text that gets reported when the device chain is not associated with an object in Bitwig Studio yet.
callback	a callback function that receives a single name parameter (string).

Since

API version 1

Deprecated:

Use name() instead.

void browseToInsertAtEndOfChain

(

)

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

Since

API version 2

void browseToInsertAtStartOfChain

(

)

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

Since

API version 2

DeviceBank createDeviceBank

(

int

numDevices

)

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

Parameters

numDevices

the number of devices should be accessible simultaneously

Returns

the requested device bank object @

Since

API version 1

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

numFilterColumnEntries	the size of the window used to navigate the filter column entries.
numResultsColumnEntries	the size of the window used to navigate the results column entries.

Returns

the requested device browser object.

Since

API version 1

SettableStringValue name

(

)

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

Since

API version 2

void select

(

)

Deprecated:

Use selectInEditor() or Channel#selectInMixer() instead.

Since

API version 1

void selectInEditor

(

)

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

Since

API version 1

---

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

• DeviceChain.java