|
Control Surface API
2.2.2
|

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) |
Public Member Functions inherited from Bank< Device > | |
| int | getSizeOfBank () |
| default void | scrollPageForwards () |
| default void | scrollPageBackwards () |
| ItemType | getItemAt (int index) |
| IntegerValue | itemCount () |
| SettableIntegerValue | cursorIndex () |
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.
Definition at line 17 of file DeviceBank.java.
| void addCanScrollDownObserver | ( | BooleanValueChangedCallback | callback | ) |
Registers an observer that reports if the device window can be scrolled further down.
| callback | a callback function that takes a single boolean parameter |
| void addCanScrollUpObserver | ( | BooleanValueChangedCallback | callback | ) |
Registers an observer that reports if the device window can be scrolled further up.
| callback | a callback function that takes a single boolean parameter |
| 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).
| callback | a callback function that receives a single integer parameter |
| void addScrollPositionObserver | ( | IntegerValueChangedCallback | callback, |
| int | valueWhenUnassigned | ||
| ) |
Registers an observer that reports the current device scroll position.
| callback | a callback function that takes a single integer parameter |
| valueWhenUnassigned | the default value that gets reports when the device chain is not yet connected to a Bitwig Studio document |
| void browseToInsertDevice | ( | int | index | ) |
Browses for content to insert a device at the given index inside this bank.
| index | the index to insert the device at. Must be >= 0 and <= getSizeOfBank(). |
| Device getDevice | ( | int | indexInBank | ) |
Returns the device at the given index within the bank.
| indexInBank | the device index within this bank, not the position within the device chain. Must be in the range [0..sizeOfBank-1]. |
| 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.
| void scrollDown | ( | ) |
Scrolls the device window one device down.
| void scrollPageDown | ( | ) |
Scrolls the device window one page down.
| void scrollPageUp | ( | ) |
Scrolls the device window one page up.
| void scrollTo | ( | int | position | ) |
Makes the device with the given position visible in the track bank.
| position | the position of the device within the device chain |
| void scrollUp | ( | ) |
Scrolls the device window one device up.