Bitwig Studio Control Surface API
5.0.11
|
Public Member Functions | |
Scene | getScene (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 | addSceneCountObserver (IntegerValueChangedCallback callback) |
void | launchScene (int indexInWindow) |
void | setIndication (boolean shouldIndicate) |
![]() | |
void | launch (int slot) |
void | launchAlt (int slot) |
void | stop () |
void | stopAlt () |
HardwareActionBindable | stopAction () |
HardwareActionBindable | stopAltAction () |
void | returnToArrangement () |
void | addNameObserver (IndexedStringValueChangedCallback callback) |
A scene bank provides access to a range of scenes in Bitwig Studio. Instances of scene bank are configured with a fixed number of scenes and represent an excerpt of a larger list of scenes. Various methods are provided for scrolling to different sections of the scene list. It basically acts like a window moving over the list of underlying scenes.
To receive an instance of scene bank call com.bitwig.extension.controller.api.ControllerHost#createSceneBank.
void addCanScrollDownObserver | ( | BooleanValueChangedCallback | callback | ) |
Registers an observer that reports if the scene 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 scene window can be scrolled further up.
callback | a callback function that takes a single boolean parameter |
void addSceneCountObserver | ( | IntegerValueChangedCallback | callback | ) |
Registers an observer that reports the underlying total scene count (not the number of scenes available in 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 scene scroll position.
callback | a callback function that takes a single integer parameter |
valueWhenUnassigned | the default value that gets reports when the track bank is not yet connected to a Bitwig Studio document |
Scene getScene | ( | int | indexInBank | ) |
Returns the scene at the given index within the bank.
indexInBank | the scene index within this bank, not the index within the list of all Bitwig Studio scenes. Must be in the range [0..sizeOfBank-1]. |
void launchScene | ( | int | indexInWindow | ) |
Launches the scene with the given bank index.
indexInWindow | the scene index within the bank, not the position of the scene withing the underlying full list of scenes. |
void scrollDown | ( | ) |
void scrollPageDown | ( | ) |
void scrollPageUp | ( | ) |
void scrollTo | ( | int | position | ) |
Makes the scene with the given position visible in the track bank.
position | the position of the scene within the underlying full list of scenes |
void scrollUp | ( | ) |
void setIndication | ( | boolean | shouldIndicate | ) |
Specifies if the Bitwig Studio clip launcher should indicate which scenes are part of the window. By default indications are disabled.
shouldIndicate | true if visual indications should be enabled, false otherwise |