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

Public Member Functions

DeviceChain getDeviceChain ()
 
DeviceChain deviceChain ()
 
IntegerValue position ()
 
void addPositionObserver (IntegerValueChangedCallback callback)
 
SettableBooleanValue isWindowOpen ()
 
SettableBooleanValue isExpanded ()
 
SettableBooleanValue isMacroSectionVisible ()
 
SettableBooleanValue isRemoteControlsSectionVisible ()
 
SettableBooleanValue isParameterPageSectionVisible ()
 
Parameter getParameter (int indexInPage)
 
CursorRemoteControlsPage createCursorRemoteControlsPage (int parameterCount)
 
CursorRemoteControlsPage createCursorRemoteControlsPage (String name, int parameterCount, String filterExpression)
 
Parameter getEnvelopeParameter (int index)
 
Parameter getCommonParameter (int index)
 
ModulationSource getModulationSource (int index)
 
Macro getMacro (int index)
 
void addHasSelectedDeviceObserver (BooleanValueChangedCallback callback)
 
void selectInEditor ()
 
BooleanValue isPlugin ()
 
void addIsPluginObserver (BooleanValueChangedCallback callback)
 
void previousParameterPage ()
 
void nextParameterPage ()
 
void addPreviousParameterPageEnabledObserver (BooleanValueChangedCallback callback)
 
void addNextParameterPageEnabledObserver (BooleanValueChangedCallback callback)
 
void setParameterPage (int page)
 
void switchToPreviousPreset ()
 
void switchToNextPreset ()
 
void switchToPreviousPresetCategory ()
 
void switchToNextPresetCategory ()
 
void switchToPreviousPresetCreator ()
 
void switchToNextPresetCreator ()
 
Browser createDeviceBrowser (final int numFilterColumnEntries, final int numResultsColumnEntries)
 
StringValue name ()
 
void addNameObserver (int len, String textWhenUnassigned, StringValueChangedCallback callback)
 
StringValue presetName ()
 
void addPresetNameObserver (int len, String textWhenUnassigned, StringValueChangedCallback callback)
 
StringValue presetCategory ()
 
void addPresetCategoryObserver (int len, String textWhenUnassigned, StringValueChangedCallback callback)
 
StringValue presetCreator ()
 
void addPresetCreatorObserver (int len, String textWhenUnassigned, StringValueChangedCallback callback)
 
void addSelectedPageObserver (int valueWhenUnassigned, IntegerValueChangedCallback callback)
 
void addActiveModulationSourceObserver (int len, String textWhenUnassigned, StringValueChangedCallback callback)
 
void addPageNamesObserver (StringArrayValueChangedCallback callback)
 
void addPresetNamesObserver (StringArrayValueChangedCallback callback)
 
void loadPreset (int index)
 
void addPresetCategoriesObserver (StringArrayValueChangedCallback callback)
 
void setPresetCategory (int index)
 
void addPresetCreatorsObserver (StringArrayValueChangedCallback callback)
 
void setPresetCreator (int index)
 
void toggleEnabledState ()
 
SettableBooleanValue isEnabled ()
 
void addIsEnabledObserver (BooleanValueChangedCallback callback)
 
BooleanValue hasSlots ()
 
StringArrayValue slotNames ()
 
void addSlotsObserver (StringArrayValueChangedCallback callback)
 
DeviceSlot getCursorSlot ()
 
BooleanValue isNested ()
 
BooleanValue hasLayers ()
 
BooleanValue hasDrumPads ()
 
DeviceLayerBank createLayerBank (final int numChannels)
 
DrumPadBank createDrumPadBank (final int numPads)
 
CursorDeviceLayer createCursorLayer ()
 
ChainSelector createChainSelector ()
 
SpecificBitwigDevice createSpecificBitwigDevice (UUID deviceId)
 
SpecificPluginDevice createSpecificVst2Device (int deviceId)
 
SpecificPluginDevice createSpecificVst2Device (int... deviceIds)
 
SpecificPluginDevice createSpecificVst3Device (String deviceId)
 
SpecificPluginDevice createSpecificVst3Device (String... deviceIds)
 
void addDirectParameterIdObserver (StringArrayValueChangedCallback callback)
 
void addDirectParameterNameObserver (int maxChars, DirectParameterNameChangedCallback callback)
 
DirectParameterValueDisplayObserver addDirectParameterValueDisplayObserver (int maxChars, DirectParameterDisplayedValueChangedCallback callback)
 
void addDirectParameterNormalizedValueObserver (DirectParameterNormalizedValueChangedCallback callback)
 
void setDirectParameterValueNormalized (String id, Number value, Number resolution)
 
void incDirectParameterValueNormalized (String id, Number increment, Number resolution)
 
StringValue sampleName ()
 
void addSampleNameObserver (int maxChars, String textWhenUnassigned, StringValueChangedCallback callback)
 
DeviceBank createSiblingsDeviceBank (int numDevices)
 
void browseToInsertBeforeDevice ()
 
void browseToInsertAfterDevice ()
 
void browseToReplaceDevice ()
 
InsertionPoint afterDeviceInsertionPoint ()
 
InsertionPoint beforeDeviceInsertionPoint ()
 
InsertionPoint replaceDeviceInsertionPoint ()
 
EnumValue deviceType ()
 
- Public Member Functions inherited from ObjectProxy
BooleanValue exists ()
 
BooleanValue createEqualsValue (ObjectProxy other)
 
- Public Member Functions inherited from Subscribable
boolean isSubscribed ()
 
void setIsSubscribed (boolean value)
 
void subscribe ()
 
void unsubscribe ()
 
- Public Member Functions inherited from DeleteableObject
void deleteObject ()
 
HardwareActionBindable deleteObjectAction ()
 

Detailed Description

This interface represents a device in Bitwig Studio, both internal devices and plugins.

Since
API version 1

Member Function Documentation

◆ addActiveModulationSourceObserver()

void addActiveModulationSourceObserver ( int  len,
String  textWhenUnassigned,
StringValueChangedCallback  callback 
)

Registers an observer that reports the name of the active modulation source.

Parameters
lenthe maximum length of the name. Longer names will get truncated.
textWhenUnassignedthe default name that gets reported when the device is not associated with a Bitwig Studio device yet.
callbacka callback function that receives a single name parameter (string)
Since
API version 1
Deprecated:
Use createCursorRemoteControlsPage(int) instead.

◆ addDirectParameterIdObserver()

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.

Parameters
callbackfunction with the signature (String[])
Since
API version 1

◆ addDirectParameterNameObserver()

void addDirectParameterNameObserver ( int  maxChars,
DirectParameterNameChangedCallback  callback 
)

Adds an observer for the parameter names (initial and changes) of all parameters for the device.

Parameters
maxCharsmaximum length of the string sent to the observer.
callbackfunction with the signature (String ID, String name)
Since
API version 1

◆ addDirectParameterNormalizedValueObserver()

void addDirectParameterNormalizedValueObserver ( DirectParameterNormalizedValueChangedCallback  callback)

Adds an observer for the parameter display value (initial and changes) of all parameters for the device.

Parameters
callbacka 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)'.
Since
API version 1

◆ addDirectParameterValueDisplayObserver()

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.

Returns
an observer object that can be used to enable or disable actual observing for certain parameters.
Parameters
maxCharsmaximum length of the string sent to the observer.
callbackfunction with the signature (String ID, String valueDisplay)
Since
API version 1

◆ addHasSelectedDeviceObserver()

void addHasSelectedDeviceObserver ( BooleanValueChangedCallback  callback)

Registers an observer that reports if the device is selected.

Parameters
callbacka callback function that receives a single boolean parameter.
Since
API version 1
Deprecated:
Use exists() instead.

◆ addIsEnabledObserver()

void addIsEnabledObserver ( BooleanValueChangedCallback  callback)

Registers an observer that reports if the device is enabled.

Parameters
callbacka callback function that receives a single boolean parameter
Since
API version 1
Deprecated:
Use isEnabled() instead.

◆ addIsPluginObserver()

void addIsPluginObserver ( BooleanValueChangedCallback  callback)

Registers an observer that reports if the device is a plugin.

Parameters
callbacka callback function that receives a single boolean parameter.
Since
API version 1
Deprecated:
Use isPlugin() instead

◆ addNameObserver()

void addNameObserver ( int  len,
String  textWhenUnassigned,
StringValueChangedCallback  callback 
)

Registers an observer that reports the name of the device.

