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

Public Member Functions

Channel getChannel ()
 
Channel channel ()
 
void selectParent ()
 
void selectDevice (Device device)
 
void selectFirstInChannel (Channel channel)
 
void selectLastInChannel (Channel channel)
 
void selectFirstInSlot (String chain)
 
void selectLastInSlot (String chain)
 
void selectFirstInKeyPad (int key)
 
void selectLastInKeyPad (int key)
 
void selectFirstInLayer (int index)
 
void selectLastInLayer (int index)
 
void selectFirstInLayer (String name)
 
void selectLastInLayer (String name)
 
- Public Member Functions inherited from Cursor
void selectPrevious ()
 
HardwareActionBindable selectPreviousAction ()
 
void selectNext ()
 
HardwareActionBindable selectNextAction ()
 
void selectFirst ()
 
void selectLast ()
 
BooleanValue hasNext ()
 
BooleanValue hasPrevious ()
 
void addCanSelectPreviousObserver (BooleanValueChangedCallback callback)
 
void addCanSelectNextObserver (BooleanValueChangedCallback callback)
 
- Public Member Functions inherited from RelativeHardwarControlBindable
default RelativeHardwareControlBinding addBinding (RelativeHardwareControl hardwareControl)
 
RelativeHardwareControlBinding addBindingWithSensitivity (RelativeHardwareControl hardwareControl, double sensitivity)
 
- 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 selection cursor used for devices.

Since
API version 1

Member Function Documentation

◆ channel()

Channel channel ( )

Returns the channel that this cursor device was created on. Currently this will always be a track or cursor track instance.

Returns
the track or cursor track object that was used for creation of this cursor device.
Since
API version 5

◆ getChannel()

Channel getChannel ( )

Returns the channel that this cursor device was created on. Currently this will always be a track or cursor track instance.

Returns
the track or cursor track object that was used for creation of this cursor device.
Since
API version 1
Deprecated:
Use channel() instead.

◆ selectDevice()

void selectDevice ( Device  device)

Moves this cursor to the given device.

Parameters
devicethe device that this cursor should point to
Since
API version 1

◆ selectFirstInChannel()

void selectFirstInChannel ( Channel  channel)

Selects the first device in the given channel.

Parameters
channelthe channel in which the device should be selected
Since
API version 1

◆ selectFirstInKeyPad()

void selectFirstInKeyPad ( int  key)

Selects the first device in the drum pad associated with the given key.

Parameters
keythe key associated with the drum pad in which the device should be selected
Since
API version 1

◆ selectFirstInLayer() [1/2]

void selectFirstInLayer ( int  index)

Selects the first device in the nested layer with the given index.

Parameters
indexthe index of the nested layer in which the device should be selected
Since
API version 1

◆ selectFirstInLayer() [2/2]

void selectFirstInLayer ( String  name)

Selects the first device in the nested layer with the given name.

Parameters
namethe name of the nested layer in which the device should be selected
Since
API version 1

◆ selectFirstInSlot()

void selectFirstInSlot ( String  chain)

Selects the first device in the nested FX slot with the given name.

Parameters
chainthe name of the FX slot in which the device should be selected
Since
API version 1

◆ selectLastInChannel()

void selectLastInChannel ( Channel  channel)

Selects the last device in the given channel.

Parameters
channelthe channel in which the device should be selected
Since
API version 1

◆ selectLastInKeyPad()

void selectLastInKeyPad ( int  key)

Selects the last device in the drum pad associated with the given key.

Parameters
keythe key associated with the drum pad in which the device should be selected
Since
API version 1

◆ selectLastInLayer() [1/2]

void selectLastInLayer ( int  index)

Selects the last device in the nested layer with the given index.

Parameters
indexthe index of the nested layer in which the device should be selected
Since
API version 1

◆ selectLastInLayer() [2/2]

void selectLastInLayer ( String  name)

Selects the last device in the nested layer with the given name.

Parameters
namethe name of the nested layer in which the device should be selected
Since
API version 1

◆ selectLastInSlot()

void selectLastInSlot ( String  chain)

Selects the last device in the nested FX slot with the given name.

Parameters
chainthe name of the FX slot in which the device should be selected
Since
API version 1

◆ selectParent()

void selectParent ( )

Selects the parent device if there is any.

Since
API version 1

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