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

Public Member Functions

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 stopAlt ()
 
HardwareActionBindable stopAltAction ()
 
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 isGroupExpanded ()
 
SettableBooleanValue getIsPreFader ()
 
void addIsGroupObserver (BooleanValueChangedCallback callback)
 
SettableBooleanValue getCanHoldNoteData ()
 
SettableBooleanValue canHoldNoteData ()
 
SettableBooleanValue getCanHoldAudioData ()
 
SettableBooleanValue canHoldAudioData ()
 
CursorDevice createCursorDevice ()
 
CursorDevice createCursorDevice (String name)
 
CursorDevice createCursorDevice (String name, int numSends)
 
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)
 
TrackBank createEffectTrackBank (final int numTracks, final int numSends, 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)
 
void launchLastClipWithOptions (final String quantization, final String launchMode)
 
HardwareActionBindable launchLastClipWithOptionsAction (final String quantization, final String launchMode)
 
CursorRemoteControlsPage createCursorRemoteControlsPage (int parameterCount)
 
CursorRemoteControlsPage createCursorRemoteControlsPage (String name, int parameterCount, String filterExpression)
 
- 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 ()
 
HardwareActionBindable deleteObjectAction ()
 

Detailed Description

Instances of this interface represent tracks in Bitwig Studio.

Since
API version 1

Member Function Documentation

◆ addIsGroupObserver()

void addIsGroupObserver ( BooleanValueChangedCallback  callback)

Registers an observer that reports if the track may contain child tracks, which is the case for group tracks.

Parameters
callbacka callback function that receives a single boolean parameter.
Since
API version 1
Deprecated:
Use isGroup() instead.

◆ addIsQueuedForStopObserver()

void addIsQueuedForStopObserver ( BooleanValueChangedCallback  callback)

Registers an observer that reports if the clip launcher slots are queued for stop.

Parameters
callbacka callback function that receives a single boolean argument.
Since
API version 1
Deprecated:
Use isQueuedForStop() instead.

◆ addNoteSource()

void addNoteSource ( NoteInput  noteInput)

Routes the given noteInput directly to the track regardless of monitoring.

Since
API version 10

◆ addPitchNamesObserver()

void addPitchNamesObserver ( IndexedStringValueChangedCallback  callback)

Registers an observer that reports names for note key values on this track. The track might provide special names for certain keys if it contains instruments that support that features, such as the Bitwig Drum Machine.

Parameters
callbacka callback function that receives two arguments: 1. the key value in the range [0..127], and
  1. the name string
Since
API version 1

◆ addPositionObserver()

void addPositionObserver ( IntegerValueChangedCallback  callback)

Registers an observer that reports the position of the track within the list of Bitwig Studio tracks.

Parameters
callbacka callback function that receives a single integer parameter
Since
API version 1
Deprecated:
Use position() instead.

◆ addTrackTypeObserver()

void addTrackTypeObserver ( int  numChars,
String  textWhenUnassigned,
StringValueChangedCallback  callback 
)

Registers an observer that reports the track type. Possible reported track types are Group, Instrument, Audio, Hybrid, Effect or Master.

Parameters
numCharsthe maximum number of characters used for the reported track type
textWhenUnassignedthe default text that gets reported when the track is not yet associated with a Bitwig Studio track.
callbacka callback function that receives a single track type parameter (string).
Since
API version 1
Deprecated:
Use trackType() instead.

◆ afterTrackInsertionPoint()

InsertionPoint afterTrackInsertionPoint ( )

InsertionPoint that can be used to insert after this track.

Since
API version 7

◆ arm()

Returns an object that provides access to the arm state of the track.

Returns
a boolean value object
Since
API version 5

◆ autoMonitor()

SettableBooleanValue autoMonitor ( )

Returns an object that provides access to the auto-monitoring state of the track.

Returns
a boolean value object
Since
API version 5

◆ beforeTrackInsertionPoint()

InsertionPoint beforeTrackInsertionPoint ( )

InsertionPoint that can be used to insert after this track.

Since
API version 7

◆ canHoldAudioData()

SettableBooleanValue canHoldAudioData ( )

