ColorControlTrait.HueMoveMode
enum ColorControlTrait.HueMoveMode : Enum, ClusterEnum
The direction in which to move a device's hue.
Summary
Enum Values |
|
|---|---|
Down |
Decrease the device's hue at a given rate. |
Stop |
Stops a command that is currently moving a device's hue. |
UnknownValue |
The enum value is out of range. |
Up |
Increase the device's hue at a given rate. |
Public functions |
|
|---|---|
ColorControlTrait.HueMoveMode |
Returns the enum constant of this type with the specified name. |
Array<ColorControlTrait.HueMoveMode> |
values()Returns an array containing the constants of this enum type, in the order they're declared. |
Enum Values
Down
val ColorControlTrait.HueMoveMode.Down: ColorControlTrait.HueMoveMode
Decrease the device's hue at a given rate. If the hue reaches the minimum allowed for the device during command processing, the hue changes to the maximum allowed value and continues to decrease from there.
Stop
val ColorControlTrait.HueMoveMode.Stop: ColorControlTrait.HueMoveMode
Stops a command that is currently moving a device's hue.
UnknownValue
val ColorControlTrait.HueMoveMode.UnknownValue: ColorControlTrait.HueMoveMode
The enum value is out of range. For example, a newer Matter cluster definition may support enum values not yet supported by the Home APIs.
Up
val ColorControlTrait.HueMoveMode.Up: ColorControlTrait.HueMoveMode
Increase the device's hue at a given rate. If the hue reaches the maximum allowed for the device during command processing, the hue changes to the minimum allowed value and continues to increase from there.
Public functions
valueOf
fun valueOf(value: String): ColorControlTrait.HueMoveMode
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
| Throws | |
|---|---|
kotlin.IllegalArgumentException |
if this enum type has no constant with the specified name |
values
fun values(): Array<ColorControlTrait.HueMoveMode>
Returns an array containing the constants of this enum type, in the order they're declared.
This method may be used to iterate over the constants.