Control Surface API  2.2.2
NoteLane Interface Reference

Public Member Functions

IntegerValue noteLaneId ()
 
void addNoteValueObserver (IntegerValueChangedCallback callback)
 
StringValue name ()
 
void addNameObserver (int numChars, String textWhenUnassigned, StringValueChangedCallback callback)
 
SettableColorValue color ()
 
void addColorObserver (ColorValueChangedCallback callback)
 
void play (double velocity)
 

Detailed Description

Instances of this interface are used to access the notes for a specific note key.

Since
API version 1

Definition at line 12 of file NoteLane.java.

Member Function Documentation

void addColorObserver ( ColorValueChangedCallback  callback)

Registers an observer that reports the color of the note lane. By default the reported color will be the track color, or in case an associated drum pad has a custom color it will be the color of that pad.

Parameters
callbacka callback function that receives three arguments which from an RGB color: 1. the red dimension of the color value, 2. the green dimension of the color value, and 3. the blue dimension of the color value
Since
API version 1
Deprecated:
Use color() instead.
void addNameObserver ( int  numChars,
String  textWhenUnassigned,
StringValueChangedCallback  callback 
)

Registers an observer that reports the name of the note lane. Typically the name of a note lane is either equal to the title of an associated drum pad, or reflects the pitch of the note, e.g. "C#3".

Parameters
numCharsthe maximum number of characters used for the reported name
textWhenUnassignedthe default name that gets reported when the lane is not yet associated with a note lane in Bitwig Studio
callbacka callback function that receives a single string argument
Since
API version 1
Deprecated:
Use name() instead.
void addNoteValueObserver ( IntegerValueChangedCallback  callback)

Registers an observer for the note value, which is either the note pitch represented by this lane, or in case of audio a lane index (currently always 0 in that case).

Since
API version 1
Deprecated:
Use noteLaneId() instead.
SettableColorValue color ( )

Value the color of the note lane. By default the reported color will be the track color, or in case an associated drum pad has a custom color it will be the color of that pad

StringValue name ( )

Value that reports the name of the note lane. Typically the name of a note lane is either equal to the title of an associated drum pad, or reflects the pitch of the note, e.g. "C#3".

IntegerValue noteLaneId ( )

Value which represents the id of this lane. is either the note pitch represented by this lane, or in case of audio a lane index (currently always 0 in that case).

Since
API version 2
void play ( double  velocity)

Plays a note with the key of the note lane and the provided velocity parameter.

Parameters
velocitythe velocity the note should be played with
Since
API version 1

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