Package com.bitwig.extension.controller.api

Interface CursorTrack

All Superinterfaces:

Channel, Cursor, CursorChannel, DeleteableObject, DeviceChain, DuplicableObject, HardwareBindable, ObjectProxy, PinnableCursor, RelativeHardwarControlBindable, Subscribable, Track

public interface CursorTrack
extends CursorChannel, Track, PinnableCursor

Instances of this interface represent the cursor item of track selections.

Since:

API version 1

Method Summary

Modifier and Type	Method	Description
PinnableCursorDevice	createCursorDevice()	Returns an object that provides access to the cursor item of the track's device selection as shown in the Bitwig Studio user interface.
PinnableCursorDevice	createCursorDevice(String name)	Deprecated. Use {createCursorDevice(String, String, int, CursorDeviceFollowMode)} instead.
PinnableCursorDevice	createCursorDevice(String name, int numSends)	Deprecated. Use {createCursorDevice(String, String, int, CursorDeviceFollowMode)} instead.
PinnableCursorDevice	createCursorDevice(String id, String name, int numSends, CursorDeviceFollowMode followMode)	Creates a CursorDevice for this cursor track that by default follows a device based on the supplied follow mode.
PinnableCursorClip	createLauncherCursorClip(int gridWidth, int gridHeight)	Creates a PinnableCursorClip for this track that follows a clip within the track on the clip launcher.
PinnableCursorClip	createLauncherCursorClip(String id, String name, int gridWidth, int gridHeight)	Creates a PinnableCursorClip for this track that follows a clip within the track on the clip launcher.
void	selectFirstChild()	Makes the cursor track point to the first child found with the track group that this cursor currently points to.
void	selectParent()	Makes the cursor track point to it's parent group track, in case it is not already pointing to the root group track.
void	setCursorNavigationMode(CursorNavigationMode mode)	Specifies the behaviour of the functions Cursor.selectPrevious(), Cursor.selectNext(), Cursor.selectFirst() and Cursor.selectLast().

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

addColorObserver, addIsSelectedInMixerObserver, addNoteObserver, addVuMeterObserver, channelId, channelIndex, color, duplicate, getMute, getPan, getSend, getSolo, getVolume, isActivated, isMutedBySolo, makeVisibleInArranger, makeVisibleInMixer, mute, pan, playingNotes, selectInMixer, sendBank, solo, volume

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

selectChannel

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

deleteObject, deleteObjectAction

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

addIsSelectedInEditorObserver, addIsSelectedObserver, addNameObserver, browseToInsertAtEndOfChain, browseToInsertAtStartOfChain, createDeviceBank, createDeviceBrowser, endOfDeviceChainInsertionPoint, name, select, selectInEditor, startOfDeviceChainInsertionPoint

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

isPinned

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

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

addIsGroupObserver, addIsQueuedForStopObserver, addNoteSource, addPitchNamesObserver, addPositionObserver, addTrackTypeObserver, afterTrackInsertionPoint, arm, autoMonitor, beforeTrackInsertionPoint, canHoldAudioData, canHoldNoteData, clipLauncherSlotBank, createCursorRemoteControlsPage, createCursorRemoteControlsPage, createEffectTrackBank, createEffectTrackBank, createMainTrackBank, createMasterTrack, createNewLauncherClip, createNewLauncherClip, createParentTrack, createSiblingsTrackBank, createTrackBank, crossFadeMode, getArm, getAutoMonitor, getCanHoldAudioData, getCanHoldNoteData, getClipLauncher, getClipLauncherSlots, getCrossFadeMode, getIsMatrixQueuedForStop, getIsMatrixStopped, getIsPreFader, getMonitor, getPrimaryDevice, getPrimaryInstrument, getSourceSelector, isGroup, isGroupExpanded, isMonitoring, isQueuedForStop, isStopped, launchLastClipWithOptions, launchLastClipWithOptionsAction, monitor, monitorMode, playNote, position, recordNewLauncherClip, removeNoteSource, returnToArrangement, selectSlot, sendMidi, setName, sourceSelector, startNote, stop, stopAction, stopAlt, stopAltAction, stopNote, trackType

