VolumeTrait.VolumeStepModeEnum

enum VolumeTrait.VolumeStepModeEnum : Enum, ClusterEnum


Step values that indicate whether to increase or decrease the volume.

Summary

Enum Values

Decrease

Decrease the device's volume.

Increase

Increase the device's volume.

UnknownValue

The enum value is out of range.

Public functions

VolumeTrait.VolumeStepModeEnum
valueOf(value: String)

Returns the enum constant of this type with the specified name.

Array<VolumeTrait.VolumeStepModeEnum>

Returns an array containing the constants of this enum type, in the order they're declared.

Public properties

open String
open String
open ULong

Enum Values

Decrease

val VolumeTrait.VolumeStepModeEnum.DecreaseVolumeTrait.VolumeStepModeEnum

Decrease the device's volume.

Increase

val VolumeTrait.VolumeStepModeEnum.IncreaseVolumeTrait.VolumeStepModeEnum

Increase the device's volume.

UnknownValue

val VolumeTrait.VolumeStepModeEnum.UnknownValueVolumeTrait.VolumeStepModeEnum

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.

Public functions

valueOf

fun valueOf(value: String): VolumeTrait.VolumeStepModeEnum

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<VolumeTrait.VolumeStepModeEnum>

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.

Public properties

traitId

open val traitIdString

typeName

open val typeNameString

value

open val valueULong