Package com.bitwig.extension.controller.api

Interface HardwareControl

All Superinterfaces:

HardwareElement

All Known Subinterfaces:

AbsoluteHardwareControl, AbsoluteHardwareKnob, ContinuousHardwareControl<HardwareBindingType>, HardwareButton, HardwareSlider, RelativeHardwareControl, RelativeHardwareKnob

public interface HardwareControl
extends HardwareElement

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

Since:

API version 10

Method Summary

Modifier and Type	Method	Description
HardwareLight	backgroundLight()	Optional light that is in the background of this control.
HardwareAction	beginTouchAction()	Action that happens when the user touches this control.
HardwareAction	endTouchAction()	Action that happens when the user stops touching this control.
String	getName()	The name of this hardware control.
BooleanValue	isBeingTouched()	Value that indicates if this control is being touched or not.
void	setBackgroundLight(HardwareLight light)	Sets the optional light that is in the background of this control.
void	setIndexInGroup(int index)	If this control is part of group of related controls then this specifies the index in that group.
void	setName(String name)	The name of this hardware control.

Methods inherited from interface com.bitwig.extension.controller.api.HardwareElement

getHeight, getId, getLabel, getLabelColor, getLabelPosition, getWidth, getX, getY, setBounds, setLabel, setLabelColor, setLabelPosition

Method Details

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

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

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

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.

isBeingTouched

BooleanValue isBeingTouched()

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

backgroundLight

HardwareLight backgroundLight()

Optional light that is in the background of this control.

setBackgroundLight

void setBackgroundLight(HardwareLight light)

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