Bitwig Studio Control Surface API  5.0.11
ChannelBank< ChannelType extends Channel > Interface Template Reference
+ Inheritance diagram for ChannelBank< ChannelType extends Channel >:

Public Member Functions

Channel getChannel (int indexInBank)
 
void setChannelScrollStepSize (int stepSize)
 
void scrollChannelsPageUp ()
 
void scrollChannelsPageDown ()
 
void scrollChannelsUp ()
 
void scrollChannelsDown ()
 
void scrollToChannel (int position)
 
IntegerValue channelScrollPosition ()
 
void addChannelScrollPositionObserver (IntegerValueChangedCallback callback, int valueWhenUnassigned)
 
BooleanValue canScrollChannelsUp ()
 
void addCanScrollChannelsUpObserver (BooleanValueChangedCallback callback)
 
BooleanValue canScrollChannelsDown ()
 
void addCanScrollChannelsDownObserver (BooleanValueChangedCallback callback)
 
IntegerValue channelCount ()
 
void addChannelCountObserver (IntegerValueChangedCallback callback)
 
void scrollSendsPageUp ()
 
void scrollSendsPageDown ()
 
void scrollSendsUp ()
 
void scrollSendsDown ()
 
void scrollToSend (int position)
 
void addCanScrollSendsUpObserver (BooleanValueChangedCallback callback)
 
void addCanScrollSendsDownObserver (BooleanValueChangedCallback callback)
 
void addSendCountObserver (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 ()
 
- Public Member Functions inherited from Bank< ChannelType >
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

A channel bank provides access to a range of channels in Bitwig Studio, such as tracks or device layers. Instances of channel bank are typically configured with support for a fixed number of channels and represent an excerpt of a larger list of channels. Various methods are provided for scrolling to different sections of the channel list. It basically acts like a window moving over the list of channels.

Since
API version 1

Member Function Documentation

◆ addCanScrollChannelsDownObserver()

void addCanScrollChannelsDownObserver ( BooleanValueChangedCallback  callback)

Registers an observer that reports if the channel bank can be scrolled further down.

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

◆ addCanScrollChannelsUpObserver()

void addCanScrollChannelsUpObserver ( BooleanValueChangedCallback  callback)

Registers an observer that reports if the channel bank can be scrolled further up.

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

◆ addCanScrollSendsDownObserver()

void addCanScrollSendsDownObserver ( BooleanValueChangedCallback  callback)

Registers an observer that reports if the sends window can be scrolled further down.

Parameters
callbacka callback function that takes a single boolean parameter
Since
API version 1
Deprecated:
Does nothing.

◆ addCanScrollSendsUpObserver()

void addCanScrollSendsUpObserver ( BooleanValueChangedCallback  callback)

Registers an observer that reports if the sends window can be scrolled further up.

Parameters
callbacka callback function that takes a single boolean parameter
Since
API version 1
Deprecated:
Does nothing.

◆ addChannelCountObserver()

void addChannelCountObserver ( IntegerValueChangedCallback  callback)

Registers an observer that reports the underlying total channel count (not the number of channels available in the bank window).

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

◆ addChannelScrollPositionObserver()

void addChannelScrollPositionObserver ( IntegerValueChangedCallback  callback,
int  valueWhenUnassigned 
)

Registers an observer that reports the current scroll position, more specifically the position of the first channel within the underlying list of channels, that is shown as channel zero within the bank.

Parameters
callbacka callback function that receives a single integer number parameter
valueWhenUnassigneda default value for the channel position that gets reported in case the channel bank is not connected to a list of channels in Bitwig Studio.
Since
API version 1
Deprecated:
Use channelScrollPosition() instead

◆ addSendCountObserver()

void addSendCountObserver ( IntegerValueChangedCallback  callback)

Registers an observer that reports the underlying total send count (not the number of sends available in the bank window).

Parameters
callbacka callback function that receives a single integer parameter
Since
API version 1
Deprecated:
Does nothing.

◆ canScrollChannelsDown()

BooleanValue canScrollChannelsDown ( )

Value that reports if the channel bank can be scrolled further down.

Since
API version 2

◆ canScrollChannelsUp()

BooleanValue canScrollChannelsUp ( )

Value that reports if the channel bank can be scrolled further down.

Since
API version 2

◆ channelCount()

IntegerValue channelCount ( )

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

Since
API version 2

◆ channelScrollPosition()

IntegerValue channelScrollPosition ( )

Value that reports the current scroll position, more specifically the position of the first channel within the underlying list of channels, that is shown as channel zero within the bank.

Since
API version 2
Deprecated:
scrollPosition()

◆ getChannel()

Channel getChannel ( int  indexInBank)

Returns the channel for the given index.

Parameters
indexInBankthe channel index within this bank, not the index within the list of all Bitwig Studio channels. Must be in the range [0..sizeOfBank-1].
Returns
the channel object
Since
API version 1
Deprecated:
Use getItemAt(int) instead.

◆ scrollChannelsDown()

void scrollChannelsDown ( )

Scrolls the channel window down by the amount specified via setChannelScrollStepSize(int) (by default one channel).

Since
API version 1
Deprecated:
scrollForwards()

◆ scrollChannelsPageDown()

void scrollChannelsPageDown ( )

Scrolls the channels one page up. For example if the channel bank is configured with a window size of 8 channels and is currently showing channel [9..16], calling this method would scroll the channel bank to show channel [1..8].

Since
API version 1
Deprecated:
scrollPageForwards()

◆ scrollChannelsPageUp()

void scrollChannelsPageUp ( )

Scrolls the channels one page up. For example if the channel bank is configured with a window size of 8 channels and is currently showing channel [1..8], calling this method would scroll the channel bank to show channel [9..16].

Since
API version 1
Deprecated:
scrollPageBackwards()

◆ scrollChannelsUp()

void scrollChannelsUp ( )

Scrolls the channel window up by the amount specified via setChannelScrollStepSize(int) (by default one channel).

Since
API version 1
Deprecated:
scrollBackwards()

◆ scrollSendsDown()

void scrollSendsDown ( )

Scrolls the sends one step down.

Since
API version 1
Deprecated:
Does nothing.

◆ scrollSendsPageDown()

void scrollSendsPageDown ( )

Scrolls the sends one page down.

Since
API version 1
Deprecated:
Does nothing.

◆ scrollSendsPageUp()

void scrollSendsPageUp ( )

Scrolls the sends one page up.

Since
API version 1
Deprecated:
Does nothing.

◆ scrollSendsUp()

void scrollSendsUp ( )

Scrolls the sends one step up.

Since
API version 1
Deprecated:
Does nothing.

◆ scrollToChannel()

void scrollToChannel ( int  position)

Scrolls the channel bank window so that the channel at the given position becomes visible.

Parameters
positionthe index of the channel within the underlying full list of channels (not the index within the bank). The position is typically directly related to the layout of the channel list in Bitwig Studio, starting with zero in case of the first channel.
Since
API version 1
Deprecated:
scrollPosition()

◆ scrollToSend()

void scrollToSend ( int  position)

Scrolls to the send.

Parameters
positionthe index of the send.
Since
API version 1
Deprecated:
Does nothing.

◆ setChannelScrollStepSize()

void setChannelScrollStepSize ( int  stepSize)

Sets the step size used for scrolling the channel bank.

Parameters
stepSizethe step size used for scrolling. Default is 1.
Since
API version 1

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