AudioInputTrait.AudioInputEnvironment
enum AudioInputTrait.AudioInputEnvironment : Enum, ClusterEnum
The user's audio input environment of the device.
Summary
Enum Values |
|
|---|---|
AuthenticatedUserOnly |
The user's audio environment requires privacy. |
SurroundingUsers |
The user's audio environment includes surrounding users. |
UnknownValue |
The enum value is out of range. |
Unspecified |
The user's audio environment is unspecified. |
Public functions |
|
|---|---|
AudioInputTrait.AudioInputEnvironment |
Returns the enum constant of this type with the specified name. |
Array<AudioInputTrait.AudioInputEnvironment> |
values()Returns an array containing the constants of this enum type, in the order they're declared. |
Enum Values
AuthenticatedUserOnly
val AudioInputTrait.AudioInputEnvironment.AuthenticatedUserOnly: AudioInputTrait.AudioInputEnvironment
The user's audio environment requires privacy.
SurroundingUsers
val AudioInputTrait.AudioInputEnvironment.SurroundingUsers: AudioInputTrait.AudioInputEnvironment
The user's audio environment includes surrounding users.
UnknownValue
val AudioInputTrait.AudioInputEnvironment.UnknownValue: AudioInputTrait.AudioInputEnvironment
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.
Unspecified
val AudioInputTrait.AudioInputEnvironment.Unspecified: AudioInputTrait.AudioInputEnvironment
The user's audio environment is unspecified.
Public functions
valueOf
fun valueOf(value: String): AudioInputTrait.AudioInputEnvironment
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<AudioInputTrait.AudioInputEnvironment>
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.