Bitwig Studio Control Surface API  5.0.11
NoteStep Interface Reference

Classes

enum  State
 

Public Member Functions

int x ()
 
int y ()
 
int channel ()
 
State state ()
 
double velocity ()
 
void setVelocity (double velocity)
 
double releaseVelocity ()
 
void setReleaseVelocity (double velocity)
 
double velocitySpread ()
 
void setVelocitySpread (double amount)
 
double duration ()
 
void setDuration (double duration)
 
double pan ()
 
void setPan (double pan)
 
double timbre ()
 
void setTimbre (double timbre)
 
double pressure ()
 
void setPressure (double pressure)
 
double gain ()
 
void setGain (double gain)
 
double transpose ()
 
void setTranspose (double transpose)
 
boolean isIsSelected ()
 
double chance ()
 
void setChance (double chance)
 
boolean isChanceEnabled ()
 
void setIsChanceEnabled (boolean isEnabled)
 
boolean isOccurrenceEnabled ()
 
void setIsOccurrenceEnabled (boolean isEnabled)
 
NoteOccurrence occurrence ()
 
void setOccurrence (NoteOccurrence condition)
 
boolean isRecurrenceEnabled ()
 
void setIsRecurrenceEnabled (boolean isEnabled)
 
int recurrenceLength ()
 
int recurrenceMask ()
 
void setRecurrence (int length, int mask)
 
boolean isRepeatEnabled ()
 
void setIsRepeatEnabled (boolean isEnabled)
 
int repeatCount ()
 
void setRepeatCount (int count)
 
double repeatCurve ()
 
void setRepeatCurve (double curve)
 
double repeatVelocityEnd ()
 
void setRepeatVelocityEnd (double velocityEnd)
 
double repeatVelocityCurve ()
 
void setRepeatVelocityCurve (double curve)
 
boolean isMuted ()
 
void setIsMuted (boolean value)
 

Detailed Description

Object that describes the content of a step at a given position: x for the time, and y for the key.

Since
API version 10

Member Function Documentation

◆ chance()

double chance ( )

Gets the note chance.

Returns
the probability, 0..1
Since
API version 14

◆ channel()

int channel ( )
Returns
the note's channel, in the range 0..15.
Since
API version 10

◆ duration()

double duration ( )
Returns
the duration of the step in beats
Since
API version 10

◆ gain()

double gain ( )
Returns
the gain of the step, in the range 0..1
Since
API version 10

◆ isChanceEnabled()

boolean isChanceEnabled ( )
Since
API version 14

◆ isIsSelected()

boolean isIsSelected ( )
Returns
true if a note exists and is selected
Since
API version 10

◆ isMuted()

boolean isMuted ( )
Returns
true if the note is muted
Since
API version 14

◆ isOccurrenceEnabled()

boolean isOccurrenceEnabled ( )
Since
API version 14

◆ isRecurrenceEnabled()

boolean isRecurrenceEnabled ( )
Since
API version 14

◆ isRepeatEnabled()

boolean isRepeatEnabled ( )
Since
API version 14

◆ occurrence()

NoteOccurrence occurrence ( )
Since
API version 14

◆ pan()

double pan ( )
Returns
the pan of the step in the range -1..1
Since
API version 10

◆ pressure()

double pressure ( )
Returns
the pressure of the step, in the range 0..1
Since
API version 10

◆ recurrenceLength()

int recurrenceLength ( )
Since
API version 14

◆ recurrenceMask()

int recurrenceMask ( )
Since
API version 14

◆ releaseVelocity()

double releaseVelocity ( )
Returns
the release velocity of the step, in the range 0..1
Since
API version 10

◆ repeatCount()

int repeatCount ( )
Since
API version 14

◆ repeatCurve()

double repeatCurve ( )
Since
API version 14

◆ repeatVelocityCurve()

double repeatVelocityCurve ( )
Since
API version 14

◆ repeatVelocityEnd()

double repeatVelocityEnd ( )
Since
API version 14

◆ setChance()

