Package com.bitwig.extension.controller.api

Interface BrowsingSession

All Superinterfaces:
ObjectProxy, Subscribable
All Known Subinterfaces:
BitwigBrowsingSession, ClipBrowsingSession, CursorBrowsingSession, DeviceBrowsingSession, GenericBrowsingSession, MultiSampleBrowsingSession, MusicBrowsingSession, PresetBrowsingSession, SampleBrowsingSession
@Deprecated public interface BrowsingSession extends ObjectProxy
Deprecated.
Use PopupBrowser instead.
Instances of this interface are used for browsing material according to a certain type. Possible material types are devices, presets, samples, multi-samples, clips, or files from your music collection. In Bitwig Studio's contextual browser window the search sessions for the various material kinds are shown in tabs. Just like the tabs in the browser window, instances of this interface provide access to multiple filter columns and one result column. The filter columns are used to control the content of the results column.
Since:
API version 1

  • Method Details

    • addIsAvailableObserver

      @Deprecated void addIsAvailableObserver(BooleanValueChangedCallback callback)
      Deprecated.
      Use ObjectProxy.exists() instead.
      Registers an observer that reports if the browser session is available for the current context.
      Parameters:
      callback - a callback function that receives a single boolean argument.
      Since:
      API version 1

    • addIsActiveObserver

      void addIsActiveObserver(BooleanValueChangedCallback callback)
      Deprecated.
      Registers an observer that reports if the browser session is currently active.
      Parameters:
      callback - a callback function that receives a single boolean argument.
      Since:
      API version 1

    • activate

      void activate()
      Deprecated.
      Activates the given search session, same as calling Browser#activateSession(this). Please note that only one search session can be active at a time.
      Since:
      API version 1
      See Also:

    • getResults

      BrowserResultsColumn getResults()
      Deprecated.
      Returns an object that represents the column which shows the results according to the current filter settings in Bitwig Studio's contextual browser.
      Returns:
      the requested results browser column.
      Since:
      API version 1

    • getCursorResult

      CursorBrowserResultItem getCursorResult()
      Deprecated.
      Returns an object used for navigating the entries in the results column of Bitwig Studio's contextual browser.
      Returns:
      the requested cursor object.
      Since:
      API version 1

    • getSettledResult

      BrowserResultsItem getSettledResult()
      Deprecated.
      Returns an object that represents the currently loaded material item.
      Returns:
      the requested settled result object
      Since:
      API version 1

    • getCursorFilter

      CursorBrowserFilterColumn getCursorFilter()
      Deprecated.
      Returns an object that can be used to navigate over the various filter sections of the browsing session.
      Returns:
      the requested filter cursor object

    • createFilterBank

      BrowserFilterColumnBank createFilterBank(int numColumns)
      Deprecated.
      Returns an object that provided bank-wise navigation of filter columns.
      Parameters:
      numColumns - the number of columns that are simultaneously accessible.
      Returns:
      the requested file column bank object
      Since:
      API version 1

    • hitCount

      IntegerValue hitCount()
      Deprecated.
      Value that reports the number of results available for the current filter settings.
      Since:
      API version 2

    • addHitCountObserver

      @Deprecated void addHitCountObserver(IntegerValueChangedCallback callback)
      Deprecated.
      Use hitCount() instead.
      Registers an observer that reports the number of results available for the current filter settings.
      Parameters:
      callback - a callback function that receives a single integer argument.
      Since:
      API version 1