ColorControlTrait.SaturationStepMode
enum ColorControlTrait.SaturationStepMode : Enum, ClusterEnum
The direction in which to step a device's saturation.
Summary
Enum Values |
|
|---|---|
Down |
Decrease the device's saturation by one step, in a continuous fashion. |
UnknownValue |
The enum value is out of range. |
Up |
Increase the device's saturation by one step, in a continuous fashion. |
Public functions |
|
|---|---|
ColorControlTrait.SaturationStepMode |
Returns the enum constant of this type with the specified name. |
Array<ColorControlTrait.SaturationStepMode> |
values()Returns an array containing the constants of this enum type, in the order they're declared. |
Enum Values
Down
val ColorControlTrait.SaturationStepMode.Down: ColorControlTrait.SaturationStepMode
Decrease the device's saturation by one step, in a continuous fashion. If the hue reaches the minimum allowed for the device, command processing stops.
UnknownValue
val ColorControlTrait.SaturationStepMode.UnknownValue: ColorControlTrait.SaturationStepMode
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.SaturationStepMode.Up: ColorControlTrait.SaturationStepMode
Increase the device's saturation by one step, in a continuous fashion. If the hue reaches the maximum allowed for the device, command processing stops.
Public functions
valueOf
fun valueOf(value: String): ColorControlTrait.SaturationStepMode
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.SaturationStepMode>
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.