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

Classes

enum  ChainLocation
 
enum  DeviceType
 

Public Member Functions

void switchToDevice (DeviceType deviceType, ChainLocation chainLocation)
 
void addCanSwitchToDeviceObserver (DeviceType deviceType, ChainLocation chainLocation, BooleanValueChangedCallback callback)
 
- Public Member Functions inherited from Device
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

A special kind of device that represents the primary device of a track.

Since
API version 1
Deprecated:
This is now replaced by creating a named CursorDevice.
See also
Track::createCursorDevice(String)

Member Function Documentation

◆ addCanSwitchToDeviceObserver()

void addCanSwitchToDeviceObserver ( DeviceType  deviceType,
ChainLocation  chainLocation,
BooleanValueChangedCallback  callback 
)

Registers an observer that reports if navigation to another device with the provided characteristics is possible.

Parameters
deviceTypethe requested device type of the new primary device
chainLocationthe requested chain location of the new primary device
callbacka callback function the receives a single boolean parameter
Since
API version 1
Deprecated:
This method never did anything. Please do not use.

◆ switchToDevice()

void switchToDevice ( DeviceType  deviceType,
ChainLocation  chainLocation 
)

Makes the device with the given type and location the new primary device.

Parameters
deviceTypethe requested device type of the new primary device
chainLocationthe requested chain location of the new primary device
Since
API version 1

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