Package com.bitwig.extension.controller.api

Interface ClipLauncherSlotBank

All Superinterfaces:
Bank<ClipLauncherSlot>, ClipLauncherSlotOrSceneBank<ClipLauncherSlot>, HardwareBindable, ObjectProxy, RelativeHardwarControlBindable, Scrollable, Subscribable
public interface ClipLauncherSlotBank extends ClipLauncherSlotOrSceneBank<ClipLauncherSlot>
Instances of this interface represent a scrollable fixed-size window that is connected to a section of the clip launcher slots for a specific track.
Since:
API version 1

  • Method Details

    • select

      void select(int slot)
      Selects the slot with the given index.
      Parameters:
      slot - the index of the slot within the slot window.
      Since:
      API version 1

    • record

      void record(int slot)
      Starts recording into the slot with the given index.
      Parameters:
      slot - the index of the slot within the slot window.
      Since:
      API version 1

    • showInEditor

      void showInEditor(int slot)
      Makes the clip content of the slot with the given index visible in the note or audio editor.
      Parameters:
      slot - the index of the slot within the slot window.
      Since:
      API version 1

    • createEmptyClip

      void createEmptyClip(int slot, int lengthInBeats)
      Creates an new clip in the slot with the given index.
      Parameters:
      slot - the index of the slot within the slot window.
      Since:
      API version 1

    • deleteClip

      @Deprecated void deleteClip(int slot)
      Deprecated.
      Use Bank.getItemAt(int).deleteObject() instead.
      Deletes the clip in the slot with the given index.
      Parameters:
      slot - the index of the slot within the slot window.
      Since:
      API version 1

    • duplicateClip

      void duplicateClip(int slot)
      Duplicates the clip in the slot with the given index.
      Parameters:
      slot - the index of the slot within the slot window.
      Since:
      API version 1

    • addIsSelectedObserver

      void addIsSelectedObserver(IndexedBooleanValueChangedCallback callback)
      Registers an observer that reports selection changes for the slots inside the window.
      Parameters:
      callback - a callback function that receives two parameters: 1. the slot index (integer), and 2. a boolean parameter indicating if the slot at that index is selected (`true`) or not (`false`)
      Since:
      API version 1

    • addHasContentObserver

      void addHasContentObserver(IndexedBooleanValueChangedCallback callback)
      Registers an observer that reports which slots contain clips.
      Parameters:
      callback - a callback function that receives two parameters: 1. the slot index (integer), and 2. a boolean parameter indicating if the slot at that index contains a clip (`true`) or not (`false`)
      Since:
      API version 1

    • addPlaybackStateObserver

      void addPlaybackStateObserver(ClipLauncherSlotBankPlaybackStateChangedCallback callback)
      Registers an observer that reports the playback state of clips / slots. The reported states include `stopped`, `playing`, `recording`, but also `queued for stop`, `queued for playback`, `queued for recording`.
      Parameters:
      callback - a callback function that receives three parameters: 1. the slot index (integer), 2. the queued or playback state: `0` when stopped, `1` when playing, or `2` when recording, and 3. a boolean parameter indicating if the second argument is referring to the queued state (`true`) or the actual playback state (`false`)
      Since:
      API version 1

    • addIsPlayingObserver

      void addIsPlayingObserver(IndexedBooleanValueChangedCallback callback)
      Registers an observer that reports which slots have clips that are currently playing.
      Parameters:
      callback - a callback function that receives two parameters: 1. the slot index (integer), and 2. a boolean parameter indicating if the slot at that index has a clip that is currently playing (`true`) or not (`false`)
      Since:
      API version 1

    • addIsRecordingObserver

      void addIsRecordingObserver(IndexedBooleanValueChangedCallback callback)
      Registers an observer that reports which slots have clips that are currently recording.
      Parameters:
      callback - a callback function that receives two parameters: 1. the slot index (integer), and 2. a boolean parameter indicating if the slot at that index has a clip that is currently recording (`true`) or not (`false`)
      Since:
      API version 1

    • addIsPlaybackQueuedObserver

      void addIsPlaybackQueuedObserver(IndexedBooleanValueChangedCallback callback)
      Add an observer if clip playback is queued on the slot.
      Parameters:
      callback - a callback function that receives two parameters: 1. the slot index (integer), and 2. a boolean parameter indicating if the slot at that index has a clip that is currently queued for playback (`true`) or not (`false`)
      Since:
      API version 1

    • addIsRecordingQueuedObserver

      void addIsRecordingQueuedObserver(IndexedBooleanValueChangedCallback callback)
      Add an observer if clip recording is queued on the slot.
      Parameters:
      callback - a callback function that receives two parameters: 1. the slot index (integer), and 2. a boolean parameter indicating if the slot at that index has a clip that is currently queued for recording (`true`) or not (`false`)
      Since:
      API version 1

    • addIsStopQueuedObserver

      void addIsStopQueuedObserver(IndexedBooleanValueChangedCallback callback)
      Add an observer if clip playback is queued to stop on the slot.
      Parameters:
      callback - a callback function that receives two parameters: 1. the slot index (integer), and 2. a boolean parameter indicating if the slot at that index has a clip that is currently queued for stop (`true`) or not (`false`)
      Since:
      API version 1

    • addIsQueuedObserver

      @Deprecated void addIsQueuedObserver(IndexedBooleanValueChangedCallback callback)
      Deprecated.
      Use addIsPlaybackQueuedObserver(com.bitwig.extension.callback.IndexedBooleanValueChangedCallback) instead.
      Since:
      API version 1

    • addColorObserver

      void addColorObserver(IndexedColorValueChangedCallback callback)
      Registers an observer that reports the colors of clip in the current slot window.
      Parameters:
      callback - a callback function that receives four parameters: 1. the slot index (integer), 2. the red coordinate of the RBG color value, 3. the green coordinate of the RBG color value, and 4. the blue coordinate of the RBG color value
      Since:
      API version 1

    • setIndication

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

    • isMasterTrackContentShownOnTrackGroups

      SettableBooleanValue isMasterTrackContentShownOnTrackGroups()
      Returns an object that can be used to observe and toggle if the slots on a connected track group show either scenes launch buttons (for launching the content of the track group) or the clips of the group master track.
      Returns:
      a boolean value object.