Parameters
lenthe maximum length of the name. Longer names will get truncated.
textWhenUnassignedthe default name that gets reported when the device is not associated with a Bitwig Studio device yet.
callbacka callback function that receives a single name (string) parameter
Since
API version 1
Deprecated:
Use name() instead

◆ addNextParameterPageEnabledObserver()

void addNextParameterPageEnabledObserver ( BooleanValueChangedCallback  callback)

Registers an observer that reports if there is a next parameter page.

Parameters
callbacka callback function that receives a single boolean parameter
Since
API version 1

◆ addPageNamesObserver()

void addPageNamesObserver ( StringArrayValueChangedCallback  callback)

Registers an observer that reports the names of the devices parameter pages.

Parameters
callbacka callback function that receives a single string array parameter containing the names of the parameter pages
Since
API version 1
Deprecated:
Use createCursorRemoteControlsPage(int) instead.

◆ addPositionObserver()

void addPositionObserver ( IntegerValueChangedCallback  callback)

Registers an observer that reports the position of the device within the parent device chain.

Parameters
callbacka callback function that receives a single integer parameter
Since
API version 1
Deprecated:
Use position() instead.

◆ addPresetCategoriesObserver()

void addPresetCategoriesObserver ( StringArrayValueChangedCallback  callback)

Registers an observer that reports the names of the available preset categories for the device.

Parameters
callbacka callback function that receives a single string array parameter containing the names of the preset categories
Since
API version 1
Deprecated:
Use the new browser API instead.

◆ addPresetCategoryObserver()

void addPresetCategoryObserver ( int  len,
String  textWhenUnassigned,
StringValueChangedCallback  callback 
)

Registers an observer that reports the current preset category name.

Parameters
lenthe maximum length of the name. Longer names will get truncated.
textWhenUnassignedthe default name that gets reported when the device is not associated with a Bitwig Studio device yet.
callbacka callback function that receives a single name (string) parameter
Since
API version 1
Deprecated:
use presetCategory() instead.

◆ addPresetCreatorObserver()

void addPresetCreatorObserver ( int  len,
String  textWhenUnassigned,
StringValueChangedCallback  callback 
)

Registers an observer that reports the current preset creator name.

Parameters
lenthe maximum length of the name. Longer names will get truncated.
textWhenUnassignedthe default name that gets reported when the device is not associated with a Bitwig Studio device yet.
callbacka callback function that receives a single name (string) parameter
Since
API version 1
Deprecated:
Use presetCreator() instead.

◆ addPresetCreatorsObserver()

void addPresetCreatorsObserver ( StringArrayValueChangedCallback  callback)

Registers an observer that reports the names of the available preset creators for the device.

Parameters
callbacka callback function that receives a single string array parameter containing the names of the preset creators
Since
API version 1
Deprecated:
Use the new browser API instead.

◆ addPresetNameObserver()

void addPresetNameObserver ( int  len,
String  textWhenUnassigned,
StringValueChangedCallback  callback 
)

Registers an observer that reports the last loaded preset name.

Parameters
lenthe maximum length of the name. Longer names will get truncated.
textWhenUnassignedthe default name that gets reported when the device is not associated with a Bitwig Studio device yet.
callbacka callback function that receives a single name (string) parameter
Since
API version 1
Deprecated:
Use presetName().addValueObserver(callback) instead.

◆ addPresetNamesObserver()

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.

Parameters
callbacka callback function that receives a single string array parameter containing the names of the presets for the current category and creator filter.
See also
addPresetCategoryObserver
addPresetCreatorObserver
setPresetCategory
setPresetCreator
Since
API version 1
Deprecated:
Use the new browser API instead.

◆ addPreviousParameterPageEnabledObserver()

void addPreviousParameterPageEnabledObserver ( BooleanValueChangedCallback  callback)

Registers an observer that reports if there is a previous parameter page.

Parameters
callbacka callback function that receives a single boolean parameter
Since
API version 1

◆ addSampleNameObserver()

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.

Parameters
maxCharsmaximum length of the string sent to the observer.
textWhenUnassignedthe default name that gets reported when the device is not associated with a Bitwig Studio device yet.
callbacka callback function that receives a single string parameter.
Deprecated:
Use sampleName() instead.

◆ addSelectedPageObserver()

void addSelectedPageObserver ( int  valueWhenUnassigned,
IntegerValueChangedCallback  callback 
)

Registers an observer that reports the currently selected parameter page.

