Package com.bitwig.extension.controller.api

Interface NoteStep

public interface NoteStep

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	NoteStep.State

Method Summary

Modifier and Type	Method	Description
double	chance()	Gets the note chance.
int	channel()
double	duration()
double	gain()
boolean	isChanceEnabled()
boolean	isIsSelected()
boolean	isMuted()
boolean	isOccurrenceEnabled()
boolean	isRecurrenceEnabled()
boolean	isRepeatEnabled()
NoteOccurrence	occurrence()
double	pan()
double	pressure()
int	recurrenceLength()
int	recurrenceMask()
double	releaseVelocity()
int	repeatCount()
double	repeatCurve()
double	repeatVelocityCurve()
double	repeatVelocityEnd()
void	setChance(double chance)	Sets the note chance.
void	setDuration(double duration)	If there is a note started at this position, it will update the duration of the note.
void	setGain(double gain)	If there is a note started at this position, it will update the gain of the note.
void	setIsChanceEnabled(boolean isEnabled)
void	setIsMuted(boolean value)	Mutes the note if values is true.
void	setIsOccurrenceEnabled(boolean isEnabled)
void	setIsRecurrenceEnabled(boolean isEnabled)
void	setIsRepeatEnabled(boolean isEnabled)
void	setOccurrence(NoteOccurrence condition)
void	setPan(double pan)	If there is a note started at this position, it will update the panning of the note.
void	setPressure(double pressure)	If there is a note started at this position, it will update the pressure of the note.
void	setRecurrence(int length, int mask)
void	setReleaseVelocity(double velocity)	If there is a note started at this position, it will update the release velocity of the note.
void	setRepeatCount(int count)
void	setRepeatCurve(double curve)
void	setRepeatVelocityCurve(double curve)
void	setRepeatVelocityEnd(double velocityEnd)
void	setTimbre(double timbre)	If there is a note started at this position, it will update the timbre of the note.
void	setTranspose(double transpose)	If there is a note started at this position, it will update the pitch offset of the note.
void	setVelocity(double velocity)	If there is a note started at this position, it will update the velocity of the note.
void	setVelocitySpread(double amount)
NoteStep.State	state()
double	timbre()
double	transpose()
double	velocity()
double	velocitySpread()
int	x()
int	y()

Method Details

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

channel

int channel()

Returns:

the note's channel, in the range 0..15.

Since:

API version 10

state

NoteStep.State state()

Returns:

the state of the step, it lets you know if a note starts.

Since:

API version 10

velocity

double velocity()

Returns:

the velocity of the step, in the range 0..1

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:

velocity - between 0 and 1

Since:

API version 10

releaseVelocity

double releaseVelocity()

Returns:

the release velocity of the step, in the range 0..1

Since:

API version 10

setReleaseVelocity

void setReleaseVelocity(double velocity)

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

Parameters:

velocity - between 0 and 1

Since:

API version 10

velocitySpread

double velocitySpread()

Since:

API version 14

setVelocitySpread

void setVelocitySpread(double amount)

Parameters:

amount - velocity spread amount in the range 0..1

Since:

API version 14

duration

double duration()

Returns:

the duration of the step in beats

Since:

API version 10

setDuration

void setDuration(double duration)

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

Parameters:

duration - in beats

Since:

API version 10

pan

double pan()

Returns:

the pan of the step in the range -1..1

Since:

API version 10

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

timbre

double timbre()

Returns:

the timbre of the step, in the range -1..1

Since:

API version 10

setTimbre

void setTimbre(double timbre)

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

Parameters:

timbre - from -1 to +1

Since:

API version 10

pressure

double pressure()

Returns:

the pressure of the step, in the range 0..1

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:

pressure - from 0 to +1

Since:

API version 10

gain

double gain()

Returns:

the gain of the step, in the range 0..1

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:

gain - in the range 0..1, a value of 0.5 results in a gain of 0dB.

Since:

API version 10

transpose

double transpose()

Returns:

the transpose of the step, in semitones

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:

transpose - in semitones, from -96 to +96

Since:

API version 10

isIsSelected

boolean isIsSelected()

Returns:

true if a note exists and is selected

Since:

API version 10

chance

double chance()

Gets the note chance.

Returns:

the probability, 0..1

Since:

API version 14

setChance

void setChance(double chance)

Sets the note chance.

Parameters:

chance - 0..1

Since:

API version 14

isChanceEnabled

boolean isChanceEnabled()

Since:

API version 14

setIsChanceEnabled

void setIsChanceEnabled(boolean isEnabled)

Since:

API version 14

isOccurrenceEnabled

boolean isOccurrenceEnabled()

Since:

API version 14

setIsOccurrenceEnabled

void setIsOccurrenceEnabled(boolean isEnabled)

Since:

API version 14

occurrence

NoteOccurrence occurrence()

Since:

API version 14

setOccurrence

void setOccurrence(NoteOccurrence condition)

Since:

API version 14

isRecurrenceEnabled

boolean isRecurrenceEnabled()

Since:

API version 14

setIsRecurrenceEnabled

void setIsRecurrenceEnabled(boolean isEnabled)

Since:

API version 14

recurrenceLength

int recurrenceLength()

Since:

API version 14

recurrenceMask

int recurrenceMask()

Since:

API version 14

setRecurrence

void setRecurrence(int length,
 int mask)

Parameters:

length - from 1 to 8

mask - bitfield, cycle N -> bit N; max 8 cycles

Since:

API version 14

isRepeatEnabled

boolean isRepeatEnabled()

Since:

API version 14

setIsRepeatEnabled

void setIsRepeatEnabled(boolean isEnabled)

Since:

API version 14

repeatCount

int repeatCount()

Since:

API version 14

setRepeatCount

void setRepeatCount(int count)

Parameters:

count - -127..127, positive values indicates a number of divisions, negative values a rate.

Since:

API version 14

repeatCurve

double repeatCurve()

Since:

API version 14

setRepeatCurve

void setRepeatCurve(double curve)

Parameters:

curve - -1..1

Since:

API version 14

repeatVelocityEnd

double repeatVelocityEnd()

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

repeatVelocityCurve

double repeatVelocityCurve()

Since:

API version 14

setRepeatVelocityCurve

void setRepeatVelocityCurve(double curve)

Parameters:

curve - -1..1

Since:

API version 14

isMuted

boolean isMuted()

Returns:

true if the note is muted

Since:

API version 14

setIsMuted

void setIsMuted(boolean value)

Mutes the note if values is true.

Since:

API version 14