Package com.bitwig.extension.controller.api

Interface TrackBank

All Superinterfaces:
Bank<Track>, ChannelBank<Track>, HardwareBindable, ObjectProxy, RelativeHardwarControlBindable, Scrollable, Subscribable
public interface TrackBank extends ChannelBank<Track>
A track bank provides access to a range of tracks and their scenes (clip launcher slots) in Bitwig Studio. Instances of track bank are configured with a fixed number of tracks and scenes and represent an excerpt of a larger list of tracks and scenes. Various methods are provided for scrolling to different sections of the track/scene list. It basically acts like a 2-dimensional window moving over the grid of tracks and scenes. To receive an instance of track bank that supports all kinds of tracks call ControllerHost.createTrackBank(int, int, int). Additional methods are provided in the ControllerHost interface to create track banks that include only main tracks (ControllerHost.createMainTrackBank(int, int, int)) or only effect tracks (ControllerHost.createEffectTrackBank(int, int, int)).
Since:
API version 1
See Also:

  • Method Details

    • getTrack

      @Deprecated Track getTrack(int indexInBank)
      Deprecated.
      use getChannel(int) instead.
      Since:
      API version 1

    • getChannel

      @Deprecated Track getChannel(int indexInBank)
      Deprecated.
      Use Bank.getItemAt(int) instead.
      Returns the track at the given index within the bank.
      Specified by:
      getChannel in interface ChannelBank<Track>
      Parameters:
      indexInBank - the track index within this bank, not the index within the list of all Bitwig Studio tracks. Must be in the range [0..sizeOfBank-1].
      Returns:
      the requested track object
      Since:
      API version 1

    • setTrackScrollStepSize

      @Deprecated void setTrackScrollStepSize(int stepSize)
      Deprecated.
      use ChannelBank.setChannelScrollStepSize(int) instead.

    • scrollTracksPageUp

      @Deprecated void scrollTracksPageUp()
      Deprecated.
      use ChannelBank.scrollChannelsPageUp() instead.

    • scrollTracksPageDown

      @Deprecated void scrollTracksPageDown()
      Deprecated.
      use ChannelBank.scrollChannelsPageDown() instead.

    • scrollTracksUp

      @Deprecated void scrollTracksUp()
      Deprecated.
      use ChannelBank.scrollChannelsUp() instead.

    • scrollTracksDown

      @Deprecated void scrollTracksDown()
      Deprecated.
      use ChannelBank.scrollChannelsDown() instead.

    • scrollToTrack

      @Deprecated void scrollToTrack(int position)
      Deprecated.
      use ChannelBank.scrollToChannel(int) instead.

    • addTrackScrollPositionObserver

      @Deprecated void addTrackScrollPositionObserver(IntegerValueChangedCallback callback, int valueWhenUnassigned)
      Deprecated.
      use Scrollable.scrollPosition() instead.

    • sceneBank

      SceneBank sceneBank()
      SceneBank that represents a view on the scenes in this TrackBank.
      Since:
      API version 2

    • scrollScenesPageUp

      @Deprecated void scrollScenesPageUp()
      Deprecated.
      Use sceneBank() instead.
      Scrolls the scenes one page up.
      Since:
      API version 1

    • scrollScenesPageDown

      @Deprecated void scrollScenesPageDown()
      Deprecated.
      Use sceneBank() instead.
      Scrolls the scenes one page down.
      Since:
      API version 1

    • scrollScenesUp

      @Deprecated void scrollScenesUp()
      Deprecated.
      Use sceneBank() instead.
      Scrolls the scenes one step up.
      Since:
      API version 1

    • scrollScenesDown

      @Deprecated void scrollScenesDown()
      Deprecated.
      Use sceneBank() instead.
      Scrolls the scenes one step down.
      Since:
      API version 1

    • scrollToScene

      @Deprecated void scrollToScene(int position)
      Deprecated.
      Use sceneBank() instead.
      Makes the scene with the given position visible in the track bank.
      Parameters:
      position - the position of the scene within the underlying full list of scenes
      Since:
      API version 1

    • addSceneScrollPositionObserver

      @Deprecated void addSceneScrollPositionObserver(IntegerValueChangedCallback callback, int valueWhenUnassigned)
      Deprecated.
      Use sceneBank() instead.
      Registers an observer that reports the current scene scroll position.
      Parameters:
      callback - a callback function that takes a single integer parameter
      valueWhenUnassigned - the default value that gets reports when the track bank is not yet connected to a Bitwig Studio document
      Since:
      API version 1

    • addCanScrollTracksUpObserver

      @Deprecated void addCanScrollTracksUpObserver(BooleanValueChangedCallback callback)
      Deprecated.
      use ChannelBank.canScrollChannelsUp() instead.

    • addCanScrollTracksDownObserver

      @Deprecated void addCanScrollTracksDownObserver(BooleanValueChangedCallback callback)
      Deprecated.
      use ChannelBank.canScrollChannelsDown() instead.

    • addCanScrollScenesUpObserver

      @Deprecated void addCanScrollScenesUpObserver(BooleanValueChangedCallback callback)
      Deprecated.
      use sceneBank() instead.
      Registers an observer that reports if the scene window can be scrolled further up.
      Parameters:
      callback - a callback function that takes a single boolean parameter
      Since:
      API version 1

    • addCanScrollScenesDownObserver

      @Deprecated void addCanScrollScenesDownObserver(BooleanValueChangedCallback callback)
      Deprecated.
      use sceneBank() instead.
      Registers an observer that reports if the scene window can be scrolled further down.
      Parameters:
      callback - a callback function that takes a single boolean parameter
      Since:
      API version 1

    • addSceneCountObserver

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

    • getClipLauncherScenes

      @Deprecated ClipLauncherSlotOrSceneBank getClipLauncherScenes()
      Deprecated.
      Use sceneBank() instead.
      Returns an object that provides access to the clip launcher scenes of the track bank.
      Returns:
      an object that provides access to the clip launcher scenes of the track bank.
      Since:
      API version 1

    • launchScene

      @Deprecated void launchScene(int indexInWindow)
      Deprecated.
      Use sceneBank() instead.
      Launches the scene with the given bank index.
      Parameters:
      indexInWindow - the scene index within the bank, not the position of the scene withing the underlying full list of scenes.
      Since:
      API version 1

    • followCursorTrack

      void followCursorTrack(CursorTrack cursorTrack)
      Causes this bank to follow the supplied cursor. When the cursor moves to a new item the bank will be scrolled so that the cursor is within the bank, if possible.
      Parameters:
      cursorTrack - The CursorTrack that this bank should follow.
      Since:
      API version 2

    • setShouldShowClipLauncherFeedback

      void setShouldShowClipLauncherFeedback(boolean value)
      Decides if Bitwig Studio's clip launcher should indicate the area being controlled by this controller or not.
      Since:
      API versian 17