Parameters
valueWhenUnassignedthe default page index that gets reported when the device is not associated with a device instance in Bitwig Studio yet.
callbacka callback function that receives a single page index parameter (integer)
Since
API version 1
Deprecated:
Use createCursorRemoteControlsPage(int) instead.

◆ addSlotsObserver()

void addSlotsObserver ( StringArrayValueChangedCallback  callback)

Registers an observer that gets notified when the list of available FX slots changes.

Parameters
callbacka callback function which takes a single string array argument that contains the names of the slots.
Since
API version 1
Deprecated:
Use slotNames() instead.

◆ afterDeviceInsertionPoint()

InsertionPoint afterDeviceInsertionPoint ( )

InsertionPoint that can be used for inserting after this device.

Since
API version 7

◆ beforeDeviceInsertionPoint()

InsertionPoint beforeDeviceInsertionPoint ( )

InsertionPoint that can be used for inserting before this device.

Since
API version 7

◆ browseToInsertAfterDevice()

void browseToInsertAfterDevice ( )

Starts browsing for content that can be inserted before this device in Bitwig Studio's popup browser.

Since
API version 2
Deprecated:
Use afterDeviceInsertionPoint() instead.

◆ browseToInsertBeforeDevice()

void browseToInsertBeforeDevice ( )

Starts browsing for content that can be inserted before this device in Bitwig Studio's popup browser.

Since
API version 2
Deprecated:
Use beforeDeviceInsertionPoint() instead.

◆ browseToReplaceDevice()

void browseToReplaceDevice ( )

Starts browsing for content that can replace this device in Bitwig Studio's popup browser.

Since
API version 2
Deprecated:
Use replaceDeviceInsertionPoint() instead.

◆ createChainSelector()

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).

Returns
a chain selector instance
Since
API version 6

◆ createCursorLayer()

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.

Returns
a cursor device layer instance
Since
API version 1

◆ createCursorRemoteControlsPage() [1/2]

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.

Parameters
parameterCountThe number of parameters the remote controls should contain
Since
API version 2

◆ createCursorRemoteControlsPage() [2/2]

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.

Parameters
nameA name to associate with this section. This will be used to remember manual mappings made by the user within this section.
parameterCountThe number of parameters the remote controls should contain
filterExpressionAn 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").
Since
API version 2

◆ createDeviceBrowser()

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.

Parameters
numFilterColumnEntriesthe size of the window used to navigate the filter column entries.
numResultsColumnEntriesthe size of the window used to navigate the results column entries.
Returns
the requested device browser object.
Since
API version 1
Deprecated:
Use ControllerHost#createPopupBrowser() instead

◆ createDrumPadBank()

DrumPadBank createDrumPadBank ( final int  numPads)

Create a bank for navigating the nested layers of the device using a fixed-size window.

Parameters
numPadsthe number of channels that the drum pad bank should be configured with
Returns
a drum pad bank object configured with the desired number of pads
Since
API version 1

◆ createLayerBank()

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:

  • Instrument Layer
  • Effect Layer
  • Instrument Selector
  • Effect Selector
Parameters
numChannelsthe number of channels that the device layer bank should be configured with
Returns
a device layer bank object configured with the desired number of channels
Since
API version 1

◆ createSiblingsDeviceBank()

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).

Parameters
numDevicesthe number of devices that are simultaneously accessible
Returns
the requested device bank object
Since
API version 1

◆ createSpecificBitwigDevice()

SpecificBitwigDevice createSpecificBitwigDevice ( UUID  deviceId)

Creates an interface for accessing the features of a specific Bitwig device.

Since
API version 12

◆ createSpecificVst2Device() [1/2]

SpecificPluginDevice createSpecificVst2Device ( int  deviceId)

Creates an interface for accessing the features of a specific VST2 device.

Since
API version 12

◆ createSpecificVst2Device() [2/2]

SpecificPluginDevice createSpecificVst2Device ( int...  deviceIds)

Creates an interface for accessing the features of a specific VST2 device.

Since
API version 12

◆ createSpecificVst3Device() [1/2]

SpecificPluginDevice createSpecificVst3Device ( String  deviceId)

Creates an interface for accessing the features of a specific VST2 device.

Since
API version 12

◆ createSpecificVst3Device() [2/2]

SpecificPluginDevice createSpecificVst3Device ( String...  deviceIds)

Creates an interface for accessing the features of a specific VST2 device.

Since
API version 12

◆ deviceChain()

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.

Returns
the requested device chain object
Since
API version 5

◆ deviceType()

EnumValue deviceType ( )

The type of this device.

Since
API version 12

◆ getCommonParameter()

Parameter getCommonParameter ( int  index)

Returns the parameter with the given index in the common parameter page.

Parameters
indexthe index of the parameter within the common parameter page.
Returns
an object that provides access to the requested parameter
Since
API version 1
Deprecated:
The remote controls deprecate this feature. Instead create remote controls with createIndependentRemoteControls(String, int, String).

◆ getCursorSlot()

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.

Returns
the requested slot cursor object
Since
API version 1

◆ getDeviceChain()

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.

Returns
the requested device chain object
Since
API version 1
Deprecated:
Use deviceChain() instead.

◆ getEnvelopeParameter()

Parameter getEnvelopeParameter ( int  index)

Returns the parameter with the given index in the envelope parameter page.

Parameters
indexthe index of the parameter within the envelope parameter page.
Returns
an object that provides access to the requested parameter
Since
API version 1
Deprecated:
The remote controls deprecate this feature. Instead create remote controls with createIndependentRemoteControls(String, int, String).

◆ getMacro()

Macro getMacro ( int  index)

Returns the macro control at the given index.

Parameters
indexthe index of the macro control, must be in the range [0..7]
Returns
An object that represents the requested macro control
Since
API version 1
Deprecated:
Devices no longer have a built in fixed macro section. Instead the user can define pages of mappings and these should be used instead.

◆ getModulationSource()

ModulationSource getModulationSource ( int  index)

Returns the modulation source at the given index.

Parameters
indexthe index of the modulation source
Returns
An object that represents the requested modulation source
Since
API version 1
Deprecated:
The remote controls deprecate this feature. Instead create remote controls with createIndependentRemoteControls(String, int, String).

◆ getParameter()

Parameter getParameter ( int  indexInPage)

Returns the parameter with the given index in the current parameter page.

Parameters
indexInPagethe index of the parameter within the current parameter page.
Returns
an object that provides access to the requested parameter
Deprecated:
Use getRemoteControls().getRemoteControlInSlot(indexInPage)
Since
API version 1

◆ hasDrumPads()

BooleanValue hasDrumPads ( )

Indicates if the device has individual device chains for each note value.

Returns
a value object that indicates if the device has individual device chains for each note value.
Since
API version 1

◆ hasLayers()

BooleanValue hasLayers ( )

Indicates if the device supports nested layers.

Returns
a value object that indicates if the device supports nested layers.
Since
API version 1

◆ hasSlots()

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.

Returns
a value object that indicates if the device has nested device chains in FX slots.
Since
API version 1

◆ incDirectParameterValueNormalized()

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.

Parameters
idthe parameter identifier string
incrementthe amount that the parameter value should be increased by, normalized to the range [0..resolution-1]
resolutionthe resolution of the new value
Since
API version 1

◆ isEnabled()

SettableBooleanValue isEnabled ( )

Value that reports if the device is enabled.

Since
API version 2

◆ isExpanded()

SettableBooleanValue isExpanded ( )

Returns an object that provides access to the expanded state of the device.

Returns
a boolean value object that represents the expanded state of the device.
Since
API version 1

◆ isMacroSectionVisible()

SettableBooleanValue isMacroSectionVisible ( )

Returns an object that provides access to the visibility of the device macros section.

Returns
a boolean value object that represents the macro section visibility.
Deprecated:
Use isRemoteControlsSectionVisible() instead
Since
API version 1

◆ isNested()

BooleanValue isNested ( )

Indicates if the device is contained by another device.

Returns
a value object that indicates if the device is nested
Since
API version 1

◆ isParameterPageSectionVisible()

SettableBooleanValue isParameterPageSectionVisible ( )

Returns an object that provides access to the visibility of the parameter page mapping editor.

Returns
a boolean value object that represents visibility of the parameter page mapping editor.
Deprecated:
Use isRemoteControlsSectionVisible() instead
Since
API version 1

◆ isPlugin()

BooleanValue isPlugin ( )

Value that reports if the device is a plugin.

Since
API version 2

◆ isRemoteControlsSectionVisible()

SettableBooleanValue isRemoteControlsSectionVisible ( )

