Bitwig Studio Control Surface API  5.0.11
Arranger Interface Reference
+ Inheritance diagram for Arranger:

Public Member Functions

SettableBooleanValue isPlaybackFollowEnabled ()
 
SettableBooleanValue hasDoubleRowTrackHeight ()
 
SettableBooleanValue areCueMarkersVisible ()
 
SettableBooleanValue isClipLauncherVisible ()
 
SettableBooleanValue isTimelineVisible ()
 
SettableBooleanValue isIoSectionVisible ()
 
SettableBooleanValue areEffectTracksVisible ()
 
CueMarkerBank createCueMarkerBank (int size)
 
HardwareActionBindable zoomInLaneHeightsAllAction ()
 
void zoomInLaneHeightsAll ()
 
HardwareActionBindable zoomOutLaneHeightsAllAction ()
 
void zoomOutLaneHeightsAll ()
 
RelativeHardwarControlBindable zoomLaneHeightsAllStepper ()
 
HardwareActionBindable zoomInLaneHeightsSelectedAction ()
 
void zoomInLaneHeightsSelected ()
 
HardwareActionBindable zoomOutLaneHeightsSelectedAction ()
 
void zoomOutLaneHeightsSelected ()
 
RelativeHardwarControlBindable zoomLaneHeightsSelectedStepper ()
 
void addPlaybackFollowObserver (BooleanValueChangedCallback callback)
 
void addTrackRowHeightObserver (BooleanValueChangedCallback callback)
 
void addCueMarkerVisibilityObserver (BooleanValueChangedCallback callback)
 
void togglePlaybackFollow ()
 
void toggleTrackRowHeight ()
 
void toggleCueMarkerVisibility ()
 
- Public Member Functions inherited from TimelineEditor
HardwareActionBindable zoomInAction ()
 
void zoomIn ()
 
HardwareActionBindable zoomOutAction ()
 
void zoomOut ()
 
RelativeHardwarControlBindable zoomLevel ()
 
HardwareActionBindable zoomToFitAction ()
 
void zoomToFit ()
 
HardwareActionBindable zoomToSelectionAction ()
 
void zoomToSelection ()
 
HardwareActionBindable zoomToFitSelectionOrAllAction ()
 
void zoomToFitSelectionOrAll ()
 
HardwareActionBindable zoomToFitSelectionOrPreviousAction ()
 
void zoomToFitSelectionOrPrevious ()
 

Detailed Description

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.

Member Function Documentation

◆ addCueMarkerVisibilityObserver()

void addCueMarkerVisibilityObserver ( BooleanValueChangedCallback  callback)

Registers an observer that reports if the cue marker lane is visible.

Parameters
callbacka callback function object that accepts a single bool parameter.
See also
areCueMarkersVisible()
Deprecated:
call areCueMarkersVisible().addValueObserver instead
Since
API version 1

◆ addPlaybackFollowObserver()

void addPlaybackFollowObserver ( BooleanValueChangedCallback  callback)

Registers an observer that reports if playback-follow is enabled.

Parameters
callbacka callback function object that accepts a single bool parameter
See also
isPlaybackFollowEnabled()
Deprecated:
call isPlaybackFollowEnabled().addValueObserver instead
Since
API version 1

◆ addTrackRowHeightObserver()

void addTrackRowHeightObserver ( BooleanValueChangedCallback  callback)

Registers an observer that reports the current configuration of the arranger track row height.

Parameters
callbacka callback function object that accepts a single bool parameter. The parameter indicates if the row height is double (true) or single (false).
See also
hasDoubleRowTrackHeight()
Deprecated:
call hasDoubleRowTrackHeight().addValueObserver instead
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

◆ 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
sizethe number of simultaneously accessible items
Returns
the requested item bank object

◆ 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

◆ 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

◆ 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

◆ 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

◆ 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

◆ toggleCueMarkerVisibility()

void toggleCueMarkerVisibility ( )

Toggles the visibility of the arranger cue marker lane.

See also
areCueMarkersVisible()
Deprecated:
call areCueMarkersVisible().toggle instead
Since
API version 1

◆ togglePlaybackFollow()

void togglePlaybackFollow ( )

Toggles the playback follow state.

See also
isPlaybackFollowEnabled()
Deprecated:
call isPlaybackFollowEnabled().toggle instead
Since
API version 1

◆ toggleTrackRowHeight()

void toggleTrackRowHeight ( )

Toggles the arranger track row height between double and single.

See also
hasDoubleRowTrackHeight()
Deprecated:
call hasDoubleRowTrackHeight().toggle instead
Since
API version 1

◆ zoomInLaneHeightsAllAction()

HardwareActionBindable zoomInLaneHeightsAllAction ( )

Zooms in all arranger lanes, if it the arranger is visible.

Since
API version 14

◆ zoomInLaneHeightsSelectedAction()

HardwareActionBindable zoomInLaneHeightsSelectedAction ( )

Zooms in selected arranger lanes, if it the arranger is visible.

Since
API version 14

◆ zoomLaneHeightsAllStepper()

RelativeHardwarControlBindable zoomLaneHeightsAllStepper ( )

Same as zoomInLaneHeightsAllAction/zoomOutLaneHeightsAllAction, but as a stepper

Since
API version 14

◆ zoomLaneHeightsSelectedStepper()

RelativeHardwarControlBindable zoomLaneHeightsSelectedStepper ( )

Same as zoomInLaneHeightsSelectedAction/zoomOutLaneHeightsSelectedAction, but as a stepper

Since
API version 14

◆ zoomOutLaneHeightsAllAction()

HardwareActionBindable zoomOutLaneHeightsAllAction ( )

Zooms out all arranger lanes, if it the arranger is visible.

Since
API version 14

◆ zoomOutLaneHeightsSelectedAction()

HardwareActionBindable zoomOutLaneHeightsSelectedAction ( )

Zooms out selected arranger lanes, if it the arranger is visible.

Since
API version 14

The documentation for this interface was generated from the following file: