Package com.bitwig.extension.controller.api

Interface CursorDevice

All Superinterfaces:

Cursor, DeleteableObject, Device, DuplicableObject, HardwareBindable, ObjectProxy, RelativeHardwarControlBindable, Subscribable

All Known Subinterfaces:

PinnableCursorDevice

public interface CursorDevice
extends Cursor, Device

A special kind of selection cursor used for devices.

Since:

API version 1

Method Summary

Modifier and Type	Method	Description
Channel	channel()	Returns the channel that this cursor device was created on.
Channel	getChannel()	Deprecated. Use channel() instead.
void	selectDevice(Device device)	Moves this cursor to the given device.
void	selectFirstInChannel(Channel channel)	Selects the first device in the given channel.
void	selectFirstInKeyPad(int key)	Selects the first device in the drum pad associated with the given key.
void	selectFirstInLayer(int index)	Selects the first device in the nested layer with the given index.
void	selectFirstInLayer(String name)	Selects the first device in the nested layer with the given name.
void	selectFirstInSlot(String chain)	Selects the first device in the nested FX slot with the given name.
void	selectLastInChannel(Channel channel)	Selects the last device in the given channel.
void	selectLastInKeyPad(int key)	Selects the last device in the drum pad associated with the given key.
void	selectLastInLayer(int index)	Selects the last device in the nested layer with the given index.
void	selectLastInLayer(String name)	Selects the last device in the nested layer with the given name.
void	selectLastInSlot(String chain)	Selects the last device in the nested FX slot with the given name.
void	selectParent()	Selects the parent device if there is any.

Methods inherited from interface com.bitwig.extension.controller.api.Cursor

addCanSelectNextObserver, addCanSelectPreviousObserver, hasNext, hasPrevious, selectFirst, selectLast, selectNext, selectNextAction, selectPrevious, selectPreviousAction

Methods inherited from interface com.bitwig.extension.controller.api.DeleteableObject

deleteObject, deleteObjectAction

Methods inherited from interface com.bitwig.extension.controller.api.Device

addActiveModulationSourceObserver, addDirectParameterIdObserver, addDirectParameterNameObserver, addDirectParameterNormalizedValueObserver, addDirectParameterValueDisplayObserver, addHasSelectedDeviceObserver, addIsEnabledObserver, addIsPluginObserver, addNameObserver, addNextParameterPageEnabledObserver, addPageNamesObserver, addPositionObserver, addPresetCategoriesObserver, addPresetCategoryObserver, addPresetCreatorObserver, addPresetCreatorsObserver, addPresetNameObserver, addPresetNamesObserver, addPreviousParameterPageEnabledObserver, addSampleNameObserver, addSelectedPageObserver, addSlotsObserver, afterDeviceInsertionPoint, beforeDeviceInsertionPoint, browseToInsertAfterDevice, browseToInsertBeforeDevice, browseToReplaceDevice, createChainSelector, createCursorLayer, createCursorRemoteControlsPage, createCursorRemoteControlsPage, createDeviceBrowser, createDrumPadBank, createLayerBank, createSiblingsDeviceBank, createSpecificBitwigDevice, createSpecificVst2Device, createSpecificVst2Device, createSpecificVst3Device, createSpecificVst3Device, deviceChain, deviceType, getCommonParameter, getCursorSlot, getDeviceChain, getEnvelopeParameter, getMacro, getModulationSource, getParameter, hasDrumPads, hasLayers, hasSlots, incDirectParameterValueNormalized, isEnabled, isExpanded, isMacroSectionVisible, isNested, isParameterPageSectionVisible, isPlugin, isRemoteControlsSectionVisible, isWindowOpen, loadPreset, name, nextParameterPage, position, presetCategory, presetCreator, presetName, previousParameterPage, replaceDeviceInsertionPoint, sampleName, selectInEditor, setDirectParameterValueNormalized, setParameterPage, setPresetCategory, setPresetCreator, slotNames, switchToNextPreset, switchToNextPresetCategory, switchToNextPresetCreator, switchToPreviousPreset, switchToPreviousPresetCategory, switchToPreviousPresetCreator, toggleEnabledState

Methods inherited from interface com.bitwig.extension.controller.api.DuplicableObject

duplicateObject, duplicateObjectAction

Methods inherited from interface com.bitwig.extension.controller.api.ObjectProxy

createEqualsValue, exists

Methods inherited from interface com.bitwig.extension.controller.api.RelativeHardwarControlBindable

addBinding, addBindingWithSensitivity

Methods inherited from interface com.bitwig.extension.controller.api.Subscribable

isSubscribed, setIsSubscribed, subscribe, unsubscribe

Method Details

getChannel

@Deprecated
Channel getChannel()

Deprecated.

Use channel() instead.

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

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

selectParent

void selectParent()

Selects the parent device if there is any.

Since:

API version 1

selectDevice

void selectDevice(Device device)

Moves this cursor to the given device.

Parameters:

device - the 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:

channel - the channel 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:

channel - the channel 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:

chain - the name of the FX slot 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:

chain - the name of the FX slot 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:

key - the key associated with the drum pad 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:

key - the key associated with the drum pad in which the device should be selected

Since:

API version 1

selectFirstInLayer

void selectFirstInLayer(int index)

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

Parameters:

index - the index of the nested layer in which the device should be selected

Since:

API version 1

selectLastInLayer

void selectLastInLayer(int index)

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

Parameters:

index - the index of the nested layer in which the device should be selected

Since:

API version 1

selectFirstInLayer

void selectFirstInLayer(String name)

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

Parameters:

name - the name of the nested layer in which the device should be selected

Since:

API version 1

selectLastInLayer

void selectLastInLayer(String name)

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

Parameters:

name - the name of the nested layer in which the device should be selected

Since:

API version 1