Bitwig Studio Control Surface API  5.0.11
ContinuousHardwareControl< HardwareBindingType extends HardwareBinding > Interface Template Reference
+ Inheritance diagram for ContinuousHardwareControl< HardwareBindingType extends HardwareBinding >:

Public Member Functions

HardwareButton hardwareButton ()
 
void setHardwareButton (HardwareButton button)
 
StringValue targetName ()
 
DoubleValue targetValue ()
 
StringValue targetDisplayedValue ()
 
DoubleValue modulatedTargetValue ()
 
StringValue modulatedTargetDisplayedValue ()
 
BooleanValue isUpdatingTargetValue ()
 
BooleanValue hasTargetValue ()
 
- Public Member Functions inherited from HardwareControl
String getName ()
 
void setName (String name)
 
void setIndexInGroup (int index)
 
HardwareAction beginTouchAction ()
 
HardwareAction endTouchAction ()
 
BooleanValue isBeingTouched ()
 
HardwareLight backgroundLight ()
 
void setBackgroundLight (HardwareLight light)
 
- Public Member Functions inherited from HardwareElement
String getId ()
 
String getLabel ()
 
void setLabel (String label)
 
Color getLabelColor ()
 
void setLabelColor (Color color)
 
RelativePosition getLabelPosition ()
 
void setLabelPosition (RelativePosition position)
 
void setBounds (double xInMM, double yInMM, double widthInMM, double heightInMM)
 
double getX ()
 
double getY ()
 
double getWidth ()
 
double getHeight ()
 
- Public Member Functions inherited from HardwareBindingSource< HardwareBindingType >
boolean canBindTo (Object target)
 
HardwareBindingType addBinding (HardwareBindable target)
 
void clearBindings ()
 
HardwareBindingType setBinding (HardwareBindable target)
 

Detailed Description

Represents a hardware control that can input a relative or absolute value (for example, a slider, knob, relative encoder...).

Since
API version 10

Member Function Documentation

◆ hardwareButton()

HardwareButton hardwareButton ( )

An optional button that can be associated with this control when this control can also act as a button (e.g by pressing down on it).

◆ hasTargetValue()

BooleanValue hasTargetValue ( )

Value that indicates if this hardware control has a target value that it changes or not.

◆ isUpdatingTargetValue()

BooleanValue isUpdatingTargetValue ( )

Can be called from the targetValue() changed callback to check if this control is responsible for changing the target value or not.

◆ modulatedTargetDisplayedValue()

StringValue modulatedTargetDisplayedValue ( )

Value that represents a formatted text representation of the target's modulated value whenever the value changes.

Since
API version 11

◆ modulatedTargetValue()

DoubleValue modulatedTargetValue ( )

The value of the target that this hardware control has been bound to (0..1).

Since
API version 11

◆ setHardwareButton()

void setHardwareButton ( HardwareButton  button)

Sets an optional button that can be associated with this control when this control can also act as a button (e.g by pressing down on it).

◆ targetDisplayedValue()

StringValue targetDisplayedValue ( )

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

Since
API version 11

◆ targetName()

StringValue targetName ( )

The name of the target that this hardware control has been bound to.

Since
API version 11

◆ targetValue()

DoubleValue targetValue ( )

The value of the target that this hardware control has been bound to (0..1).


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