Package com.bitwig.extension.controller.api

Interface ChannelBank<ChannelType extends Channel>

All Superinterfaces:
Bank<ChannelType>, HardwareBindable, ObjectProxy, RelativeHardwarControlBindable, Scrollable, Subscribable
All Known Subinterfaces:
DeviceLayerBank, DrumPadBank, TrackBank
public interface ChannelBank<ChannelType extends Channel> extends ObjectProxy, Bank<ChannelType>
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

  • Method Details

    • getChannel

      @Deprecated Channel getChannel(int indexInBank)
      Deprecated.
      Use Bank.getItemAt(int) instead.
      Returns the channel for the given index.
      Parameters:
      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].
      Returns:
      the channel object
      Since:
      API version 1

    • setChannelScrollStepSize

      void setChannelScrollStepSize(int stepSize)
      Sets the step size used for scrolling the channel bank.
      Parameters:
      stepSize - the step size used for scrolling. Default is `1`.
      Since:
      API version 1

    • scrollChannelsPageUp

      @Deprecated void scrollChannelsPageUp()
      Deprecated.
      Scrollable.scrollPageBackwards()
      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

    • scrollChannelsPageDown

      @Deprecated void scrollChannelsPageDown()
      Deprecated.
      Scrollable.scrollPageForwards()
      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

    • scrollChannelsUp

      @Deprecated void scrollChannelsUp()
      Deprecated.
      Scrollable.scrollBackwards()
      Scrolls the channel window up by the amount specified via setChannelScrollStepSize(int) (by default one channel).
      Since:
      API version 1

    • scrollChannelsDown

      @Deprecated void scrollChannelsDown()
      Deprecated.
      Scrollable.scrollForwards()
      Scrolls the channel window down by the amount specified via setChannelScrollStepSize(int) (by default one channel).
      Since:
      API version 1

    • scrollToChannel

      @Deprecated void scrollToChannel(int position)
      Deprecated.
      Scrollable.scrollPosition()
      Scrolls the channel bank window so that the channel at the given position becomes visible.
      Parameters:
      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.
      Since:
      API version 1

    • channelScrollPosition

      @Deprecated IntegerValue channelScrollPosition()
      Deprecated.
      Scrollable.scrollPosition()
      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

    • addChannelScrollPositionObserver

      @Deprecated void addChannelScrollPositionObserver(IntegerValueChangedCallback callback, int valueWhenUnassigned)
      Deprecated.
      Use channelScrollPosition() instead
      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:
      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.
      Since:
      API version 1

    • canScrollChannelsUp

      BooleanValue canScrollChannelsUp()
      Value that reports if the channel bank can be scrolled further down.
      Since:
      API version 2

    • addCanScrollChannelsUpObserver

      @Deprecated void addCanScrollChannelsUpObserver(BooleanValueChangedCallback callback)
      Deprecated.
      Use canScrollChannelsUp().addValueObserver(callback)
      Registers an observer that reports if the channel bank can be scrolled further up.
      Parameters:
      callback - a callback function that receives a single boolean parameter
      Since:
      API version 1

    • canScrollChannelsDown

      BooleanValue canScrollChannelsDown()
      Value that reports if the channel bank can be scrolled further down.
      Since:
      API version 2

    • addCanScrollChannelsDownObserver

      @Deprecated void addCanScrollChannelsDownObserver(BooleanValueChangedCallback callback)
      Deprecated.
      Use canScrollChannelsDown().addValueObserver(callback)
      Registers an observer that reports if the channel bank can be scrolled further down.
      Parameters:
      callback - a callback function that receives a single boolean parameter
      Since:
      API version 1

    • 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

    • addChannelCountObserver

      @Deprecated void addChannelCountObserver(IntegerValueChangedCallback callback)
      Deprecated.
      Use channelCount().addValueObserver(callback)
      Registers an observer that reports the underlying total channel count (not the number of channels available in the bank window).
      Parameters:
      callback - a callback function that receives a single integer parameter
      Since:
      API version 1

    • scrollSendsPageUp

      @Deprecated void scrollSendsPageUp()
      Deprecated.
      Does nothing.
      Scrolls the sends one page up.
      Since:
      API version 1

    • scrollSendsPageDown

      @Deprecated void scrollSendsPageDown()
      Deprecated.
      Does nothing.
      Scrolls the sends one page down.
      Since:
      API version 1

    • scrollSendsUp

      @Deprecated void scrollSendsUp()
      Deprecated.
      Does nothing.
      Scrolls the sends one step up.
      Since:
      API version 1

    • scrollSendsDown

      @Deprecated void scrollSendsDown()
      Deprecated.
      Does nothing.
      Scrolls the sends one step down.
      Since:
      API version 1

    • scrollToSend

      @Deprecated void scrollToSend(int position)
      Deprecated.
      Does nothing.
      Scrolls to the send.
      Parameters:
      position - the index of the send.
      Since:
      API version 1

    • addCanScrollSendsUpObserver

      @Deprecated void addCanScrollSendsUpObserver(BooleanValueChangedCallback callback)
      Deprecated.
      Does nothing.
      Registers an observer that reports if the sends window can be scrolled further up.
      Parameters:
      callback - a callback function that takes a single boolean parameter
      Since:
      API version 1

    • addCanScrollSendsDownObserver

      @Deprecated void addCanScrollSendsDownObserver(BooleanValueChangedCallback callback)
      Deprecated.
      Does nothing.
      Registers an observer that reports if the sends window can be scrolled further down.
      Parameters:
      callback - a callback function that takes a single boolean parameter
      Since:
      API version 1

    • addSendCountObserver

      @Deprecated void addSendCountObserver(IntegerValueChangedCallback callback)
      Deprecated.
      Does nothing.
      Registers an observer that reports the underlying total send count (not the number of sends available in the bank window).
      Parameters:
      callback - a callback function that receives a single integer parameter
      Since:
      API version 1