Bitwig Studio Control Surface API  5.0.11
BrowsingSession Interface Reference
+ Inheritance diagram for BrowsingSession:

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)
 
- Public Member Functions inherited from ObjectProxy
BooleanValue exists ()
 
BooleanValue createEqualsValue (ObjectProxy other)
 
- Public Member Functions inherited from Subscribable
boolean isSubscribed ()
 
void setIsSubscribed (boolean value)
 
void subscribe ()
 
void unsubscribe ()
 

Detailed Description

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.

Since
API version 1
Deprecated:
Use PopupBrowser instead.

Member Function Documentation

◆ activate()

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.

Since
API version 1
See also
Browser::activateSession

◆ addHitCountObserver()

void addHitCountObserver ( IntegerValueChangedCallback  callback)

Registers an observer that reports the number of results available for the current filter settings.

Parameters
callbacka callback function that receives a single integer argument.
Since
API version 1
Deprecated:
Use hitCount() instead.

◆ addIsActiveObserver()

void addIsActiveObserver ( BooleanValueChangedCallback  callback)

Registers an observer that reports if the browser session is currently active.

Parameters
callbacka callback function that receives a single boolean argument.
Since
API version 1

◆ addIsAvailableObserver()

void addIsAvailableObserver ( BooleanValueChangedCallback  callback)

Registers an observer that reports if the browser session is available for the current context.

Parameters
callbacka callback function that receives a single boolean argument.
Since
API version 1
Deprecated:
Use exists() instead.

◆ createFilterBank()

BrowserFilterColumnBank createFilterBank ( int  numColumns)

Returns an object that provided bank-wise navigation of filter columns.

Returns
the requested file column bank object
Since
API version 1
Parameters
numColumnsthe number of columns that are simultaneously accessible.

◆ getCursorFilter()

CursorBrowserFilterColumn getCursorFilter ( )

Returns an object that can be used to navigate over the various filter sections of the browsing session.

Returns
the requested filter cursor object

◆ getCursorResult()

CursorBrowserResultItem getCursorResult ( )

Returns an object used for navigating the entries in the results column of Bitwig Studio's contextual browser.

Returns
the requested cursor object.
Since
API version 1

◆ getResults()

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.

Returns
the requested results browser column.
Since
API version 1

◆ getSettledResult()

BrowserResultsItem getSettledResult ( )

Returns an object that represents the currently loaded material item.

Returns
the requested settled result object
Since
API version 1

◆ hitCount()

IntegerValue hitCount ( )

Value that reports the number of results available for the current filter settings.

Since
API version 2

The documentation for this interface was generated from the following file: