ColorControlTrait.SaturationMoveMode
enum ColorControlTrait.SaturationMoveMode : Enum, ClusterEnum
The direction in which to move a device's saturation.
Summary
Enum Values |
|
|---|---|
Down |
Decrease the device's saturation at a given rate. |
Stop |
Stops a command that is currently moving a device's saturation. |
UnknownValue |
The enum value is out of range. |
Up |
Decrease the device's saturation at a given rate. |
Public functions |
|
|---|---|
ColorControlTrait.SaturationMoveMode |
Returns the enum constant of this type with the specified name. |
Array<ColorControlTrait.SaturationMoveMode> |
values()Returns an array containing the constants of this enum type, in the order they're declared. |
Enum Values
Down
val ColorControlTrait.SaturationMoveMode.Down: ColorControlTrait.SaturationMoveMode
Decrease the device's saturation at a given rate. If the saturation reaches the minimum allowed for the device, command processing stops.
Stop
val ColorControlTrait.SaturationMoveMode.Stop: ColorControlTrait.SaturationMoveMode
Stops a command that is currently moving a device's saturation. This is also stops a MoveToHue or MoveToHueAndSaturation command.
UnknownValue
val ColorControlTrait.SaturationMoveMode.UnknownValue: ColorControlTrait.SaturationMoveMode
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.SaturationMoveMode.Up: ColorControlTrait.SaturationMoveMode
Decrease the device's saturation at a given rate. If the saturation reaches the minimum allowed for the device, command processing stops.
Public functions
valueOf
fun valueOf(value: String): ColorControlTrait.SaturationMoveMode
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.SaturationMoveMode>
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.