ColorControlTrait.MoveSaturationCommand.Request
class ColorControlTrait.MoveSaturationCommand.Request
The request payload for the MoveSaturation command.
Summary
Public constructors |
|---|
Request(Creates a request payload for the MoveSaturation command. |
Public properties |
|
|---|---|
ColorControlTrait.MoveModeEnum |
The direction in which to move the saturation. |
ColorControlTrait.OptionsBitmap |
Determines which bits in the |
ColorControlTrait.OptionsBitmap |
If the corresponding bit in |
UByte |
The rate (in steps per seconds) used to change the device's |
Public constructors
Request
Request(
moveMode: ColorControlTrait.MoveModeEnum = MoveModeEnum.Stop,
rate: UByte,
optionsMask: ColorControlTrait.OptionsBitmap = OptionsBitmap(),
optionsOverride: ColorControlTrait.OptionsBitmap = OptionsBitmap()
)
Creates a request payload for the MoveSaturation command.
Public properties
moveMode
val moveMode: ColorControlTrait.MoveModeEnum
The direction in which to move the saturation. This must be one of the values in ColorControlTrait.SaturationMoveMode.
optionsMask
val optionsMask: ColorControlTrait.OptionsBitmap
Determines which bits in the options attribute should be overridden by optionsOverride.
optionsOverride
val optionsOverride: ColorControlTrait.OptionsBitmap
If the corresponding bit in optionsMask is set to 1, the bit set here overrides the corresponding bit in options attribute.