Package com.bitwig.extension.controller.api

Interface Arranger

All Superinterfaces:
TimelineEditor
public interface Arranger extends TimelineEditor
An interface representing various commands which can be performed on the Bitwig Studio arranger. To receive an instance of the application interface call ControllerHost.createArranger().

  • Method Details

    • isPlaybackFollowEnabled

      SettableBooleanValue isPlaybackFollowEnabled()
      Gets an object that allows to enable/disable arranger playback follow. Observers can be registered on the returned object for receiving notifications when the setting switches between on and off.
      Returns:
      a boolean value object that represents the enabled state of arranger playback follow
      Since:
      API version 1

    • hasDoubleRowTrackHeight

      SettableBooleanValue hasDoubleRowTrackHeight()
      Gets an object that allows to control the arranger track height. Observers can be registered on the returned object for receiving notifications when the track height changes.
      Returns:
      a boolean value object that has the state `true` when the tracks have double row height and `false` when the tracks have single row height.
      Since:
      API version 1

    • areCueMarkersVisible

      SettableBooleanValue areCueMarkersVisible()
      Gets an object that allows to show/hide the cue markers in the arranger panel. Observers can be registered on the returned object for receiving notifications when the cue marker lane switches between shown and hidden.
      Returns:
      a boolean value object that represents the cue marker section visibility
      Since:
      API version 1

    • isClipLauncherVisible

      SettableBooleanValue isClipLauncherVisible()
      Gets an object that allows to show/hide the clip launcher in the arranger panel. Observers can be registered on the returned object for receiving notifications when the clip launcher switches between shown and hidden.
      Returns:
      a boolean value object that represents the clip launcher visibility
      Since:
      API version 1

    • isTimelineVisible

      SettableBooleanValue isTimelineVisible()
      Gets an object that allows to show/hide the timeline in the arranger panel. Observers can be registered on the returned object for receiving notifications when the timeline switches between shown and hidden.
      Returns:
      a boolean value object that represents the timeline visibility
      Since:
      API version 1

    • isIoSectionVisible

      SettableBooleanValue isIoSectionVisible()
      Gets an object that allows to show/hide the track input/output choosers in the arranger panel. Observers can be registered on the returned object for receiving notifications when the I/O section switches between shown and hidden.
      Returns:
      a boolean value object that represents the visibility of the track I/O section
      Since:
      API version 1

    • areEffectTracksVisible

      SettableBooleanValue areEffectTracksVisible()
      Gets an object that allows to show/hide the effect tracks in the arranger panel. Observers can be registered on the returned object for receiving notifications when the effect track section switches between shown and hidden.
      Returns:
      a boolean value object that represents the visibility of the effect track section
      Since:
      API version 1

    • createCueMarkerBank

      CueMarkerBank createCueMarkerBank(int size)
      Returns an object that provides access to a bank of successive cue markers using a window configured with the given size, that can be scrolled over the list of markers.
      Parameters:
      size - the number of simultaneously accessible items
      Returns:
      the requested item bank object

    • zoomInLaneHeightsAllAction

      HardwareActionBindable zoomInLaneHeightsAllAction()
      Zooms in all arranger lanes, if it the arranger is visible.
      Since:
      API version 14

    • zoomInLaneHeightsAll

      void zoomInLaneHeightsAll()

    • zoomOutLaneHeightsAllAction

      HardwareActionBindable zoomOutLaneHeightsAllAction()
      Zooms out all arranger lanes, if it the arranger is visible.
      Since:
      API version 14

    • zoomOutLaneHeightsAll

      void zoomOutLaneHeightsAll()

    • zoomLaneHeightsAllStepper

      RelativeHardwarControlBindable zoomLaneHeightsAllStepper()
      Same as zoomInLaneHeightsAllAction/zoomOutLaneHeightsAllAction, but as a stepper
      Since:
      API version 14

    • zoomInLaneHeightsSelectedAction

      HardwareActionBindable zoomInLaneHeightsSelectedAction()
      Zooms in selected arranger lanes, if it the arranger is visible.
      Since:
      API version 14

    • zoomInLaneHeightsSelected

      void zoomInLaneHeightsSelected()

    • zoomOutLaneHeightsSelectedAction

      HardwareActionBindable zoomOutLaneHeightsSelectedAction()
      Zooms out selected arranger lanes, if it the arranger is visible.
      Since:
      API version 14

    • zoomOutLaneHeightsSelected

      void zoomOutLaneHeightsSelected()

    • zoomLaneHeightsSelectedStepper

      RelativeHardwarControlBindable zoomLaneHeightsSelectedStepper()
      Same as zoomInLaneHeightsSelectedAction/zoomOutLaneHeightsSelectedAction, but as a stepper
      Since:
      API version 14

    • addPlaybackFollowObserver

      @Deprecated void addPlaybackFollowObserver(BooleanValueChangedCallback callback)
      Deprecated.
      call `isPlaybackFollowEnabled().addValueObserver` instead
      Registers an observer that reports if playback-follow is enabled.
      Parameters:
      callback - a callback function object that accepts a single bool parameter
      Since:
      API version 1
      See Also:

    • addTrackRowHeightObserver

      @Deprecated void addTrackRowHeightObserver(BooleanValueChangedCallback callback)
      Deprecated.
      call `hasDoubleRowTrackHeight().addValueObserver` instead
      Registers an observer that reports the current configuration of the arranger track row height.
      Parameters:
      callback - a callback function object that accepts a single bool parameter. The parameter indicates if the row height is double (`true`) or single (`false`).
      Since:
      API version 1
      See Also:

    • addCueMarkerVisibilityObserver

      @Deprecated void addCueMarkerVisibilityObserver(BooleanValueChangedCallback callback)
      Deprecated.
      call `areCueMarkersVisible().addValueObserver` instead
      Registers an observer that reports if the cue marker lane is visible.
      Parameters:
      callback - a callback function object that accepts a single bool parameter.
      Since:
      API version 1
      See Also:

    • togglePlaybackFollow

      @Deprecated void togglePlaybackFollow()
      Deprecated.
      call `isPlaybackFollowEnabled().toggle` instead
      Toggles the playback follow state.
      Since:
      API version 1
      See Also:

    • toggleTrackRowHeight

      @Deprecated void toggleTrackRowHeight()
      Deprecated.
      call `hasDoubleRowTrackHeight().toggle` instead
      Toggles the arranger track row height between `double` and `single`.
      Since:
      API version 1
      See Also:

    • toggleCueMarkerVisibility

      @Deprecated void toggleCueMarkerVisibility()
      Deprecated.
      call `areCueMarkersVisible().toggle` instead
      Toggles the visibility of the arranger cue marker lane.
      Since:
      API version 1
      See Also: