MultiStateHardwareLight (Bitwig Studio Extension API)

All Superinterfaces:: HardwareElement, HardwareLight, HardwareOutputElement

public interface MultiStateHardwareLight extends HardwareLight

Represents a physical hardware light on a controller. The light has an on/off state and may also be optionally colored.

Since:: API version 10

Method Summary

Modifier and Type

Method

Description

InternalHardwareLightState

getBestLightStateForColor(Color color)

Determines the best light state for the supplied color.

void

setColor(Color color)

Tries to set this light's state to be the best state to represent the supplied Color.

void

setColorSupplier(Supplier<Color> colorSupplier)

Tries to set this light's state to be the best state to represent the value supplied by the Supplier.

void

setColorToStateFunction(Function<Color,InternalHardwareLightState> function)

Sets a function that can be used to convert a color to the closest possible state representing that color.

ObjectHardwareProperty<InternalHardwareLightState>

state()

Object that represents the current state of this light.

Methods inherited from interface com.bitwig.extension.controller.api.HardwareElement
getHeight, getId, getLabel, getLabelColor, getLabelPosition, getWidth, getX, getY, setBounds, setLabel, setLabelColor, setLabelPosition

Methods inherited from interface com.bitwig.extension.controller.api.HardwareOutputElement
onUpdateHardware

Method Details
- state
  
  ObjectHardwareProperty<InternalHardwareLightState> state()
  
  Object that represents the current state of this light. The interpretation of this value is entirely up to the implementation.
- setColorToStateFunction
  
  void setColorToStateFunction(Function<Color,InternalHardwareLightState> function)
  
  Sets a function that can be used to convert a color to the closest possible state representing that color. Once this function has been provided it is possible to then use the convenient setColor(Color) and setColorSupplier(Supplier) methods.
- setColor
  
  void setColor(Color color)
  Tries to set this light's state to be the best state to represent the supplied Color. For this to be used you must first call
  
  invalid reference
  
  #setColorToStateFunction(IntFunction)
  
  .
- setColorSupplier
  
  void setColorSupplier(Supplier<Color> colorSupplier)
  Tries to set this light's state to be the best state to represent the value supplied by the Supplier. For this to be used you must first call
  
  invalid reference
  
  #setColorToStateFunction(IntFunction)
  
  .
- getBestLightStateForColor
  
  InternalHardwareLightState getBestLightStateForColor(Color color)
  Determines the best light state for the supplied color. For this to be used you must first call
  
  invalid reference
  
  #setColorToStateFunction(IntFunction)
  
  .