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

Public Member Functions

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)
 

Detailed Description

Instances of this interface represent numeric values that have an upper and lower limit.

Since
API version 1

Member Function Documentation

◆ addRawValueObserver()

void addRawValueObserver ( DoubleValueChangedCallback  callback)

Add an observer which receives the internal raw of the parameter as floating point.

Parameters
callbacka callback function that receives a single numeric parameter with double precision.
Since
API version 1

◆ addValueObserver()

void addValueObserver ( int  range,
IntegerValueChangedCallback  callback 
)

Adds an observer which receives the normalized value of the parameter as an integer number within the range [0..range-1].

Parameters
rangethe range used to scale the value when reported to the callback
callbacka callback function that receives a single double parameter
Since
API version 1

◆ displayedValue()

StringValue displayedValue ( )

Value that represents a formatted text representation of the value whenever the value changes.

Since
API version 2

◆ get()

double get ( )

The current value normalized between 0..1 where 0 represents the minimum value and 1 the maximum.

Since
API version 2

◆ getRaw()

double getRaw ( )

Gets the current value.

Since
API version 2

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