Bitwig Studio Control Surface API
5.0.11
|
A track bank provides access to a range of tracks and their scenes (clip launcher slots) in Bitwig Studio. Instances of track bank are configured with a fixed number of tracks and scenes and represent an excerpt of a larger list of tracks and scenes. Various methods are provided for scrolling to different sections of the track/scene list. It basically acts like a 2-dimensional window moving over the grid of tracks and scenes.
To receive an instance of track bank that supports all kinds of tracks call ControllerHost#createTrackBank. Additional methods are provided in the ControllerHost interface to create track banks that include only main tracks (ControllerHost#createMainTrackBank) or only effect tracks (ControllerHost#createEffectTrackBank).
void addCanScrollScenesDownObserver | ( | 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 addCanScrollScenesUpObserver | ( | 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 addCanScrollTracksDownObserver | ( | BooleanValueChangedCallback | callback | ) |
void addCanScrollTracksUpObserver | ( | BooleanValueChangedCallback | callback | ) |
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 addSceneScrollPositionObserver | ( | 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 |
void addTrackScrollPositionObserver | ( | IntegerValueChangedCallback | callback, |
int | valueWhenUnassigned | ||
) |
void followCursorTrack | ( | CursorTrack | cursorTrack | ) |
Causes this bank to follow the supplied cursor. When the cursor moves to a new item the bank will be scrolled so that the cursor is within the bank, if possible.
cursorTrack | The CursorTrack that this bank should follow. |
Track getChannel | ( | int | indexInBank | ) |
Returns the track at the given index within the bank.
indexInBank | the track index within this bank, not the index within the list of all Bitwig Studio tracks. Must be in the range [0..sizeOfBank-1]. |
ClipLauncherSlotOrSceneBank getClipLauncherScenes | ( | ) |
Returns an object that provides access to the clip launcher scenes of the track bank.
Track getTrack | ( | int | indexInBank | ) |
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. |
SceneBank sceneBank | ( | ) |
void scrollScenesDown | ( | ) |
void scrollScenesPageDown | ( | ) |
void scrollScenesPageUp | ( | ) |
void scrollScenesUp | ( | ) |
void scrollToScene | ( | 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 scrollToTrack | ( | int | position | ) |
void scrollTracksDown | ( | ) |
void scrollTracksPageDown | ( | ) |
void scrollTracksPageUp | ( | ) |
void scrollTracksUp | ( | ) |
void setShouldShowClipLauncherFeedback | ( | boolean | value | ) |
Decides if Bitwig Studio's clip launcher should indicate the area being controlled by this controller or not.
void setTrackScrollStepSize | ( | int | stepSize | ) |