Returns an object that indicates if the track may contain audio events.

Returns
a boolean value object
Since
API version 5

◆ canHoldNoteData()

SettableBooleanValue canHoldNoteData ( )

Returns an object that indicates if the track may contain notes.

Returns
a boolean value object
Since
API version 5

◆ clipLauncherSlotBank()

ClipLauncherSlotBank clipLauncherSlotBank ( )

Returns an object that can be used to access the clip launcher slots of the track.

Returns
an object that represents the clip launcher slots of the track
Since
API version 2

◆ createCursorDevice() [1/3]

CursorDevice 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

Implemented in CursorTrack.

◆ createCursorDevice() [2/3]

CursorDevice createCursorDevice ( String  name)

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.

Parameters
namethe 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
createCursorDevice(String name, int numSends)
Since
API version 1

Implemented in CursorTrack.

◆ createCursorDevice() [3/3]

CursorDevice createCursorDevice ( String  name,
int  numSends 
)

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.

Parameters
namethe 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.
numSendsthe number of sends that are simultaneously accessible in nested channels.
Returns
the requested device selection cursor object
See also
Track::createCursorDevice
Since
API version 1

Implemented in CursorTrack.

◆ createCursorRemoteControlsPage() [1/2]

CursorRemoteControlsPage createCursorRemoteControlsPage ( int  parameterCount)

Creates a cursor for the selected remote controls page in the device with the supplied number of parameters. This section will follow the current page selection made by the user in the application.

Parameters
parameterCountThe number of parameters the remote controls should contain
Since
API version 18

◆ createCursorRemoteControlsPage() [2/2]

CursorRemoteControlsPage createCursorRemoteControlsPage ( String  name,
int  parameterCount,
String  filterExpression 
)

Creates a cursor for a remote controls page in the device with the supplied number of parameters. This section will be independent from the current page selected by the user in Bitwig Studio's user interface. The supplied filter is an expression that can be used to match pages this section is interested in. The expression is matched by looking at the tags added to the pages. If the expression is empty then no filtering will occur.

Parameters
nameA name to associate with this section. This will be used to remember manual mappings made by the user within this section.
parameterCountThe number of parameters the remote controls should contain
filterExpressionAn expression used to match pages that the user can navigate through. For now this can only be the name of a single tag the pages should contain (e.g "drawbars", "dyn", "env", "eq", "filter", "fx", "lfo", "mixer", "osc", "overview", "perf").
Since
API version 18

◆ createEffectTrackBank() [1/2]

TrackBank createEffectTrackBank ( final int  numTracks,
final int  numScenes,
final boolean  hasFlatTrackList 
)

Returns a track bank with the given number of child effect tracks and scenes. Only effect tracks are considered. The track bank will only have content if the connected track is a group track. For more information about track banks and the bank pattern in general, see the documentation for createTrackBank.

Parameters
numTracksthe number of child tracks spanned by the track bank
numScenesthe number of scenes spanned by the track bank
hasFlatTrackListspecifies whether the track bank should operate on a flat list of all nested child tracks or only on the direct child tracks of the connected group track.
Returns
an object for bank-wise navigation of tracks, sends and scenes
See also
createTrackBank
createMainTrackBank
Since
API version 1

◆ createEffectTrackBank() [2/2]

TrackBank createEffectTrackBank ( final int  numTracks,
final int  numSends,
final int  numScenes,
final boolean  hasFlatTrackList 
)

Returns a track bank with the given number of child effect tracks and scenes. Only effect tracks are considered. The track bank will only have content if the connected track is a group track. For more information about track banks and the bank pattern in general, see the documentation for createTrackBank.

Parameters
numTracksthe number of child tracks spanned by the track bank
numSendsthe number of sends spanned by the track bank
numScenesthe number of scenes spanned by the track bank
hasFlatTrackListspecifies whether the track bank should operate on a flat list of all nested child tracks or only on the direct child tracks of the connected group track.
Returns
an object for bank-wise navigation of tracks, sends and scenes
See also
createTrackBank
createMainTrackBank
Since
API version 18

◆ createMainTrackBank()