Returns an object that provides access to the visibility of the device remote controls section.

Returns
a boolean value object that represents the remote controls section visibility.
Since
API version 2

◆ isWindowOpen()

SettableBooleanValue isWindowOpen ( )

Returns an object that provides access to the open state of plugin windows.

Returns
a boolean value object that represents the open state of the editor window, in case the device features a custom editor window (such as plugins).
Since
API version 1

◆ loadPreset()

void loadPreset ( int  index)

Loads the preset with the index from the list provided by addPresetNamesObserver.

Since
API version 1
Deprecated:
Use the new browser API instead.

◆ name()

StringValue name ( )

Value that reports the name of the device.

Since
API version 2

◆ nextParameterPage()

void nextParameterPage ( )

Switches to the next parameter page.

Since
API version 1

◆ position()

IntegerValue position ( )

Value that reports the position of the device within the parent device chain.

Since
API version 2

◆ presetCategory()

StringValue presetCategory ( )

Value that reports the current preset category name.

Since
API version 2

◆ presetCreator()

StringValue presetCreator ( )

Value that reports the current preset creator name.

Since
API version 2

◆ presetName()

StringValue presetName ( )

Value that reports the last loaded preset name.

Since
API version 2

◆ previousParameterPage()

void previousParameterPage ( )

Switches to the previous parameter page.

Since
API version 1

◆ replaceDeviceInsertionPoint()

InsertionPoint replaceDeviceInsertionPoint ( )

InsertionPoint that can be used for replacing this device.

Since
API version 7

◆ sampleName()

StringValue sampleName ( )

Value that reports the file name of the currently loaded sample, in case the device is a sample container device.

Since
API version 2

◆ selectInEditor()

void selectInEditor ( )

Selects the device in Bitwig Studio.

Since
API version 1

◆ setDirectParameterValueNormalized()

void setDirectParameterValueNormalized ( String  id,
Number  value,
Number  resolution 
)

Sets the parameter with the specified id to the given value according to the given resolution.

Parameters
idthe parameter identifier string
valuethe new value normalized to the range [0..resolution-1]
resolutionthe resolution of the new value
Since
API version 1

◆ setParameterPage()

void setParameterPage ( int  page)

Switches to the parameter page at the given page index.

Parameters
pagethe index of the desired parameter page
Since
API version 1

◆ setPresetCategory()

void setPresetCategory ( int  index)

Sets the preset category filter with the index from the array provided by addPresetCategoriesObserver.

Since
API version 1
Deprecated:
Use the new browser API instead.

◆ setPresetCreator()

void setPresetCreator ( int  index)

Sets the preset creator filter with the index from the list provided by addPresetCreatorsObserver.

Since
API version 1
Deprecated:
Use the new browser API instead.

◆ slotNames()

StringArrayValue slotNames ( )

Value of the list of available FX slots in this device.

Since
API version 2

◆ switchToNextPreset()

void switchToNextPreset ( )

Loads the next preset.

Since
API version 1
Deprecated:
Use new browser API provided via createDeviceBrowser(int, int) instead.

◆ switchToNextPresetCategory()

void switchToNextPresetCategory ( )

Switches to the next preset category.

Since
API version 1
Deprecated:
Use new browser API provided via createDeviceBrowser(int, int) instead.

◆ switchToNextPresetCreator()

void switchToNextPresetCreator ( )

Switches to the next preset creator.

Since
API version 1
Deprecated:
Use new browser API provided via createDeviceBrowser(int, int) instead.

◆ switchToPreviousPreset()

void switchToPreviousPreset ( )

Loads the previous preset.

Since
API version 1
Deprecated:
Use new browser API provided via createDeviceBrowser(int, int) instead.

◆ switchToPreviousPresetCategory()

void switchToPreviousPresetCategory ( )

Switches to the previous preset category.

Since
API version 1
Deprecated:
Use new browser API provided via createDeviceBrowser(int, int) instead.

◆ switchToPreviousPresetCreator()

void switchToPreviousPresetCreator ( )

Switches to the previous preset creator.

Since
API version 1
Deprecated:
Use new browser API provided via createDeviceBrowser(int, int) instead.

◆ toggleEnabledState()

void toggleEnabledState ( )

Toggles the enabled state of the device.

Since
API version 1
Deprecated:
Use isEnabled().toggle() instead.

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