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

Public Member Functions

SettableRangedValue value ()
 
RangedValue modulatedValue ()
 
StringValue name ()
 
void addNameObserver (int maxChars, String textWhenUnassigned, StringValueChangedCallback callback)
 
void addValueDisplayObserver (int maxChars, String textWhenUnassigned, StringValueChangedCallback callback)
 
void reset ()
 
void touch (boolean isBeingTouched)
 
void setIndication (boolean shouldIndicate)
 
void setLabel (String label)
 
void restoreAutomationControl ()
 
- Public Member Functions inherited from SettableRangedValue
void set (double value)
 
void setImmediately (double value)
 
void set (Number value, Number resolution)
 
void inc (double increment)
 
void inc (Number increment, Number resolution)
 
void setRaw (double value)
 
void incRaw (double delta)
 
default AbsoluteHardwareControlBinding addBinding (final AbsoluteHardwareControl hardwareControl)
 
AbsoluteHardwareControlBinding addBindingWithRange (AbsoluteHardwareControl hardwareControl, double minNormalizedValue, double maxNormalizedValue)
 
default RelativeHardwareControlToRangedValueBinding addBinding (final RelativeHardwareControl hardwareControl)
 
default RelativeHardwareControlBinding addBindingWithRange (final RelativeHardwareControl hardwareControl, final double minNormalizedValue, final double maxNormalizedValue)
 
RelativeHardwareControlToRangedValueBinding addBindingWithRangeAndSensitivity (RelativeHardwareControl hardwareControl, double minNormalizedValue, double maxNormalizedValue, double sensitivity)
 
default RelativeHardwareControlToRangedValueBinding addBindingWithSensitivity (final RelativeHardwareControl hardwareControl, final double sensitivity)
 
- Public Member Functions inherited from RangedValue
double get ()
 
double getRaw ()
 
default double getAsDouble ()
 
StringValue displayedValue ()
 
void addValueObserver (int range, IntegerValueChangedCallback callback)
 
void addRawValueObserver (DoubleValueChangedCallback callback)
 
- Public Member Functions inherited from Value< DoubleValueChangedCallback >
void markInterested ()
 
void addValueObserver (ObserverType callback)
 
- 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 ()
 

Detailed Description

Instances of this interface represent ranged parameters that can be controlled with automation in Bitwig Studio.

Since
API version 1

Member Function Documentation

◆ addNameObserver()

void addNameObserver ( int  maxChars,
String  textWhenUnassigned,
StringValueChangedCallback  callback 
)

Adds an observer which reports changes to the name of the automated parameter. The callback will get called at least once immediately after calling this method for reporting the current name.

Parameters
maxCharsmaximum length of the string sent to the observer
textWhenUnassignedthe default text to use
callbacka callback function that receives a single string parameter
Since
API version 1
Deprecated:

◆ addValueDisplayObserver()

void addValueDisplayObserver ( int  maxChars,
String  textWhenUnassigned,
StringValueChangedCallback  callback 
)

Adds an observer which sends a formatted text representation of the value whenever the value changes. The callback will get called at least once immediately after calling this method for reporting the current state.

Parameters
maxCharsmaximum length of the string sent to the observer
textWhenUnassignedthe default text to use
callbacka callback function that receives a single string parameter
Since
API version 1
Deprecated:
Use value()#displayedValue() instead

◆ modulatedValue()

RangedValue modulatedValue ( )

Gets the modulated value of this parameter.

Since
API version 2

◆ name()

StringValue name ( )

The name of the parameter.

Since
API version 2

Implemented in RemoteControl.

◆ reset()

void reset ( )

Resets the value to its default.

Since
API version 1

◆ restoreAutomationControl()

void restoreAutomationControl ( )

Restores control of this parameter to automation playback.

Since
API version 1

◆ setIndication()

void setIndication ( boolean  shouldIndicate)

Specifies if this value should be indicated as mapped in Bitwig Studio, which is visually shown as colored dots or tinting on the parameter controls.

Parameters
shouldIndicatetrue in case visual indications should be shown in Bitwig Studio, false otherwise
Since
API version 1

◆ setLabel()

void setLabel ( String  label)

Specifies a label for the mapped hardware parameter as shown in Bitwig Studio, for example in menu items for learning controls.

Parameters
labelthe label to be shown in Bitwig Studio
Since
API version 1

◆ touch()

void touch ( boolean  isBeingTouched)

Touch (or un-touch) the value for automation recording.

Parameters
isBeingTouchedtrue for touching, false for un-touching
Since
API version 1

◆ value()

Gets the current value of this parameter.

Since
API version 2

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