TrackBank createMainTrackBank ( final int  numTracks,
final int  numSends,
final int  numScenes,
final boolean  hasFlatTrackList 
)

Returns a track bank with the given number of child tracks, sends and scenes. Only audio tracks, instrument tracks and hybrid tracks are considered. The track bank will only have content if the connected track is a group track. For more information about track banks and the bank pattern in general, see the documentation for createTrackBank.

Parameters
numTracksthe number of child tracks spanned by the track bank
numSendsthe number of sends spanned by the track bank
numScenesthe number of scenes spanned by the track bank
hasFlatTrackListspecifies whether the track bank should operate on a flat list of all nested child tracks or only on the direct child tracks of the connected group track.
Returns
an object for bank-wise navigation of tracks, sends and scenes
See also
createTrackBank
createEffectTrackBank
Since
API version 1

◆ createMasterTrack()

MasterTrack createMasterTrack ( final int  numScenes)

Returns an object that represents the master track of the connected track group. The returned object will only have content if the connected track is a group track.

Parameters
numScenesthe number of scenes for bank-wise navigation of the master tracks clip launcher slots.
Returns
an object representing the master track of the connected track group.
Since
API version 1

◆ createNewLauncherClip() [1/2]

void createNewLauncherClip ( int  slotIndex)

Will create a new empty clip at or after slot index. It will use the default clip length. If necessary, a new scene will be created. The new clip will be selected.

Parameters
slotIndexabsolute slot index in the track (unrelated to banks)
Since
API version 10

◆ createNewLauncherClip() [2/2]

void createNewLauncherClip ( int  slotIndex,
int  lengthInBeats 
)

Will create a new empty clip at or after slot index. If necessary, a new scene will be created. The new clip will be selected.

Parameters
slotIndexabsolute slot index in the track (unrelated to banks)
Since
API version 10

◆ createParentTrack()

Track createParentTrack ( int  numSends,
int  numScenes 
)

Creates an object that represent the parent track.

Since
API version 10

◆ createSiblingsTrackBank()

TrackBank createSiblingsTrackBank ( final int  numTracks,
final int  numSends,
final int  numScenes,
final boolean  shouldIncludeEffectTracks,
final boolean  shouldIncludeMasterTrack 
)

Returns a bank of sibling tracks with the given number of tracks, sends and scenes. For more information about track banks and the bank pattern in general, see the documentation for createTrackBank.

Parameters
numTracksthe number of child tracks spanned by the track bank
numSendsthe number of sends spanned by the track bank
numScenesthe number of scenes spanned by the track bank
shouldIncludeEffectTracksspecifies whether effect tracks should be included
shouldIncludeMasterTrackspecifies whether the master should be included
Returns
an object for bank-wise navigation of sibling tracks
See also
createTrackBank
Since
API version 1

◆ createTrackBank()

TrackBank createTrackBank ( final int  numTracks,
final int  numSends,
final int  numScenes,
final boolean  hasFlatTrackList 
)

Returns a track bank with the given number of child tracks, sends and scenes. The track bank will only have content if the connected track is a group track.

A track bank can be seen as a fixed-size window onto the list of tracks in the connected track group including their sends and scenes, that can be scrolled in order to access different parts of the track list. For example a track bank configured for 8 tracks can show track 1-8, 2-9, 3-10 and so on.

The idea behind the bank pattern is that hardware typically is equipped with a fixed amount of channel strips or controls, for example consider a mixing console with 8 channels, but Bitwig Studio documents contain a dynamic list of tracks, most likely more tracks than the hardware can control simultaneously. The track bank returned by this function provides a convenient interface for controlling which tracks are currently shown on the hardware.

Creating a track bank using this method will consider all tracks in the document, including effect tracks and the master track. Use createMainTrackBank or createEffectTrackBank in case you are only interested in tracks of a certain kind.

Parameters
numTracksthe number of child tracks spanned by the track bank
numSendsthe number of sends spanned by the track bank
numScenesthe number of scenes spanned by the track bank
hasFlatTrackListspecifies whether the track bank should operate on a flat list of all nested child tracks or only on the direct child tracks of the connected group track.
Returns
an object for bank-wise navigation of tracks, sends and scenes
See also
createMainTrackBank
createEffectTrackBank
Since
API version 1

