ColorControlTrait.HueDirection
enum ColorControlTrait.HueDirection : Enum, ClusterEnum
The direction in which to move a device's hue along the hue circle.
Summary
Enum Values |
|
|---|---|
Down |
Decreases the hue value along the hue circle to reach the target hue. |
LongestDistance |
Moves along the hue circle in the direction that takes the longest path to reach the target hue. |
ShortestDistance |
Moves along the hue circle in the direction that takes the shortest path to reach the target hue. |
UnknownValue |
The enum value is out of range. |
Up |
Increases the hue value along the hue circle to reach the target hue. |
Public functions |
|
|---|---|
ColorControlTrait.HueDirection |
Returns the enum constant of this type with the specified name. |
Array<ColorControlTrait.HueDirection> |
values()Returns an array containing the constants of this enum type, in the order they're declared. |
Enum Values
Down
val ColorControlTrait.HueDirection.Down: ColorControlTrait.HueDirection
Decreases the hue value along the hue circle to reach the target hue.
LongestDistance
val ColorControlTrait.HueDirection.LongestDistance: ColorControlTrait.HueDirection
Moves along the hue circle in the direction that takes the longest path to reach the target hue.
ShortestDistance
val ColorControlTrait.HueDirection.ShortestDistance: ColorControlTrait.HueDirection
Moves along the hue circle in the direction that takes the shortest path to reach the target hue.
UnknownValue
val ColorControlTrait.HueDirection.UnknownValue: ColorControlTrait.HueDirection
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.HueDirection.Up: ColorControlTrait.HueDirection
Increases the hue value along the hue circle to reach the target hue.
Public functions
valueOf
fun valueOf(value: String): ColorControlTrait.HueDirection
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.HueDirection>
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.