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

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)
 
- Public Member Functions inherited from Bank< GenericBrowsingSession >
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)
 

Detailed Description

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.

Since
API version 1

Member Function Documentation

◆ addCanScrollDownObserver()

void addCanScrollDownObserver ( BooleanValueChangedCallback  callback)

Registers an observer that reports if the browser sessions can be scrolled further down.

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

◆ addCanScrollUpObserver()

void addCanScrollUpObserver ( BooleanValueChangedCallback  callback)

Registers an observer that reports if the browser sessions can be scrolled further up.

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

◆ addEntryCountObserver()

void addEntryCountObserver ( IntegerValueChangedCallback  callback)

Registers an observer that reports the underlying total count of browser sessions (not the size of the window).

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

◆ addScrollPositionObserver()

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.

Parameters
callbacka callback function that receives a single integer number parameter. The parameter reflects the scroll position, or -1 in case the column has no content.
Since
API version 1
Deprecated:
Use scrollPosition() instead.

◆ getSession()

GenericBrowsingSession getSession ( int  index)

Returns the browser session for the given index.

Parameters
indexthe session index, must be in the range [0..getSize-1]
Returns
the requested browser session object
Since
API version 1

◆ getSize()

int getSize ( )

Returns the window size that was used to configure the session bank during creation.

Returns
the size of the session bank.
Since
API version 1

◆ scrollDown()

void scrollDown ( )

Scrolls the browser sessions one item down.

Since
API version 1
Deprecated:
Use canScrollForwards() instead.

◆ scrollPageDown()

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].

Since
API version 1
Deprecated:
Use scrollPageForwards() instead.

◆ scrollPageUp()

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].

Since
API version 1
Deprecated:
Use scrollPageBackwards() instead.

◆ scrollUp()

void scrollUp ( )

Scrolls the browser sessions one item up.

Since
API version 1
Deprecated:
Use scrollBackwards() instead.

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