◆ crossFadeMode()

SettableEnumValue crossFadeMode ( )

Returns an object that provides access to the cross-fade mode of the track.

Returns
an enum value object that has three possible states: "A", "B", or "AB"
Since
API version 5

◆ getArm()

Returns an object that provides access to the arm state of the track.

Returns
a boolean value object
Since
API version 1
Deprecated:
Use arm() instead.

◆ getAutoMonitor()

SettableBooleanValue getAutoMonitor ( )

Returns an object that provides access to the auto-monitoring state of the track.

Returns
a boolean value object
Since
API version 1
Deprecated:
Use autoMonitor() instead.

◆ getCanHoldAudioData()

SettableBooleanValue getCanHoldAudioData ( )

Returns an object that indicates if the track may contain audio events.

Returns
a boolean value object
Since
API version 1
Deprecated:
Use canHoldAudioData() instead.

◆ getCanHoldNoteData()

SettableBooleanValue getCanHoldNoteData ( )

Returns an object that indicates if the track may contain notes.

Returns
a boolean value object
Since
API version 1
Deprecated:
Use canHoldNoteData() instead.

◆ getClipLauncher()

ClipLauncherSlotBank getClipLauncher ( )
Deprecated:
Use getClipLauncherSlots() instead.
Since
API version 1

◆ getClipLauncherSlots()

ClipLauncherSlotBank getClipLauncherSlots ( )

Returns an object that can be used to access the clip launcher slots of the track.

Returns
an object that represents the clip launcher slots of the track
Since
API version 1
Deprecated:
Use clipLauncherSlotBank() instead.

◆ getCrossFadeMode()

SettableEnumValue getCrossFadeMode ( )

Returns an object that provides access to the cross-fade mode of the track.

Returns
an enum value object that has three possible states: "A", "B", or "AB"
Since
API version 1
Deprecated:
Use crossFadeMode() instead.

◆ getIsMatrixQueuedForStop()

BooleanValue getIsMatrixQueuedForStop ( )

Returns a value object that provides access to the clip launcher's queue-for-stop state on this track. A clip is considered to be queued for stop when playback has been requested to be stopped on that clip, but the playback has not stopped yet due to the current launch quantization settings.

Returns
a boolean value object that indicates if the clip launcher slots have been queued for stop
See also
getIsMatrixStopped()
Since
API version 1
Deprecated:
Use isQueuedForStop() instead.

◆ getIsMatrixStopped()

BooleanValue getIsMatrixStopped ( )

Returns a value object that provides access to the clip launcher playback state of the track.

Returns
a boolean value object that indicates if the clip launcher is stopped for this track
See also
getIsMatrixQueuedForStop()
Since
API version 1
Deprecated:
Use isStopped() instead.

◆ getIsPreFader()

SettableBooleanValue getIsPreFader ( )

If the track is an effect track, returns an object that indicates if the effect track is configured as pre-fader.

Since
API version 10

◆ getMonitor()

SettableBooleanValue getMonitor ( )

Returns an object that provides access to the monitoring state of the track.

Returns
a boolean value object
Since
API version 1
Deprecated:
Use monitor() instead.

◆ getPrimaryDevice()

Device getPrimaryDevice ( )

Gets the channels primary device.

Returns
an object that provides access to the channels primary device.
Deprecated:
Use createCursorDevice("Primary") instead.
Since
API version 1

◆ getPrimaryInstrument()

Device getPrimaryInstrument ( )
Deprecated:
Use createCursorDevice("Primary") instead.
Since
API version 1

◆ getSourceSelector()

SourceSelector getSourceSelector ( )

Returns the source selector for the track, which is shown in the IO section of the track in Bitwig Studio and lists either note or audio sources or both depending on the track type.

Returns
a source selector object
Since
API version 1
Deprecated:
Use sourceSelector() instead.

◆ isGroup()

BooleanValue isGroup ( )

Value that reports if the track may contain child tracks, which is the case for group tracks.

Since
API version 2

◆ isGroupExpanded()

SettableBooleanValue isGroupExpanded ( )

