Bitwig Studio Control Surface API
5.0.11
|
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.
void addCanScrollChannelsDownObserver | ( | BooleanValueChangedCallback | callback | ) |
Registers an observer that reports if the channel bank can be scrolled further down.
callback | a callback function that receives a single boolean parameter |
void addCanScrollChannelsUpObserver | ( | BooleanValueChangedCallback | callback | ) |
Registers an observer that reports if the channel bank can be scrolled further up.
callback | a callback function that receives a single boolean parameter |
void addCanScrollSendsDownObserver | ( | BooleanValueChangedCallback | callback | ) |
Registers an observer that reports if the sends window can be scrolled further down.
callback | a callback function that takes a single boolean parameter |
void addCanScrollSendsUpObserver | ( | BooleanValueChangedCallback | callback | ) |
Registers an observer that reports if the sends window can be scrolled further up.
callback | a callback function that takes a single boolean parameter |
void addChannelCountObserver | ( | IntegerValueChangedCallback | callback | ) |
Registers an observer that reports the underlying total channel count (not the number of channels available in the bank window).
callback | a callback function that receives a single integer parameter |
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.
callback | a callback function that receives a single integer number parameter |
valueWhenUnassigned | a 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. |
void addSendCountObserver | ( | IntegerValueChangedCallback | callback | ) |
Registers an observer that reports the underlying total send count (not the number of sends available in the bank window).
callback | a callback function that receives a single integer parameter |
BooleanValue canScrollChannelsDown | ( | ) |
Value that reports if the channel bank can be scrolled further down.
BooleanValue canScrollChannelsUp | ( | ) |
Value that reports if the channel bank can be scrolled further down.
IntegerValue channelCount | ( | ) |
Value that reports the underlying total channel count (not the number of channels available in the bank window).
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.
Channel getChannel | ( | int | indexInBank | ) |
Returns the channel for the given index.
indexInBank | the channel index within this bank, not the index within the list of all Bitwig Studio channels. Must be in the range [0..sizeOfBank-1]. |
void scrollChannelsDown | ( | ) |
Scrolls the channel window down by the amount specified via setChannelScrollStepSize(int) (by default one channel).
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].
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].
void scrollChannelsUp | ( | ) |
Scrolls the channel window up by the amount specified via setChannelScrollStepSize(int) (by default one channel).
void scrollSendsDown | ( | ) |
void scrollSendsPageDown | ( | ) |
void scrollSendsPageUp | ( | ) |
void scrollSendsUp | ( | ) |
void scrollToChannel | ( | int | position | ) |
Scrolls the channel bank window so that the channel at the given position becomes visible.
position | the 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. |
void scrollToSend | ( | int | position | ) |
Scrolls to the send.
position | the index of the send. |
void setChannelScrollStepSize | ( | int | stepSize | ) |
Sets the step size used for scrolling the channel bank.
stepSize | the step size used for scrolling. Default is 1 . |