ChimeTrait.Attributes
@Generated(value = ["GoogleHomePlatformCodegen"])
interface ChimeTrait.Attributes : ClusterStruct
Chime |
API for the Chime trait. |
Attributes for the Chime cluster.
Summary
Public functions |
|
|---|---|
open StructDescriptor |
Returns the descriptor for the struct. |
open Any? |
Returns the value of the field for the given tag ID. |
Public properties |
|
|---|---|
List<UInt> |
A list of client-generated commands which are supported by this cluster server instance. |
List<UInt> |
A list of the attribute IDs of the attributes supported by the cluster instance. |
UShort |
The revision of the server cluster specification supported by the cluster instance. |
Boolean? |
Whether chime sounds can currently be played. |
ChimeTrait.ExternalChimeType? |
Indicates which type of external chime is installed. |
UShort? |
The duration of the external chime in seconds, if supported. |
UInt |
Whether the server supports zero or more optional cluster features. |
List<UInt> |
A list of server-generated commands (server to client) which are supported by this cluster server instance. |
List<ChimeTrait.ChimeSoundStruct>? |
All installed chime sounds, represented by a list of chime sounds. |
UByte? |
The currently selected chime sound that will be played. |
Public functions
getDescriptor
@HomeExperimentalGenericApi
open fun getDescriptor(): StructDescriptor
Returns the descriptor for the struct.
getFieldValueById
@HomeExperimentalGenericApi
open fun getFieldValueById(tagId: UInt): Any?
Returns the value of the field for the given tag ID.
Public properties
acceptedCommandList
val acceptedCommandList: List<UInt>
A list of client-generated commands which are supported by this cluster server instance.
attributeList
val attributeList: List<UInt>
A list of the attribute IDs of the attributes supported by the cluster instance.
clusterRevision
val clusterRevision: UShort
The revision of the server cluster specification supported by the cluster instance.
externalChime
val externalChime: ChimeTrait.ExternalChimeType?
Indicates which type of external chime is installed.
Access type: Write
externalChimeDurationSeconds
val externalChimeDurationSeconds: UShort?
The duration of the external chime in seconds, if supported.
Access type: Write
featureMap
val featureMap: UInt
Whether the server supports zero or more optional cluster features. A cluster feature is a set of cluster elements that are mandatory or optional for a defined feature of the cluster. If a cluster feature is supported by the cluster instance, then the corresponding bit is set to 1, otherwise the bit is set to 0 (zero).
generatedCommandList
val generatedCommandList: List<UInt>
A list of server-generated commands (server to client) which are supported by this cluster server instance.
installedChimeSounds
val installedChimeSounds: List<ChimeTrait.ChimeSoundStruct>?
All installed chime sounds, represented by a list of chime sounds. Each entry in this list has a unique ChimeID value and a unique Name value.
Access type: Read
selectedChime
val selectedChime: UByte?
The currently selected chime sound that will be played.
Access type: Write