VolumeTrait.VolumeStepCommand.Request
class VolumeTrait.VolumeStepCommand.Request : ClusterStruct
The request payload for the VolumeStep command.
Summary
Nested types |
|---|
|
Descriptor enum for this command's request fields. |
Public constructors |
|---|
Request(stepMode: VolumeTrait.VolumeStepModeEnum, step: UByte)Creates a request payload for the VolumeStep command. |
Public functions |
|
|---|---|
open StructDescriptor |
Returns the descriptor for the struct. |
open Any? |
@HomeExperimentalApiReturns the value of the field for the given tag ID. |
Public properties |
|
|---|---|
UByte |
Indicates the increment by which to increase or decrease the volume. |
VolumeTrait.VolumeStepModeEnum |
Indicates whether to increase or decrease the volume. |
Public constructors
Request
Request(
stepMode: VolumeTrait.VolumeStepModeEnum = VolumeStepModeEnum.Increase,
step: UByte
)
Creates a request payload for the VolumeStep command.
Public functions
getDescriptor
@HomeExperimentalApi
open fun getDescriptor(): StructDescriptor
Returns the descriptor for the struct.
getFieldValueById
@HomeExperimentalApi
open fun getFieldValueById(tagId: UInt): Any?
Returns the value of the field for the given tag ID.
Public properties
step
val step: UByte
Indicates the increment by which to increase or decrease the volume. Valid values are between 0 and 100.
stepMode
val stepMode: VolumeTrait.VolumeStepModeEnum
Indicates whether to increase or decrease the volume.