Value that indicates if the group's child tracks are visible.

Since
API version 15

◆ isMonitoring()

BooleanValue isMonitoring ( )

Returns an object that provides a readout of the monitoring state of the track.

Returns
a read-only boolean value object
Since
API version 14

◆ isQueuedForStop()

BooleanValue isQueuedForStop ( )

Value that reports if the clip launcher slots are queued for stop.

Since
API version 2

◆ isStopped()

BooleanValue isStopped ( )

Value that reports if this track is currently stopped. When a track is stopped it is not playing content from the arranger or clip launcher.

Since
API version 2

◆ launchLastClipWithOptions()

void launchLastClipWithOptions ( final String  quantization,
final String  launchMode 
)

Launches the last clip with the given options:

Parameters
quantizationpossible values are "default", "none", "8", "4", "2", "1", "1/2", "1/4", "1/8", "1/16"
launchModepossible values are: "default", "from_start", "continue_or_from_start", "continue_or_synced", "synced"
Since
API version 16

◆ monitor()

SettableBooleanValue monitor ( )

Returns an object that provides access to the monitoring state of the track.

Returns
a boolean value object
Since
API version 5

◆ monitorMode()

SettableEnumValue monitorMode ( )

Returns an object that provides access to the auto-monitoring mode of the track.

Returns
a boolean value object
Since
API version 14

◆ playNote()

void playNote ( int  key,
int  velocity 
)

Plays a note on the track with a default duration and the given key and velocity.

Parameters
keythe key value of the played note
velocitythe velocity of the played note
Since
API version 1

◆ position()

IntegerValue position ( )

Value that reports the position of the track within the list of Bitwig Studio tracks.

Since
API version 2

◆ recordNewLauncherClip()

void recordNewLauncherClip ( int  slotIndex)

Will start recording a new clip at or after slot index. If necessary, a new scene will be created. The new clip will be selected.

Parameters
slotIndexabsolute slot index in the track (unrelated to banks)
Since
API version 10

◆ removeNoteSource()

void removeNoteSource ( NoteInput  noteInput)

Removes a routing operated by addNoteSource(NoteInput)

Since
API version 10

◆ returnToArrangement()

void returnToArrangement ( )

Calling this method causes the arrangement sequencer to take over playback.

Since
API version 1

◆ selectSlot()

void selectSlot ( int  slotIndex)

Selects the slot at the given index.

Parameters
slotIndexabsolute slot index in the track (unrelated to banks)
Since
API version 10

◆ sendMidi()

void sendMidi ( int  status,
int  data1,
int  data2 
)

Sends a MIDI message to the hardware device.

Parameters
statusthe status byte of the MIDI message
data1the data1 part of the MIDI message
data2the data2 part of the MIDI message
Since
API version 2

◆ setName()

void setName ( String  name)

Updates the name of the track.

Parameters
namethe new track name
Since
API version 1

◆ sourceSelector()

SourceSelector sourceSelector ( )

Returns the source selector for the track, which is shown in the IO section of the track in Bitwig Studio and lists either note or audio sources or both depending on the track type.

Returns
a source selector object
Since
API version 5

◆ startNote()

void startNote ( int  key,
int  velocity 
)

Starts playing a note on the track with the given key and velocity.

Parameters
keythe key value of the played note
velocitythe velocity of the played note
Since
API version 1

◆ stop()

void stop ( )

Stops playback of the track.

Since
API version 1

◆ stopAction()

HardwareActionBindable stopAction ( )

Action to call stop().

Since
API version 10

◆ stopAlt()

void stopAlt ( )

Stops playback of the track using alternative quantization.

Since
API version 18

◆ stopAltAction()

HardwareActionBindable stopAltAction ( )

Action to call stopAlt().

Since
API version 18

◆ stopNote()

void stopNote ( int  key,
int  velocity 
)

Stops playing a currently played note.

Parameters
keythe key value of the playing note
velocitythe note-off velocity
Since
API version 1

◆ trackType()

StringValue trackType ( )

Value that reports the track type. Possible reported track types are Group, Instrument, Audio, Hybrid, Effect or Master.

Since
API version 2

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