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

Public Member Functions

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 ()
 

Detailed Description

Some kind of physical control on a piece of hardware (such as a knob, button, slider etc).

Since
API version 10

Member Function Documentation

◆ backgroundLight()

HardwareLight backgroundLight ( )

Optional light that is in the background of this control.

◆ beginTouchAction()

HardwareAction beginTouchAction ( )

Action that happens when the user touches this control.

◆ endTouchAction()

HardwareAction endTouchAction ( )

Action that happens when the user stops touching this control.

◆ getName()

String getName ( )

The name of this hardware control. This will be shown in the mapping browser, for example. It should provide enough information for the user to understand which control is being referred to. If the name is not provided then the label will be used, and if that is not provided then the id will be used.

Since
API version 11

◆ isBeingTouched()

BooleanValue isBeingTouched ( )

Value that indicates if this control is being touched or not.

◆ setBackgroundLight()

void setBackgroundLight ( HardwareLight  light)

Sets the optional light that is in the background of this control.

◆ setIndexInGroup()

void setIndexInGroup ( int  index)

If this control is part of group of related controls then this specifies the index in that group. This index is used to automatically indicate a mapping color on a parameter that this hardware control gets bound to.

Since
API version 11

◆ setName()

void setName ( String  name)

The name of this hardware control. This will be shown in the mapping browser, for example. It should provide enough information for the user to understand which control is being referred to. If the name is not provided then the label will be used, and if that is not provided then the id will be used.

Since
API version 11

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