StringHardwareProperty Interface Reference
Inheritance diagram for StringHardwareProperty:
Public Member Functions | |
| String | currentValue () |
| String | lastSentValue () |
| void | onUpdateHardware (Consumer< String > sendValueConsumer) |
| void | setValue (String value) |
| void | setValueSupplier (Supplier< String > supplier) |
| int | getMaxChars () |
| void | setMaxChars (int maxChars) |
Detailed Description
Represents an output value shown on some hardware (for example, the title of a track).
- Since
- API version 10
Definition at line 11 of file StringHardwareProperty.java.
Member Function Documentation
◆ currentValue()
| String currentValue | ( | ) |
Gets the current value. This is the value that should be sent to the hardware to be displayed.
◆ getMaxChars()
| int getMaxChars | ( | ) |
The maximum number of characters that can be output or -1 if not specified and there is no limit.
◆ lastSentValue()
| String lastSentValue | ( | ) |
The value that was last sent to the hardware.
◆ onUpdateHardware()
| void onUpdateHardware | ( | Consumer< String > | sendValueConsumer | ) |
Specifies a callback that should be called with the value that needs to be sent to the hardware. This callback is called as a result of calling the HardwareSurface#updateHardware() method (typically from the flush method).
◆ setValue()
| void setValue | ( | String | value | ) |
Sets the current value.
◆ setValueSupplier()
| void setValueSupplier | ( | Supplier< String > | supplier | ) |
Sets the current value from a Supplier that supplies the latest value.
The documentation for this interface was generated from the following file: