Package com.bitwig.extension.controller.api

Interface DeviceChain

All Superinterfaces:
ObjectProxy, Subscribable
All Known Subinterfaces:
Channel, CursorChannel, CursorDeviceLayer, CursorDeviceSlot, CursorTrack, DeviceLayer, DeviceSlot, DrumPad, MasterTrack, Track
public interface DeviceChain extends ObjectProxy
The foundation of all interfaces that contain devices, such as tracks, device layers, drum pads or FX slots.
Since:
API version 1

  • Method Details

    • selectInEditor

      void selectInEditor()
      Selects the device chain in Bitwig Studio, in case it is a selectable object.
      Since:
      API version 1

    • name

      SettableStringValue name()
      Value that reports the name of the device chain, such as the track name or the drum pad name.
      Since:
      API version 2

    • addNameObserver

      @Deprecated void addNameObserver(int numChars, String textWhenUnassigned, StringValueChangedCallback callback)
      Deprecated.
      Use name() instead.
      Registers an observer that reports the name of the device chain, such as the track name or the drum pad name.
      Parameters:
      numChars - the maximum number of characters used for the reported name
      textWhenUnassigned - the default text that gets reported when the device chain is not associated with an object in Bitwig Studio yet.
      callback - a callback function that receives a single name parameter (string).
      Since:
      API version 1

    • addIsSelectedInEditorObserver

      void addIsSelectedInEditorObserver(BooleanValueChangedCallback callback)
      Registers an observer that reports if the device chain is selected in Bitwig Studio editors.
      Parameters:
      callback - a callback function that takes a single boolean parameter.
      Since:
      API version 1

    • addIsSelectedObserver

      @Deprecated void addIsSelectedObserver(BooleanValueChangedCallback callback)
      Deprecated.
      Use addIsSelectedInEditorObserver(com.bitwig.extension.callback.BooleanValueChangedCallback) instead.
      Since:
      API version 1

    • createDeviceBank

      DeviceBank createDeviceBank(int numDevices)
      Returns an object that provides bank-wise navigation of devices.
      Parameters:
      numDevices - the number of devices should be accessible simultaneously
      Returns:
      the requested device bank object
      Since:
      API version 1

    • createDeviceBrowser

      Browser createDeviceBrowser(int numFilterColumnEntries, int numResultsColumnEntries)
      Returns an object used for browsing devices, presets and other content. Committing the browsing session will load or create a device from the selected resource and insert it into the device chain.
      Parameters:
      numFilterColumnEntries - the size of the window used to navigate the filter column entries.
      numResultsColumnEntries - the size of the window used to navigate the results column entries.
      Returns:
      the requested device browser object.
      Since:
      API version 1

    • select

      @Deprecated void select()
      Deprecated.
      Use selectInEditor() or Channel.selectInMixer() instead.
      Since:
      API version 1

    • browseToInsertAtStartOfChain

      @Deprecated void browseToInsertAtStartOfChain()
      Deprecated.
      Use startOfDeviceChainInsertionPoint() instead.
      Starts browsing for content that can be inserted at the start of this device chain.
      Since:
      API version 2

    • browseToInsertAtEndOfChain

      @Deprecated void browseToInsertAtEndOfChain()
      Deprecated.
      Use endOfDeviceChainInsertionPoint() instead.
      Starts browsing for content that can be inserted at the end of this device chain.
      Since:
      API version 2

    • startOfDeviceChainInsertionPoint

      InsertionPoint startOfDeviceChainInsertionPoint()
      InsertionPoint that can be used to insert at the start of the device chain.
      Since:
      API version 7

    • endOfDeviceChainInsertionPoint

      InsertionPoint endOfDeviceChainInsertionPoint()
      InsertionPoint that can be used to insert at the end of the device chain.
      Since:
      API version 7