Bitwig Studio Control Surface API
5.0.11
|
Public Attributes | |
String | PANEL_LAYOUT_ARRANGE = "ARRANGE" |
String | PANEL_LAYOUT_MIX = "MIX" |
String | PANEL_LAYOUT_EDIT = "EDIT" |
An interface that provides methods for accessing the most common global application commands.
In addition, functions are provided for accessing any application action in a generic and categorized way, pretty much as displayed in the Bitwig Studio commander dialog (see getActions(), getAction(String), getActionCategories()), getActionCategory(String)).
To receive an instance of the application interface call ControllerHost#createApplication().
void activateEngine | ( | ) |
Activates the audio engine in Bitwig Studio.
void addDisplayProfileObserver | ( | StringValueChangedCallback | callable, |
int | maxChars | ||
) |
Registers an observer that reports the name of the active display profile.
callable | a callback function object that accepts a single string parameter |
maxChars | the maximum length of the display profile name |
void addHasActiveEngineObserver | ( | BooleanValueChangedCallback | callable | ) |
Registers an observer that gets called when the audio engine becomes active or inactive.
callable | a callback function that accepts a single boolean parameter. The callback parameter indicates whether the audio engine became active (true) or inactive (false). |
void addPanelLayoutObserver | ( | StringValueChangedCallback | callable, |
int | maxChars | ||
) |
Registers an observer that reports the name of the active panel layout.
callable | a callback function object that accepts a single string parameter |
maxChars | the maximum length of the panel layout name |
void addProjectNameObserver | ( | StringValueChangedCallback | callback, |
int | maxChars | ||
) |
Registers an observer that reports the name of the current project.
callback | a callback function that accepts a single string parameter. |
maxChars | the maximum length of the reported name. Longer names will get truncated. |
void addSelectedModeObserver | ( | StringValueChangedCallback | callable, |
int | maxChars, | ||
String | fallbackText | ||
) |
void arrowKeyDown | ( | ) |
Equivalent to an Arrow-Down key stroke on the computer keyboard. The concrete functionality depends on the current keyboard focus in Bitwig Studio.
void arrowKeyLeft | ( | ) |
Equivalent to an Arrow-Left key stroke on the computer keyboard. The concrete functionality depends on the current keyboard focus in Bitwig Studio.
void arrowKeyRight | ( | ) |
Equivalent to an Arrow-Right key stroke on the computer keyboard. The concrete functionality depends on the current keyboard focus in Bitwig Studio.
void arrowKeyUp | ( | ) |
Equivalent to an Arrow-Up key stroke on the computer keyboard. The concrete functionality depends on the current keyboard focus in Bitwig Studio.
BooleanValue canRedo | ( | ) |
Value that reports if there is an action to redo.
BooleanValue canUndo | ( | ) |
Value that reports if there is an action to undo.
void copy | ( | ) |
Copies the selected items in Bitwig Studio to the clipboard if applicable.
void createAudioTrack | ( | int | position | ) |
Creates a new audio track at the given position.
position | the index within the list of main tracks where the new track should be inserted, or -1 in case the track should be inserted at the end of the list. Values outside the valid range will get pinned to the valid range, so the actual position might be different from the provided parameter value. |
void createEffectTrack | ( | int | position | ) |
Creates a new effect track at the given position.
position | the index within the list of effect tracks where the new track should be inserted, or -1 in case the track should be inserted at the end of the list. Values outside the valid range will get pinned to the valid range, so the actual position might be different from the provided parameter value. |
void createInstrumentTrack | ( | int | position | ) |
Creates a new instrument track at the given position.
position | the index within the list of main tracks where the new track should be inserted, or -1 in case the track should be inserted at the end of the list. Values outside the valid range will get pinned to the valid range, so the actual position might be different from the provided parameter value. |
void cut | ( | ) |
Cuts the selected items in Bitwig Studio if applicable.
void deactivateEngine | ( | ) |
Deactivates the audio engine in Bitwig Studio.
StringValue displayProfile | ( | ) |
Value that reports the name of the active display profile.
void duplicate | ( | ) |
Duplicates the active selection in Bitwig Studio if applicable.
HardwareActionBindable duplicateAction | ( | ) |
void enter | ( | ) |
Equivalent to an Enter key stroke on the computer keyboard. The concrete functionality depends on the current keyboard focus in Bitwig Studio.
void escape | ( | ) |
Equivalent to an Escape key stroke on the computer keyboard. The concrete functionality depends on the current keyboard focus in Bitwig Studio.
void focusPanelAbove | ( | ) |
Moves the panel focus to the panel above the currently focused panel.
void focusPanelBelow | ( | ) |
Moves the panel focus to the panel below the currently focused panel.
void focusPanelToLeft | ( | ) |
Moves the panel focus to the panel on the left of the currently focused panel.
void focusPanelToRight | ( | ) |
Moves the panel focus to the panel right to the currently focused panel.
Action getAction | ( | String | id | ) |
Returns the action for the given action identifier. For a list of available actions, see getActions().
id | the action identifier string, must not be null |
ActionCategory [] getActionCategories | ( | ) |
Returns a list of action categories that is used by Bitwig Studio to group actions into categories.
ActionCategory getActionCategory | ( | String | id | ) |
Returns the action category associated with the given identifier. For a list of available action categories, see getActionCategories().
id | the category identifier string, must not be null |
Action [] getActions | ( | ) |
Returns a list of actions that the application supports. Actions are commands in Bitwig Studio that are typically accessible through menus or keyboard shortcuts.
Please note that many of the commands encapsulated by the reported actions are also accessible through other (probably more convenient) interfaces methods of the API. In contrast to that, this method provides a more generic way to find available application functionality.
BooleanValue hasActiveEngine | ( | ) |
Value that reports whether an audio engine is active or not.
void navigateIntoTrackGroup | ( | Track | track | ) |
Set BitwigStudio to navigate into the group.
void navigateToParentTrackGroup | ( | ) |
Set BitwigStudio to navigate into the parent group.
void nextPanelLayout | ( | ) |
Switches to the next panel layout of the active display profile in Bitwig Studio.
void nextPerspective | ( | ) |
void nextProject | ( | ) |
Switches to the next project tab in Bitwig Studio.
void nextSubPanel | ( | ) |
Shows the next detail panel (note editor, device, automation).
StringValue panelLayout | ( | ) |
Value that reports the name of the active panel layout.
void paste | ( | ) |
Pastes the clipboard contents into the current selection focus in Bitwig Studio if applicable.
void previousPanelLayout | ( | ) |
Switches to the previous panel layout of the active display profile in Bitwig Studio.
void previousPerspective | ( | ) |
void previousProject | ( | ) |
Switches to the previous project tab in Bitwig Studio.
void previousSubPanel | ( | ) |
Shows the previous detail panel (note editor, device, automation).
StringValue projectName | ( | ) |
Value that reports the name of the current project.
SettableEnumValue recordQuantizationGrid | ( | ) |
Returns the record quantization grid setting from the preferences. Possible values are "OFF", "1/32", "1/16", "1/8", "1/4".
SettableBooleanValue recordQuantizeNoteLength | ( | ) |
Returns a settable value to choose if the record quantization should quantize note length.
void redo | ( | ) |
Sends a redo command to Bitwig Studio.
void remove | ( | ) |
Deletes the selected items in Bitwig Studio if applicable. Originally this function was called delete
(Bitwig Studio 1.0). But as delete
is reserved in JavaScript this function got renamed to remove
in Bitwig Studio 1.0.9.
void rename | ( | ) |
Opens a text input field in Bitwig Studio for renaming the selected item.
void selectAll | ( | ) |
Selects all items according the current selection focus in Bitwig Studio.
void selectFirst | ( | ) |
Selects the first item in the current selection.
void selectLast | ( | ) |
Selects the last item in the current selection.
void selectNext | ( | ) |
Selects the next item in the current selection.
void selectNone | ( | ) |
Deselects any items according the current selection focus in Bitwig Studio.
void selectPrevious | ( | ) |
Selects the previous item in the current selection.
void setPanelLayout | ( | String | panelLayout | ) |
Switches the Bitwig Studio user interface to the panel layout with the given name. The list of available panel layouts depends on the active display profile.
panelLayout | the name of the new panel layout |
void setPerspective | ( | String | perspective | ) |
void toggleAutomationEditor | ( | ) |
Toggles the visibility of the automation editor panel.
void toggleBrowserVisibility | ( | ) |
Toggles the visibility of the browser panel.
void toggleDevices | ( | ) |
Toggles the visibility of the device chain panel.
void toggleFullScreen | ( | ) |
Toggles between full screen and windowed user interface.
void toggleInspector | ( | ) |
Toggles the visibility of the inspector panel.
void toggleMixer | ( | ) |
Toggles the visibility of the mixer panel.
void toggleNoteEditor | ( | ) |
Toggles the visibility of the note editor panel.
void undo | ( | ) |
Sends an undo command to Bitwig Studio.
void zoomIn | ( | ) |
Zooms in one step into the currently focused editor of the Bitwig Studio user interface.
RelativeHardwarControlBindable zoomLevel | ( | ) |
Same as zoomIn/zoomOut, but as a stepper
void zoomOut | ( | ) |
Zooms out one step in the currently focused editor of the Bitwig Studio user interface.
void zoomToFit | ( | ) |
Adjusts the zoom level of the currently focused editor so that all content becomes visible.
void zoomToSelection | ( | ) |
Adjusts the zoom level of the currently focused editor so that it matches the active selection.
void zoomToSelectionOrAll | ( | ) |
Toggles between zoomToSelection and zoomToFit.
void zoomToSelectionOrPrevious | ( | ) |
Toggles between zoomToSelection and the last śet zoom level.
String PANEL_LAYOUT_ARRANGE = "ARRANGE" |
This identifier can be used as parameter for setPanelLayout(String) in order to switch to the ARRANGE
panel layout that is available in various display profiles.
String PANEL_LAYOUT_EDIT = "EDIT" |
This identifier can be used as parameter for setPanelLayout(String) in order to switch to the MIX
panel layout that is available in various display profiles.
String PANEL_LAYOUT_MIX = "MIX" |
This identifier can be used as parameter for setPanelLayout(String) in order to switch to the EDIT
panel layout that is available in various display profiles.