CursorTrack Interface Reference

Inheritance diagram for CursorTrack:

Public Member Functions
void	selectParent ()
void	selectFirstChild ()
void	setCursorNavigationMode (CursorNavigationMode mode)
PinnableCursorDevice	createCursorDevice ()
PinnableCursorDevice	createCursorDevice (String name)
PinnableCursorDevice	createCursorDevice (String name, int numSends)
PinnableCursorDevice	createCursorDevice (String id, String name, int numSends, CursorDeviceFollowMode followMode)
PinnableCursorClip	createLauncherCursorClip (int gridWidth, int gridHeight)
PinnableCursorClip	createLauncherCursorClip (String id, String name, int gridWidth, int gridHeight)
Public Member Functions inherited from CursorChannel
void	selectChannel (Channel channel)
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 Channel
SettableBooleanValue	isActivated ()
Parameter	getVolume ()
Parameter	volume ()
Parameter	getPan ()
Parameter	pan ()
SettableBooleanValue	getMute ()
SettableBooleanValue	mute ()
SoloValue	getSolo ()
SoloValue	solo ()
BooleanValue	isMutedBySolo ()
void	addVuMeterObserver (int range, int channel, boolean peak, IntegerValueChangedCallback callback)
void	addNoteObserver (NotePlaybackCallback callback)
PlayingNoteArrayValue	playingNotes ()
void	addColorObserver (ColorValueChangedCallback callback)
SettableColorValue	color ()
SendBank	sendBank ()
Send	getSend (int index)
void	duplicate ()
void	selectInMixer ()
void	addIsSelectedInMixerObserver (BooleanValueChangedCallback callback)
void	makeVisibleInArranger ()
void	makeVisibleInMixer ()
Public Member Functions inherited from DeviceChain
void	selectInEditor ()
SettableStringValue	name ()
void	addNameObserver (int numChars, String textWhenUnassigned, StringValueChangedCallback callback)
void	addIsSelectedInEditorObserver (BooleanValueChangedCallback callback)
void	addIsSelectedObserver (BooleanValueChangedCallback callback)
DeviceBank	createDeviceBank (int numDevices)
Browser	createDeviceBrowser (final int numFilterColumnEntries, final int numResultsColumnEntries)
void	select ()
void	browseToInsertAtStartOfChain ()
void	browseToInsertAtEndOfChain ()
InsertionPoint	startOfDeviceChainInsertionPoint ()
InsertionPoint	endOfDeviceChainInsertionPoint ()
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 ()
Public Member Functions inherited from Track
IntegerValue	position ()
void	addPositionObserver (IntegerValueChangedCallback callback)
ClipLauncherSlotBank	getClipLauncherSlots ()
ClipLauncherSlotBank	clipLauncherSlotBank ()
ClipLauncherSlotBank	getClipLauncher ()
void	addIsQueuedForStopObserver (BooleanValueChangedCallback callback)
SettableBooleanValue	getArm ()
SettableBooleanValue	arm ()
SettableBooleanValue	getMonitor ()
SettableBooleanValue	monitor ()
BooleanValue	isMonitoring ()
SettableBooleanValue	getAutoMonitor ()
SettableBooleanValue	autoMonitor ()
SettableEnumValue	monitorMode ()
SettableEnumValue	getCrossFadeMode ()
SettableEnumValue	crossFadeMode ()
BooleanValue	isStopped ()
BooleanValue	getIsMatrixStopped ()
BooleanValue	getIsMatrixQueuedForStop ()
BooleanValue	isQueuedForStop ()
SourceSelector	getSourceSelector ()
SourceSelector	sourceSelector ()
void	stop ()
HardwareActionBindable	stopAction ()
void	returnToArrangement ()
void	setName (String name)
void	addPitchNamesObserver (IndexedStringValueChangedCallback callback)
void	playNote (int key, int velocity)
void	startNote (int key, int velocity)
void	stopNote (int key, int velocity)
void	sendMidi (int status, int data1, int data2)
StringValue	trackType ()
void	addTrackTypeObserver (int numChars, String textWhenUnassigned, StringValueChangedCallback callback)
BooleanValue	isGroup ()
SettableBooleanValue	getIsPreFader ()
void	addIsGroupObserver (BooleanValueChangedCallback callback)
SettableBooleanValue	getCanHoldNoteData ()
SettableBooleanValue	canHoldNoteData ()
SettableBooleanValue	getCanHoldAudioData ()
SettableBooleanValue	canHoldAudioData ()
Device	getPrimaryDevice ()
Device	getPrimaryInstrument ()
TrackBank	createTrackBank (final int numTracks, final int numSends, final int numScenes, final boolean hasFlatTrackList)
TrackBank	createMainTrackBank (final int numTracks, final int numSends, final int numScenes, final boolean hasFlatTrackList)
TrackBank	createEffectTrackBank (final int numTracks, final int numScenes, final boolean hasFlatTrackList)
MasterTrack	createMasterTrack (final int numScenes)
TrackBank	createSiblingsTrackBank (final int numTracks, final int numSends, final int numScenes, final boolean shouldIncludeEffectTracks, final boolean shouldIncludeMasterTrack)
InsertionPoint	afterTrackInsertionPoint ()
InsertionPoint	beforeTrackInsertionPoint ()
Track	createParentTrack (int numSends, int numScenes)
void	addNoteSource (NoteInput noteInput)
void	removeNoteSource (NoteInput noteInput)
void	createNewLauncherClip (int slotIndex, int lengthInBeats)
void	createNewLauncherClip (int slotIndex)
void	recordNewLauncherClip (int slotIndex)
void	selectSlot (int slotIndex)
Public Member Functions inherited from PinnableCursor
SettableBooleanValue	isPinned ()

Detailed Description

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

Since

API version 1

Definition at line 10 of file CursorTrack.java.

Member Function Documentation

createCursorDevice() [1/4]

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.

Returns

the requested device selection cursor object @

Since

API version 1

Implements Track.

createCursorDevice() [2/4]

PinnableCursorDevice createCursorDevice

(

String

name

)

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.

Deprecated:

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

Implements Track.

createCursorDevice() [3/4]

PinnableCursorDevice createCursorDevice	(	String	name,
		int	numSends
	)

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.

Deprecated:

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

Implements Track.

createCursorDevice() [4/4]

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() [1/2]

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() [2/2]

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

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

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

setCursorNavigationMode()

void setCursorNavigationMode

(

CursorNavigationMode

mode

)

Specifies the behaviour of the functions selectPrevious(), selectNext(), selectFirst() and 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

---

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

• CursorTrack.java