ChimeTrait.ChimeSoundStruct

class ChimeTrait.ChimeSoundStruct : ClusterStruct


A chime sound that can be played.

Summary

Nested types

Descriptor enum for this struct's fields.

Public constructors

ChimeSoundStruct(chimeId: UByte, name: String)

Creates the ChimeSoundStruct class.

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

UByte

A unique identifier for the chime sound.

String

The name of the chime sound.

Public constructors

ChimeSoundStruct

ChimeSoundStruct(chimeId: UByte, name: String = "")

Creates the ChimeSoundStruct class.

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

chimeId

val chimeIdUByte

A unique identifier for the chime sound.

name

val nameString

The name of the chime sound.