ColorControlTrait.MoveSaturationCommand.Request

class ColorControlTrait.MoveSaturationCommand.Request

The request payload for the MoveSaturation command.

Summary

Public constructors
Request(
    moveMode: ColorControlTrait.SaturationMoveMode,
    rate: UByte,
    optionsMask: UByte,
    optionsOverride: UByte
)

Creates a request payload for the MoveSaturation command.

Public properties
ColorControlTrait.SaturationMoveMode

The direction in which to move the saturation.
UByte

Determines which bits in the options attribute should be overridden by optionsOverride.
UByte

If the corresponding bit in optionsMask is set to 1, the bit set here overrides the corresponding bit in options attribute.
UByte

The rate (in steps per seconds) used to change the device's currentSaturation.

Public constructors

Request

Request(
    moveMode: ColorControlTrait.SaturationMoveMode = SaturationMoveMode.Stop,
    rate: UByte,
    optionsMask: UByte,
    optionsOverride: UByte
)

Creates a request payload for the MoveSaturation command.

Public properties

moveMode

val moveMode: ColorControlTrait.SaturationMoveMode

The direction in which to move the saturation. This must be one of the values in SaturationMoveMode.

optionsMask

val optionsMask: UByte

Determines which bits in the options attribute should be overridden by optionsOverride.

optionsOverride

val optionsOverride: UByte

If the corresponding bit in optionsMask is set to 1, the bit set here overrides the corresponding bit in options attribute.

rate

val rate: UByte

The rate (in steps per seconds) used to change the device's currentSaturation.