Bitwig Studio Control Surface API  5.0.11
Bank< ItemType extends ObjectProxy > Interface Template Reference
+ Inheritance diagram for Bank< ItemType extends ObjectProxy >:

Public Member Functions

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)
 
- 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 Scrollable
SettableIntegerValue scrollPosition ()
 
void scrollIntoView (int position)
 
void scrollBy (int amount)
 
default void scrollForwards ()
 
HardwareActionBindable scrollForwardsAction ()
 
default void scrollBackwards ()
 
HardwareActionBindable scrollBackwardsAction ()
 
void scrollByPages (int amount)
 
HardwareActionBindable scrollPageForwardsAction ()
 
HardwareActionBindable scrollPageBackwardsAction ()
 
BooleanValue canScrollBackwards ()
 
BooleanValue canScrollForwards ()
 
- Public Member Functions inherited from RelativeHardwarControlBindable
default RelativeHardwareControlBinding addBinding (RelativeHardwareControl hardwareControl)
 
RelativeHardwareControlBinding addBindingWithSensitivity (RelativeHardwareControl hardwareControl, double sensitivity)
 

Detailed Description

A bank provides access to a range of items in Bitwig Studio. Instances of a bank are configured with a fixed number of items and represent an excerpt of a larger list of items. Various methods are provided for scrolling to different sections of the item list. It basically acts like a window moving over the list of underlying items.

Since
API version 2

Member Function Documentation

◆ cursorIndex()

SettableIntegerValue cursorIndex ( )

An integer value that defines the location of the cursor that this bank is following. If there is no cursor or the cursor is not within the bank then the value is -1.

Since
API version 2

◆ getCapacityOfBank()

int getCapacityOfBank ( )

The maximum number of items in the bank which is defined when the bank is initially created.

Since
API version 7

◆ getItemAt()

ItemType getItemAt ( int  index)

Gets the item in the bank at the supplied index. The index must be >= 0 and < getSizeOfBank().

Since
API version 2

◆ getSizeOfBank()

int getSizeOfBank ( )

The fixed size of this bank. This will be initially equal to the capacity of the Bank.

Since
API version 2

◆ itemCount()

IntegerValue itemCount ( )

Value that reports the underlying total item count (not the number of items available in the bank window).

Since
API version 2

◆ scrollPageBackwards()

default void scrollPageBackwards ( )

Scrolls backwards by one page.

Since
API version 2

Implements Scrollable.

◆ scrollPageForwards()

default void scrollPageForwards ( )

Scrolls forwards by one page.

Since
API version 2

Implements Scrollable.

◆ setSizeOfBank()

void setSizeOfBank ( int  size)

Sets the size of this bank

Parameters
sizenumber of items in the bank that has to be greater than 0 and less or equal to the capacity of the bank.
Since
API version 7

◆ setSkipDisabledItems()

void setSkipDisabledItems ( boolean  shouldSkip)

Disabled items will not be accessible via the bank if set to true.

Since
API version 11

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