Bitwig Studio Control Surface API
5.0.11
|
Public Member Functions | |
void | addIsAvailableObserver (BooleanValueChangedCallback callback) |
void | addIsActiveObserver (BooleanValueChangedCallback callback) |
void | activate () |
BrowserResultsColumn | getResults () |
CursorBrowserResultItem | getCursorResult () |
BrowserResultsItem | getSettledResult () |
CursorBrowserFilterColumn | getCursorFilter () |
BrowserFilterColumnBank | createFilterBank (int numColumns) |
IntegerValue | hitCount () |
void | addHitCountObserver (IntegerValueChangedCallback callback) |
![]() | |
BooleanValue | exists () |
BooleanValue | createEqualsValue (ObjectProxy other) |
![]() | |
boolean | isSubscribed () |
void | setIsSubscribed (boolean value) |
void | subscribe () |
void | unsubscribe () |
Instances of this interface are used for browsing material according to a certain type. Possible material types are devices, presets, samples, multi-samples, clips, or files from your music collection.
In Bitwig Studio's contextual browser window the search sessions for the various material kinds are shown in tabs. Just like the tabs in the browser window, instances of this interface provide access to multiple filter columns and one result column. The filter columns are used to control the content of the results column.
void activate | ( | ) |
Activates the given search session, same as calling Browser#activateSession(this). Please note that only one search session can be active at a time.
void addHitCountObserver | ( | IntegerValueChangedCallback | callback | ) |
Registers an observer that reports the number of results available for the current filter settings.
callback | a callback function that receives a single integer argument. |
void addIsActiveObserver | ( | BooleanValueChangedCallback | callback | ) |
Registers an observer that reports if the browser session is currently active.
callback | a callback function that receives a single boolean argument. |
void addIsAvailableObserver | ( | BooleanValueChangedCallback | callback | ) |
Registers an observer that reports if the browser session is available for the current context.
callback | a callback function that receives a single boolean argument. |
BrowserFilterColumnBank createFilterBank | ( | int | numColumns | ) |
Returns an object that provided bank-wise navigation of filter columns.
numColumns | the number of columns that are simultaneously accessible. |
CursorBrowserFilterColumn getCursorFilter | ( | ) |
Returns an object that can be used to navigate over the various filter sections of the browsing session.
CursorBrowserResultItem getCursorResult | ( | ) |
Returns an object used for navigating the entries in the results column of Bitwig Studio's contextual browser.
BrowserResultsColumn getResults | ( | ) |
Returns an object that represents the column which shows the results according to the current filter settings in Bitwig Studio's contextual browser.
BrowserResultsItem getSettledResult | ( | ) |
Returns an object that represents the currently loaded material item.
IntegerValue hitCount | ( | ) |
Value that reports the number of results available for the current filter settings.