void setChance ( double  chance)

Sets the note chance.

Parameters
chance0..1
Since
API version 14

◆ setDuration()

void setDuration ( double  duration)

If there is a note started at this position, it will update the duration of the note.

Parameters
durationin beats
Since
API version 10

◆ setGain()

void setGain ( double  gain)

If there is a note started at this position, it will update the gain of the note.

Parameters
gainin the range 0..1, a value of 0.5 results in a gain of 0dB.
Since
API version 10

◆ setIsChanceEnabled()

void setIsChanceEnabled ( boolean  isEnabled)
Since
API version 14

◆ setIsMuted()

void setIsMuted ( boolean  value)

Mutes the note if values is true.

Since
API version 14

◆ setIsOccurrenceEnabled()

void setIsOccurrenceEnabled ( boolean  isEnabled)
Since
API version 14

◆ setIsRecurrenceEnabled()

void setIsRecurrenceEnabled ( boolean  isEnabled)
Since
API version 14

◆ setIsRepeatEnabled()

void setIsRepeatEnabled ( boolean  isEnabled)
Since
API version 14

◆ setOccurrence()

void setOccurrence ( NoteOccurrence  condition)
Since
API version 14

◆ setPan()

void setPan ( double  pan)

If there is a note started at this position, it will update the panning of the note.

Parameters
pan-1 for left, +1 for right
Since
API version 10

◆ setPressure()

void setPressure ( double  pressure)

If there is a note started at this position, it will update the pressure of the note.

Parameters
pressurefrom 0 to +1
Since
API version 10

◆ setRecurrence()

void setRecurrence ( int  length,
int  mask 
)
Parameters
lengthfrom 1 to 8
maskbitfield, cycle N -> bit N; max 8 cycles
Since
API version 14

◆ setReleaseVelocity()

void setReleaseVelocity ( double  velocity)

If there is a note started at this position, it will update the release velocity of the note.

Parameters
velocitybetween 0 and 1
Since
API version 10

◆ setRepeatCount()

void setRepeatCount ( int  count)
Parameters
count-127..127, positive values indicates a number of divisions, negative values a rate.
Since
API version 14

◆ setRepeatCurve()

void setRepeatCurve ( double  curve)
Parameters
curve-1..1
Since
API version 14

◆ setRepeatVelocityCurve()

void setRepeatVelocityCurve ( double  curve)
Parameters
curve-1..1
Since
API version 14

◆ setRepeatVelocityEnd()

void setRepeatVelocityEnd ( double  velocityEnd)
Parameters
velocityEnd-1..1, relative velocity amount applied to the note on velocity.
Since
API version 14

◆ setTimbre()

void setTimbre ( double  timbre)

If there is a note started at this position, it will update the timbre of the note.

Parameters
timbrefrom -1 to +1
Since
API version 10

◆ setTranspose()

void setTranspose ( double  transpose)

If there is a note started at this position, it will update the pitch offset of the note.

Parameters
transposein semitones, from -96 to +96
Since
API version 10

◆ setVelocity()

void setVelocity ( double  velocity)

If there is a note started at this position, it will update the velocity of the note.

Parameters
velocitybetween 0 and 1
Since
API version 10

◆ setVelocitySpread()

void setVelocitySpread ( double  amount)
Since
API version 14
Parameters
amountvelocity spread amount in the range 0..1

◆ state()

State state ( )
Returns
the state of the step, it lets you know if a note starts.
Since
API version 10

◆ timbre()

double timbre ( )
Returns
the timbre of the step, in the range -1..1
Since
API version 10

◆ transpose()

double transpose ( )
Returns
the transpose of the step, in semitones
Since
API version 10

◆ velocity()

double velocity ( )
Returns
the velocity of the step, in the range 0..1
Since
API version 10

◆ velocitySpread()

double velocitySpread ( )
Since
API version 14

◆ x()

int x ( )
Returns
the position of the step (time)
Since
API version 10

◆ y()

int y ( )
Returns
the position of the step (key)
Since
API version 10

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