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

Public Member Functions

StringValue title ()
 
StringArrayValue contentTypeNames ()
 
StringValue selectedContentTypeName ()
 
SettableIntegerValue selectedContentTypeIndex ()
 
BrowserFilterColumn smartCollectionColumn ()
 
BrowserFilterColumn locationColumn ()
 
BrowserFilterColumn deviceColumn ()
 
BrowserFilterColumn categoryColumn ()
 
BrowserFilterColumn tagColumn ()
 
BrowserFilterColumn deviceTypeColumn ()
 
BrowserFilterColumn fileTypeColumn ()
 
BrowserFilterColumn creatorColumn ()
 
BrowserResultsColumn resultsColumn ()
 
BooleanValue canAudition ()
 
SettableBooleanValue shouldAudition ()
 
void selectNextFile ()
 
HardwareActionBindable selectNextFileAction ()
 
void selectPreviousFile ()
 
HardwareActionBindable selectPreviousFileAction ()
 
void selectFirstFile ()
 
void selectLastFile ()
 
void cancel ()
 
HardwareActionBindable cancelAction ()
 
void commit ()
 
HardwareActionBindable commitAction ()
 
- 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 ()
 
- Public Member Functions inherited from RelativeHardwarControlBindable
default RelativeHardwareControlBinding addBinding (RelativeHardwareControl hardwareControl)
 
RelativeHardwareControlBinding addBindingWithSensitivity (RelativeHardwareControl hardwareControl, double sensitivity)
 

Detailed Description

Object that represents the popup browser in Bitwig Studio.

Since
API version 2

Member Function Documentation

◆ canAudition()

BooleanValue canAudition ( )

Value that indicates if the browser is able to audition material in place while browsing.

Since
API version 2

◆ cancel()

void cancel ( )

Cancels the popup browser.

Since
API version 2

◆ categoryColumn()

BrowserFilterColumn categoryColumn ( )

The category column of the browser.

Since
API version 2

◆ commit()

void commit ( )

Commits the selected item in the popup browser.

Since
API version 2

◆ contentTypeNames()

StringArrayValue contentTypeNames ( )

Value that reports the possible content types that can be inserted by the popup browser. These are represented by the tabs in Bitwig Studio's popup browser.

(e.g "Device", "Preset", "Sample" etc.)

Since
API version 2

◆ creatorColumn()

BrowserFilterColumn creatorColumn ( )

The creator column of the browser.

Since
API version 2

◆ deviceColumn()

BrowserFilterColumn deviceColumn ( )

The device column of the browser.

Since
API version 2

◆ deviceTypeColumn()

BrowserFilterColumn deviceTypeColumn ( )

The device type column of the browser.

Since
API version 2

◆ fileTypeColumn()

BrowserFilterColumn fileTypeColumn ( )

The file type column of the browser.

Since
API version 2

◆ locationColumn()

BrowserFilterColumn locationColumn ( )

The location column of the browser.

Since
API version 2

◆ resultsColumn()

BrowserResultsColumn resultsColumn ( )

Column that represents the results of the search.

Since
API version 2

◆ selectedContentTypeIndex()

SettableIntegerValue selectedContentTypeIndex ( )

Value that represents the index of the selected content type within the content types supported.

Since
API version 2

◆ selectedContentTypeName()

StringValue selectedContentTypeName ( )

Value that represents the selected content type.

Since
API version 2

◆ selectFirstFile()

void selectFirstFile ( )

Selects the first file.

Since
API version 2

◆ selectLastFile()

void selectLastFile ( )

Selects the last file.

Since
API version 2

◆ selectNextFile()

void selectNextFile ( )

Selects the next file.

Since
API version 2

◆ selectNextFileAction()

HardwareActionBindable selectNextFileAction ( )

Action that selects the next file

Since
API version 15

◆ selectPreviousFile()

void selectPreviousFile ( )

Selects the previous file.

Since
API version 2

◆ selectPreviousFileAction()

HardwareActionBindable selectPreviousFileAction ( )

Action that selects the next file

Since
API version 15

◆ shouldAudition()

SettableBooleanValue shouldAudition ( )

Value that decides if the browser is currently auditioning material in place while browsing or not.

Since
API version 2

◆ smartCollectionColumn()

BrowserFilterColumn smartCollectionColumn ( )

The smart collections column of the browser.

Since
API version 2

◆ tagColumn()

BrowserFilterColumn tagColumn ( )

The tag column of the browser.

Since
API version 2

◆ title()

StringValue title ( )

The title of the popup browser.

Since
API version 2

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