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

Public Member Functions

void addIsBrowsingObserver (BooleanValueChangedCallback callback)
 
void startBrowsing ()
 
void cancelBrowsing ()
 
void commitSelectedResult ()
 
void activateSession (BrowsingSession session)
 
SettableBooleanValue isWindowMinimized ()
 
SettableBooleanValue shouldAudition ()
 
BrowsingSessionBank createSessionBank (int size)
 
CursorBrowsingSession createCursorSession ()
 
DeviceBrowsingSession getDeviceSession ()
 
PresetBrowsingSession getPresetSession ()
 
SampleBrowsingSession getSampleSession ()
 
MultiSampleBrowsingSession getMultiSampleSession ()
 
ClipBrowsingSession getClipSession ()
 
MusicBrowsingSession getMusicSession ()
 
- 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 represent a contextual browser in Bitwig Studio.

Since
API version 1
Deprecated:
Use PopupBrowser instead.

Member Function Documentation

◆ activateSession()

void activateSession ( BrowsingSession  session)

Activates the given search session. Please note that only one search session can be active at a time.

Parameters
sessionthe session that should be activated.
Since
API version 1

◆ addIsBrowsingObserver()

void addIsBrowsingObserver ( BooleanValueChangedCallback  callback)

Registers an observer that reports if a browsing session was started.

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

◆ cancelBrowsing()

void cancelBrowsing ( )

Cancels the current browser session.

Since
API version 1

◆ commitSelectedResult()

void commitSelectedResult ( )

Finished the browser session by loading the selected item.

Since
API version 1

◆ createCursorSession()

CursorBrowsingSession createCursorSession ( )

Returns an object that represents the selected tab as shown in Bitwig Studio's contextual browser window.

Returns
the requested browsing session cursor
Since
API version 1

◆ createSessionBank()

BrowsingSessionBank createSessionBank ( int  size)

Returns an object that provided bank-wise navigation of the available search sessions. Each search session is dedicated to a certain material type, as shown in the tabs of Bitwig Studio's contextual browser.

Parameters
sizethe size of the windows used to navigate the available browsing sessions.
Returns
the requested file column bank object
Since
API version 1

◆ getClipSession()

ClipBrowsingSession getClipSession ( )

Returns an object that provides access to the contents of the clips tab as shown in Bitwig Studio's contextual browser window.

Returns
the requested clip browsing session instance
Since
API version 1

◆ getDeviceSession()

DeviceBrowsingSession getDeviceSession ( )

Returns an object that provides access to the contents of the device tab as shown in Bitwig Studio's contextual browser window.

Returns
the requested device browsing session instance
Since
API version 1

◆ getMultiSampleSession()

MultiSampleBrowsingSession getMultiSampleSession ( )

Returns an object that provides access to the contents of the multi-samples tab as shown in Bitwig Studio's contextual browser window.

Returns
the requested multi-sample browsing session instance
Since
API version 1

◆ getMusicSession()

MusicBrowsingSession getMusicSession ( )

Returns an object that provides access to the contents of the music tab as shown in Bitwig Studio's contextual browser window.

Returns
the requested music browsing session instance
Since
API version 1

◆ getPresetSession()

PresetBrowsingSession getPresetSession ( )

Returns an object that provides access to the contents of the preset tab as shown in Bitwig Studio's contextual browser window.

Returns
the requested preset browsing session instance
Since
API version 1

◆ getSampleSession()

SampleBrowsingSession getSampleSession ( )

Returns an object that provides access to the contents of the samples tab as shown in Bitwig Studio's contextual browser window.

Returns
the requested sample browsing session instance
Since
API version 1

◆ isWindowMinimized()

SettableBooleanValue isWindowMinimized ( )

Return an object allows to observe and control if the browser window should be small or full-sized.

Returns
a boolean value object
Since
API version 1

◆ shouldAudition()

SettableBooleanValue shouldAudition ( )

Return an object allows to observe and control if the selected result should be auditioned.

Returns
a boolean value object
Since
API version 1

◆ startBrowsing()

void startBrowsing ( )

Starts a new browser session.

Since
API version 1

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