Bitwig Studio Control Surface API
5.0.11
|
This interface represents a device in Bitwig Studio, both internal devices and plugins.
void addActiveModulationSourceObserver | ( | int | len, |
String | textWhenUnassigned, | ||
StringValueChangedCallback | callback | ||
) |
Registers an observer that reports the name of the active modulation source.
len | the maximum length of the name. Longer names will get truncated. |
textWhenUnassigned | the default name that gets reported when the device is not associated with a Bitwig Studio device yet. |
callback | a callback function that receives a single name parameter (string) |
void addDirectParameterIdObserver | ( | StringArrayValueChangedCallback | callback | ) |
Adds an observer on a list of all parameters for the device.
The callback always updates with an array containing all the IDs for the device.
callback | function with the signature (String[]) |
void addDirectParameterNameObserver | ( | int | maxChars, |
DirectParameterNameChangedCallback | callback | ||
) |
Adds an observer for the parameter names (initial and changes) of all parameters for the device.
maxChars | maximum length of the string sent to the observer. |
callback | function with the signature (String ID, String name) |
void addDirectParameterNormalizedValueObserver | ( | DirectParameterNormalizedValueChangedCallback | callback | ) |
Adds an observer for the parameter display value (initial and changes) of all parameters for the device.
callback | a callback function with the signature (String ID, float normalizedValue). If the value is not accessible 'Number.NaN' (not-a-number) is reported, can be checked with 'isNaN(value)'. |
DirectParameterValueDisplayObserver addDirectParameterValueDisplayObserver | ( | int | maxChars, |
DirectParameterDisplayedValueChangedCallback | callback | ||
) |
Returns an observer that reports changes of parameter display values, i.e. parameter values formatted as a string to be read by the user, for example "-6.02 dB". The returned observer object can be used to configure which parameters should be observed. By default no parameters are observed. It should be avoided to observe all parameters at the same time for performance reasons.
maxChars | maximum length of the string sent to the observer. |
callback | function with the signature (String ID, String valueDisplay) |
void addHasSelectedDeviceObserver | ( | BooleanValueChangedCallback | callback | ) |
Registers an observer that reports if the device is selected.
callback | a callback function that receives a single boolean parameter. |
void addIsEnabledObserver | ( | BooleanValueChangedCallback | callback | ) |
Registers an observer that reports if the device is enabled.
callback | a callback function that receives a single boolean parameter |
void addIsPluginObserver | ( | BooleanValueChangedCallback | callback | ) |
Registers an observer that reports if the device is a plugin.
callback | a callback function that receives a single boolean parameter. |
void addNameObserver | ( | int | len, |
String | textWhenUnassigned, | ||
StringValueChangedCallback | callback | ||
) |
Registers an observer that reports the name of the device.
len | the maximum length of the name. Longer names will get truncated. |
textWhenUnassigned | the default name that gets reported when the device is not associated with a Bitwig Studio device yet. |
callback | a callback function that receives a single name (string) parameter |
void addNextParameterPageEnabledObserver | ( | BooleanValueChangedCallback | callback | ) |
Registers an observer that reports if there is a next parameter page.
callback | a callback function that receives a single boolean parameter |
void addPageNamesObserver | ( | StringArrayValueChangedCallback | callback | ) |
Registers an observer that reports the names of the devices parameter pages.
callback | a callback function that receives a single string array parameter containing the names of the parameter pages |
void addPositionObserver | ( | IntegerValueChangedCallback | callback | ) |
Registers an observer that reports the position of the device within the parent device chain.
callback | a callback function that receives a single integer parameter |
void addPresetCategoriesObserver | ( | StringArrayValueChangedCallback | callback | ) |
Registers an observer that reports the names of the available preset categories for the device.
callback | a callback function that receives a single string array parameter containing the names of the preset categories |
void addPresetCategoryObserver | ( | int | len, |
String | textWhenUnassigned, | ||
StringValueChangedCallback | callback | ||
) |
Registers an observer that reports the current preset category name.
len | the maximum length of the name. Longer names will get truncated. |
textWhenUnassigned | the default name that gets reported when the device is not associated with a Bitwig Studio device yet. |
callback | a callback function that receives a single name (string) parameter |
void addPresetCreatorObserver | ( | int | len, |
String | textWhenUnassigned, | ||
StringValueChangedCallback | callback | ||
) |
Registers an observer that reports the current preset creator name.
len | the maximum length of the name. Longer names will get truncated. |
textWhenUnassigned | the default name that gets reported when the device is not associated with a Bitwig Studio device yet. |
callback | a callback function that receives a single name (string) parameter |
void addPresetCreatorsObserver | ( | StringArrayValueChangedCallback | callback | ) |
Registers an observer that reports the names of the available preset creators for the device.
callback | a callback function that receives a single string array parameter containing the names of the preset creators |
void addPresetNameObserver | ( | int | len, |
String | textWhenUnassigned, | ||
StringValueChangedCallback | callback | ||
) |
Registers an observer that reports the last loaded preset name.
len | the maximum length of the name. Longer names will get truncated. |
textWhenUnassigned | the default name that gets reported when the device is not associated with a Bitwig Studio device yet. |
callback | a callback function that receives a single name (string) parameter |
void addPresetNamesObserver | ( | StringArrayValueChangedCallback | callback | ) |
Registers an observer that reports the names of the available presets for the device according to the current configuration of preset category and creator filtering.
callback | a callback function that receives a single string array parameter containing the names of the presets for the current category and creator filter. |
void addPreviousParameterPageEnabledObserver | ( | BooleanValueChangedCallback | callback | ) |
Registers an observer that reports if there is a previous parameter page.
callback | a callback function that receives a single boolean parameter |
void addSampleNameObserver | ( | int | maxChars, |
String | textWhenUnassigned, | ||
StringValueChangedCallback | callback | ||
) |
Registers an observer that reports the file name of the currently loaded sample, in case the device is a sample container device.
maxChars | maximum length of the string sent to the observer. |
textWhenUnassigned | the default name that gets reported when the device is not associated with a Bitwig Studio device yet. |
callback | a callback function that receives a single string parameter. |
void addSelectedPageObserver | ( | int | valueWhenUnassigned, |
IntegerValueChangedCallback | callback | ||
) |
Registers an observer that reports the currently selected parameter page.
valueWhenUnassigned | the default page index that gets reported when the device is not associated with a device instance in Bitwig Studio yet. |
callback | a callback function that receives a single page index parameter (integer) |
void addSlotsObserver | ( | StringArrayValueChangedCallback | callback | ) |
Registers an observer that gets notified when the list of available FX slots changes.
callback | a callback function which takes a single string array argument that contains the names of the slots. |
InsertionPoint afterDeviceInsertionPoint | ( | ) |
InsertionPoint that can be used for inserting after this device.
InsertionPoint beforeDeviceInsertionPoint | ( | ) |
InsertionPoint that can be used for inserting before this device.
void browseToInsertAfterDevice | ( | ) |
Starts browsing for content that can be inserted before this device in Bitwig Studio's popup browser.
void browseToInsertBeforeDevice | ( | ) |
Starts browsing for content that can be inserted before this device in Bitwig Studio's popup browser.
void browseToReplaceDevice | ( | ) |
Starts browsing for content that can replace this device in Bitwig Studio's popup browser.
ChainSelector createChainSelector | ( | ) |
Creates a ChainSelector object which will give you control over the current device if it is an Instrument Selector or an Effect Selector.
To check if the device is currently a ChainSelector, use ChainSelector.exists().
If you want to have access to all the chains, use createLayerBank(int).
CursorDeviceLayer createCursorLayer | ( | ) |
Returns a device layer instance that can be used to navigate the layers or drum pads of the device, in case it has any
This is the selected layer from the user interface.
CursorRemoteControlsPage createCursorRemoteControlsPage | ( | int | parameterCount | ) |
Creates a cursor for the selected remote controls page in the device with the supplied number of parameters. This section will follow the current page selection made by the user in the application.
parameterCount | The number of parameters the remote controls should contain |
CursorRemoteControlsPage createCursorRemoteControlsPage | ( | String | name, |
int | parameterCount, | ||
String | filterExpression | ||
) |
Creates a cursor for a remote controls page in the device with the supplied number of parameters. This section will be independent from the current page selected by the user in Bitwig Studio's user interface. The supplied filter is an expression that can be used to match pages this section is interested in. The expression is matched by looking at the tags added to the pages. If the expression is empty then no filtering will occur.
name | A name to associate with this section. This will be used to remember manual mappings made by the user within this section. |
parameterCount | The number of parameters the remote controls should contain |
filterExpression | An expression used to match pages that the user can navigate through. For now this can only be the name of a single tag the pages should contain (e.g "drawbars", "dyn", "env", "eq", "filter", "fx", "lfo", "mixer", "osc", "overview", "perf"). |
Browser createDeviceBrowser | ( | final int | numFilterColumnEntries, |
final 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 replace the current device.
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. |
DrumPadBank createDrumPadBank | ( | final int | numPads | ) |
Create a bank for navigating the nested layers of the device using a fixed-size window.
numPads | the number of channels that the drum pad bank should be configured with |
DeviceLayerBank createLayerBank | ( | final int | numChannels | ) |
Create a bank for navigating the nested layers of the device using a fixed-size window.
This bank will work over the following devices:
numChannels | the number of channels that the device layer bank should be configured with |
DeviceBank createSiblingsDeviceBank | ( | int | numDevices | ) |
Returns an object that provides bank-wise navigation of sibling devices of the same device chain (including the device instance used to create the siblings bank).
numDevices | the number of devices that are simultaneously accessible |
SpecificBitwigDevice createSpecificBitwigDevice | ( | UUID | deviceId | ) |
Creates an interface for accessing the features of a specific Bitwig device.
SpecificPluginDevice createSpecificVst2Device | ( | int | deviceId | ) |
Creates an interface for accessing the features of a specific VST2 device.
SpecificPluginDevice createSpecificVst2Device | ( | int... | deviceIds | ) |
Creates an interface for accessing the features of a specific VST2 device.
SpecificPluginDevice createSpecificVst3Device | ( | String | deviceId | ) |
Creates an interface for accessing the features of a specific VST2 device.
SpecificPluginDevice createSpecificVst3Device | ( | String... | deviceIds | ) |
Creates an interface for accessing the features of a specific VST2 device.
DeviceChain deviceChain | ( | ) |
Returns a representation of the device chain that contains this device. Possible device chain instances are tracks, device layers, drums pads, or FX slots.
EnumValue deviceType | ( | ) |
The type of this device.
Parameter getCommonParameter | ( | int | index | ) |
Returns the parameter with the given index in the common parameter page.
index | the index of the parameter within the common parameter page. |
DeviceSlot getCursorSlot | ( | ) |
Returns an object that represents the selected device slot as shown in the user interface, and that provides access to the contents of slot's device chain.
DeviceChain getDeviceChain | ( | ) |
Returns a representation of the device chain that contains this device. Possible device chain instances are tracks, device layers, drums pads, or FX slots.
Parameter getEnvelopeParameter | ( | int | index | ) |
Returns the parameter with the given index in the envelope parameter page.
index | the index of the parameter within the envelope parameter page. |
Macro getMacro | ( | int | index | ) |
Returns the macro control at the given index.
index | the index of the macro control, must be in the range [0..7] |
ModulationSource getModulationSource | ( | int | index | ) |
Returns the modulation source at the given index.
index | the index of the modulation source |
Parameter getParameter | ( | int | indexInPage | ) |
Returns the parameter with the given index in the current parameter page.
indexInPage | the index of the parameter within the current parameter page. |
BooleanValue hasDrumPads | ( | ) |
Indicates if the device has individual device chains for each note value.
BooleanValue hasLayers | ( | ) |
Indicates if the device supports nested layers.
BooleanValue hasSlots | ( | ) |
Indicates if the device has nested device chain slots. Use slotNames() to get a list of available slot names, and navigate to devices in those slots using the CursorDevice interface.
void incDirectParameterValueNormalized | ( | String | id, |
Number | increment, | ||
Number | resolution | ||
) |
Increases the parameter with the specified id
by the given increment
according to the given resolution
. To decrease the parameter value pass in a negative increment.
id | the parameter identifier string |
increment | the amount that the parameter value should be increased by, normalized to the range [0..resolution-1] |
resolution | the resolution of the new value |
SettableBooleanValue isEnabled | ( | ) |
Value that reports if the device is enabled.
SettableBooleanValue isExpanded | ( | ) |
Returns an object that provides access to the expanded state of the device.
SettableBooleanValue isMacroSectionVisible | ( | ) |
Returns an object that provides access to the visibility of the device macros section.
BooleanValue isNested | ( | ) |
Indicates if the device is contained by another device.
SettableBooleanValue isParameterPageSectionVisible | ( | ) |
Returns an object that provides access to the visibility of the parameter page mapping editor.
BooleanValue isPlugin | ( | ) |
Value that reports if the device is a plugin.
SettableBooleanValue isRemoteControlsSectionVisible | ( | ) |
Returns an object that provides access to the visibility of the device remote controls section.
SettableBooleanValue isWindowOpen | ( | ) |
Returns an object that provides access to the open state of plugin windows.
void loadPreset | ( | int | index | ) |
Loads the preset with the index from the list provided by addPresetNamesObserver.
StringValue name | ( | ) |
Value that reports the name of the device.
void nextParameterPage | ( | ) |
Switches to the next parameter page.
IntegerValue position | ( | ) |
Value that reports the position of the device within the parent device chain.
StringValue presetCategory | ( | ) |
Value that reports the current preset category name.
StringValue presetCreator | ( | ) |
Value that reports the current preset creator name.
StringValue presetName | ( | ) |
Value that reports the last loaded preset name.
void previousParameterPage | ( | ) |
Switches to the previous parameter page.
InsertionPoint replaceDeviceInsertionPoint | ( | ) |
InsertionPoint that can be used for replacing this device.
StringValue sampleName | ( | ) |
Value that reports the file name of the currently loaded sample, in case the device is a sample container device.
void selectInEditor | ( | ) |
Selects the device in Bitwig Studio.
void setDirectParameterValueNormalized | ( | String | id, |
Number | value, | ||
Number | resolution | ||
) |
Sets the parameter with the specified id
to the given value
according to the given resolution
.
id | the parameter identifier string |
value | the new value normalized to the range [0..resolution-1] |
resolution | the resolution of the new value |
void setParameterPage | ( | int | page | ) |
Switches to the parameter page at the given page index.
page | the index of the desired parameter page |
void setPresetCategory | ( | int | index | ) |
Sets the preset category filter with the index from the array provided by addPresetCategoriesObserver.
void setPresetCreator | ( | int | index | ) |
Sets the preset creator filter with the index from the list provided by addPresetCreatorsObserver.
StringArrayValue slotNames | ( | ) |
Value of the list of available FX slots in this device.
void switchToNextPreset | ( | ) |
Loads the next preset.
void switchToNextPresetCategory | ( | ) |
Switches to the next preset category.
void switchToNextPresetCreator | ( | ) |
Switches to the next preset creator.
void switchToPreviousPreset | ( | ) |
Loads the previous preset.
void switchToPreviousPresetCategory | ( | ) |
Switches to the previous preset category.
void switchToPreviousPresetCreator | ( | ) |
Switches to the previous preset creator.
void toggleEnabledState | ( | ) |
Toggles the enabled state of the device.