Bitwig Studio Control Surface API
5.0.11
|
Public Member Functions | |
int | getSize () |
GenericBrowsingSession | getSession (int index) |
void | scrollUp () |
void | scrollDown () |
void | scrollPageUp () |
void | scrollPageDown () |
void | addScrollPositionObserver (IntegerValueChangedCallback callback) |
void | addCanScrollUpObserver (BooleanValueChangedCallback callback) |
void | addCanScrollDownObserver (BooleanValueChangedCallback callback) |
void | addEntryCountObserver (IntegerValueChangedCallback callback) |
![]() | |
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) |
Instances of this interface are used to navigate the available sessions in Bitwig Studio's contextual browser. The sessions are shown as tabs in the graphical user interface of the browser.
void addCanScrollDownObserver | ( | BooleanValueChangedCallback | callback | ) |
Registers an observer that reports if the browser sessions can be scrolled further down.
callback | a callback function that receives a single boolean parameter |
void addCanScrollUpObserver | ( | BooleanValueChangedCallback | callback | ) |
Registers an observer that reports if the browser sessions can be scrolled further up.
callback | a callback function that receives a single boolean parameter |
void addEntryCountObserver | ( | IntegerValueChangedCallback | callback | ) |
Registers an observer that reports the underlying total count of browser sessions (not the size of the window).
callback | a callback function that receives a single integer parameter |
void addScrollPositionObserver | ( | IntegerValueChangedCallback | callback | ) |
Registers an observer that reports the current scroll position, more specifically the position of the first item within the underlying list of browser sessions, that is shown as the first session within the window.
callback | a callback function that receives a single integer number parameter. The parameter reflects the scroll position, or -1 in case the column has no content. |
GenericBrowsingSession getSession | ( | int | index | ) |
Returns the browser session for the given index.
index | the session index, must be in the range [0..getSize-1] |
int getSize | ( | ) |
Returns the window size that was used to configure the session bank during creation.
void scrollDown | ( | ) |
Scrolls the browser sessions one item down.
void scrollPageDown | ( | ) |
Scrolls the filter columns one page up. For example if the bank is configured with a window size of 8 entries and is currently showing items [9..16], calling this method would scroll the window to show items [1..8].
void scrollPageUp | ( | ) |
Scrolls the browser sessions one page up. For example if the bank is configured with a window size of 8 entries and is currently showing items [1..8], calling this method would scroll the window to show items [9..16].
void scrollUp | ( | ) |
Scrolls the browser sessions one item up.