Package com.bitwig.extension.controller.api

Interface BrowsingSessionBank

All Superinterfaces:
Bank<GenericBrowsingSession>, HardwareBindable, ObjectProxy, RelativeHardwarControlBindable, Scrollable, Subscribable
public interface BrowsingSessionBank extends Bank<GenericBrowsingSession>
Instances of this interface are used to navigate the available sessions in Bitwig Studio's contextual browser. The sessions are shown as tabs in the graphical user interface of the browser.
Since:
API version 1

  • Method Details

    • getSize

      int getSize()
      Returns the window size that was used to configure the session bank during creation.
      Returns:
      the size of the session bank.
      Since:
      API version 1

    • getSession

      GenericBrowsingSession getSession(int index)
      Returns the browser session for the given index.
      Parameters:
      index - the session index, must be in the range `[0..getSize-1]`
      Returns:
      the requested browser session object
      Since:
      API version 1

    • scrollUp

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

    • scrollDown

      @Deprecated void scrollDown()
      Deprecated.
      Use Scrollable.canScrollForwards() instead.
      Scrolls the browser sessions one item down.
      Since:
      API version 1

    • scrollPageUp

      @Deprecated void scrollPageUp()
      Deprecated.
      Use Scrollable.scrollPageBackwards() instead.
      Scrolls the browser sessions one page up. For example if the bank is configured with a window size of 8 entries and is currently showing items [1..8], calling this method would scroll the window to show items [9..16].
      Since:
      API version 1

    • scrollPageDown

      @Deprecated void scrollPageDown()
      Deprecated.
      Use Scrollable.scrollPageForwards() instead.
      Scrolls the filter columns one page up. For example if the bank is configured with a window size of 8 entries and is currently showing items [9..16], calling this method would scroll the window to show items [1..8].
      Since:
      API version 1

    • addScrollPositionObserver

      @Deprecated void addScrollPositionObserver(IntegerValueChangedCallback callback)
      Deprecated.
      Use Scrollable.scrollPosition() instead.
      Registers an observer that reports the current scroll position, more specifically the position of the first item within the underlying list of browser sessions, that is shown as the first session within the window.
      Parameters:
      callback - a callback function that receives a single integer number parameter. The parameter reflects the scroll position, or `-1` in case the column has no content.
      Since:
      API version 1

    • addCanScrollUpObserver

      @Deprecated void addCanScrollUpObserver(BooleanValueChangedCallback callback)
      Deprecated.
      Use Scrollable.canScrollBackwards() instead.
      Registers an observer that reports if the browser sessions can be scrolled further up.
      Parameters:
      callback - a callback function that receives 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 browser sessions can be scrolled further down.
      Parameters:
      callback - a callback function that receives a single boolean parameter
      Since:
      API version 1

    • addEntryCountObserver

      @Deprecated void addEntryCountObserver(IntegerValueChangedCallback callback)
      Deprecated.
      Use Bank.itemCount() instead.
      Registers an observer that reports the underlying total count of browser sessions (not the size of the window).
      Parameters:
      callback - a callback function that receives a single integer parameter
      Since:
      API version 1