Method Details

selectParent

void selectParent()

Makes the cursor track point to it's parent group track, in case it is not already pointing to the root group track.

Since:

API version 1

selectFirstChild

void selectFirstChild()

Makes the cursor track point to the first child found with the track group that this cursor currently points to. If this cursor is not pointing to a track group or the track group is empty then this has no effect.

Since:

API version 2

setCursorNavigationMode

void setCursorNavigationMode(CursorNavigationMode mode)

Specifies the behaviour of the functions Cursor.selectPrevious(), Cursor.selectNext(), Cursor.selectFirst() and Cursor.selectLast(). Calling those functions can either navigate the cursor within the current nesting level, or over a flat list of either all tracks or only the expanded tracks. Default is CursorNavigationMode.FLAT.

Since:

API version 1

createCursorDevice

PinnableCursorDevice createCursorDevice()

Description copied from interface: Track

Returns an object that provides access to the cursor item of the track's device selection as shown in the Bitwig Studio user interface.

Specified by:

createCursorDevice in interface Track

Returns:

the requested device selection cursor object

createCursorDevice

@Deprecated
PinnableCursorDevice createCursorDevice(String name)

Deprecated.

Use {createCursorDevice(String, String, int, CursorDeviceFollowMode)} instead.

Description copied from interface: Track

Creates a named device selection cursor that is independent from the device selection in the Bitwig Studio user interface, assuming the name parameter is not null. When `name` is `null` the result is equal to calling Track.createCursorDevice().

Specified by:

createCursorDevice in interface Track

Parameters:

name - the name of the custom device selection cursor, for example "Primary", or `null` to refer to the device selection cursor in the arranger cursor track as shown in the Bitwig Studio user interface.

Returns:

the requested device selection cursor object

See Also:

• Track.createCursorDevice()
• Track.createCursorDevice(String name, int numSends)

createCursorDevice

@Deprecated
PinnableCursorDevice createCursorDevice(String name,
 int numSends)

Deprecated.

Use {createCursorDevice(String, String, int, CursorDeviceFollowMode)} instead.

Description copied from interface: Track

Creates a named device selection cursor that is independent from the device selection in the Bitwig Studio user interface, assuming the name parameter is not null. When `name` is `null` the result is equal to calling Track.createCursorDevice().

Specified by:

createCursorDevice in interface Track

Parameters:

name - the name of the custom device selection cursor, for example "Primary", or `null` to refer to the device selection cursor in the arranger cursor track as shown in the Bitwig Studio user interface.

numSends - the number of sends that are simultaneously accessible in nested channels.

Returns:

the requested device selection cursor object

See Also:

• Track.createCursorDevice()

createCursorDevice

PinnableCursorDevice createCursorDevice(String id,
 String name,
 int numSends,
 CursorDeviceFollowMode followMode)

Creates a CursorDevice for this cursor track that by default follows a device based on the supplied follow mode.

Parameters:

id - An id that is used to identify this cursor.

name - A name that is displayed to the user for this cursor.

numSends - the number of sends that are simultaneously accessible in nested channels.

followMode - Mode that defines how this cursor should follow devices.

Since:

API version 2

createLauncherCursorClip

PinnableCursorClip createLauncherCursorClip(int gridWidth,
 int gridHeight)

Creates a PinnableCursorClip for this track that follows a clip within the track on the clip launcher. This clip typically gets updated when the user selects a new clip on the clip launcher. It can also act independently from the user's selection if the user so chooses in the settings for the controller.

Since:

API version 10

createLauncherCursorClip

PinnableCursorClip createLauncherCursorClip(String id,
 String name,
 int gridWidth,
 int gridHeight)

Creates a PinnableCursorClip for this track that follows a clip within the track on the clip launcher. This clip typically gets updated when the user selects a new clip on the clip launcher. It can also act independently from the user's selection if the user so chooses in the settings for the controller.

Since:

API version 10