Package com.bitwig.extension.controller.api

Interface SceneBank

All Superinterfaces:
Bank<Scene>, ClipLauncherSlotOrSceneBank<Scene>, HardwareBindable, ObjectProxy, RelativeHardwarControlBindable, Scrollable, Subscribable
public interface SceneBank extends ClipLauncherSlotOrSceneBank<Scene>
A scene bank provides access to a range of scenes in Bitwig Studio. Instances of scene bank are configured with a fixed number of scenes and represent an excerpt of a larger list of scenes. Various methods are provided for scrolling to different sections of the scene list. It basically acts like a window moving over the list of underlying scenes. To receive an instance of scene bank call ControllerHost.createSceneBank(int).
Since:
API version 1
See Also:

  • Method Details

    • getScene

      Scene getScene(int indexInBank)
      Returns the scene at the given index within the bank.
      Parameters:
      indexInBank - the scene index within this bank, not the index within the list of all Bitwig Studio scenes. Must be in the range [0..sizeOfBank-1].
      Returns:
      the requested scene object
      Since:
      API version 1

    • scrollPageUp

      @Deprecated void scrollPageUp()
      Deprecated.
      Use Scrollable.scrollPageBackwards() instead.
      Scrolls the scenes one page up.
      Since:
      API version 1

    • scrollPageDown

      @Deprecated void scrollPageDown()
      Deprecated.
      Use Scrollable.scrollPageForwards() instead.
      Scrolls the scenes one page down.
      Since:
      API version 1

    • scrollUp

      @Deprecated void scrollUp()
      Deprecated.
      Use Scrollable.scrollBackwards() instead.
      Scrolls the scenes one scene up.
      Since:
      API version 1

    • scrollDown

      @Deprecated void scrollDown()
      Deprecated.
      Use Scrollable.scrollForwards() instead.
      Scrolls the scenes one scene down.
      Since:
      API version 1

    • scrollTo

      @Deprecated void scrollTo(int position)
      Deprecated.
      Use Scrollable.scrollIntoView(int) 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

    • addScrollPositionObserver

      @Deprecated void addScrollPositionObserver(IntegerValueChangedCallback callback, int valueWhenUnassigned)
      Deprecated.
      Use Scrollable.scrollPosition() 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

    • addCanScrollUpObserver

      @Deprecated void addCanScrollUpObserver(BooleanValueChangedCallback callback)
      Deprecated.
      Use Scrollable.canScrollBackwards() 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

    • addCanScrollDownObserver

      @Deprecated void addCanScrollDownObserver(BooleanValueChangedCallback callback)
      Deprecated.
      Use Scrollable.canScrollForwards() 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 Bank.itemCount() instead.
      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

    • launchScene

      void launchScene(int indexInWindow)
      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

    • setIndication

      void setIndication(boolean shouldIndicate)
      Specifies if the Bitwig Studio clip launcher should indicate which scenes are part of the window. By default indications are disabled.
      Parameters:
      shouldIndicate - `true` if visual indications should be enabled, `false` otherwise
      Since:
      API version 10