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

Public Member Functions

DeviceChain getDeviceChain ()
 
Device getDevice (int indexInBank)
 
void scrollPageUp ()
 
void scrollPageDown ()
 
void scrollUp ()
 
void scrollDown ()
 
void scrollTo (int position)
 
void addScrollPositionObserver (IntegerValueChangedCallback callback, int valueWhenUnassigned)
 
void addCanScrollUpObserver (BooleanValueChangedCallback callback)
 
void addCanScrollDownObserver (BooleanValueChangedCallback callback)
 
void addDeviceCountObserver (IntegerValueChangedCallback callback)
 
void browseToInsertDevice (int index)
 
void setDeviceMatcher (DeviceMatcher matcher)
 
- Public Member Functions inherited from Bank< Device >
int getSizeOfBank ()
 
int getCapacityOfBank ()
 
void setSizeOfBank (int size)
 
default void scrollPageForwards ()
 
default void scrollPageBackwards ()
 
ItemType getItemAt (int index)
 
IntegerValue itemCount ()
 
SettableIntegerValue cursorIndex ()
 
void setSkipDisabledItems (boolean shouldSkip)
 

Detailed Description

This interface is used for navigation of device chains in Bitwig Studio. Instances are configured with a fixed number of devices and provide access to a excerpt of the devices inside a device chain. Various methods are provided for scrolling to different sections of the device chain. It basically acts like a window moving over the devices.

To receive an instance of DeviceBank call Track#createDeviceBank.

See also
Track#createDeviceBank
Since
API version 1

Member Function Documentation

◆ addCanScrollDownObserver()

void addCanScrollDownObserver ( BooleanValueChangedCallback  callback)

Registers an observer that reports if the device window can be scrolled further down.

Parameters
callbacka callback function that takes a single boolean parameter
Since
API version 1
Deprecated:
Use canScrollForwards() instead.

◆ addCanScrollUpObserver()

void addCanScrollUpObserver ( BooleanValueChangedCallback  callback)

Registers an observer that reports if the device window can be scrolled further up.

Parameters
callbacka callback function that takes a single boolean parameter
Since
API version 1
Deprecated:
Use canScrollBackwards() instead.

◆ addDeviceCountObserver()

void addDeviceCountObserver ( IntegerValueChangedCallback  callback)

Registers an observer that reports the total device count of the device chain (not the number of devices accessible through the bank window).

Parameters
callbacka callback function that receives a single integer parameter
Since
API version 1
Deprecated:
Use deviceCount().addValueObserver(callback)

◆ addScrollPositionObserver()

void addScrollPositionObserver ( IntegerValueChangedCallback  callback,
int  valueWhenUnassigned 
)

Registers an observer that reports the current device scroll position.

Parameters
callbacka callback function that takes a single integer parameter
valueWhenUnassignedthe default value that gets reports when the device chain is not yet connected to a Bitwig Studio document
Since
API version 1
Deprecated:
Use scrollPosition() instead.

◆ browseToInsertDevice()

void browseToInsertDevice ( int  index)

Browses for content to insert a device at the given index inside this bank.

Parameters
indexthe index to insert the device at. Must be >= 0 and <= getSizeOfBank().
Since
API version 2

◆ getDevice()

Device getDevice ( int  indexInBank)

Returns the device at the given index within the bank.

Parameters
indexInBankthe device index within this bank, not the position within the device chain. Must be in the range [0..sizeOfBank-1].
Returns
the requested device object
Since
API version 1

◆ getDeviceChain()

DeviceChain getDeviceChain ( )

Returns the object that was used to instantiate this device bank. Possible device chain instances are tracks, device layers, drums pads, or FX slots.

Returns
the requested device chain object
Since
API version 1

◆ scrollDown()

void scrollDown ( )

Scrolls the device window one device down.

Since
API version 1

◆ scrollPageDown()

void scrollPageDown ( )

Scrolls the device window one page down.

Since
API version 1

◆ scrollPageUp()

void scrollPageUp ( )

Scrolls the device window one page up.

Since
API version 1

◆ scrollTo()

void scrollTo ( int  position)

Makes the device with the given position visible in the track bank.

Parameters
positionthe position of the device within the device chain
Since
API version 1
Deprecated:
Use scrollIntoView(int) instead

◆ scrollUp()

void scrollUp ( )

Scrolls the device window one device up.

Since
API version 1

◆ setDeviceMatcher()

void setDeviceMatcher ( DeviceMatcher  matcher)

Sets a DeviceMatcher that can be used to filter devices in this bank to show only those matching the supplied matcher.

Parameters
matcherThe matcher that should filter the devices or null if all devices should be matched
Since
API version 12

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