Chime

@Generated(value = ["GoogleHomePlatformCodegen"])
interface Chime : ChimeTrait.Attributes, MatterTrait, Updatable, ChimeCommands

API for the Chime trait. This trait provides an interface for controlling the chime on a device, and is a custom version of the Chime standard Matter cluster.

Summary

Nested types

Descriptor enum for this trait's attributes.

Descriptor enum for this trait's commands.

Public functions
Boolean
Boolean

Public properties
open TraitFactory<Chime>

Inherited functions
From com.google.home.matter.standard.ChimeCommands
suspend Unit

Play the currently selected chime.
BatchableCommand<Unit>

The batchable version of playChimeSound command.
From com.google.home.matter.standard.ChimeTrait.Attributes
open StructDescriptor

Returns the descriptor for the struct.
open Any?

Returns the value of the field for the given tag ID.
From com.google.home.TraitStateInvalidation
suspend Unit
From com.google.home.Updatable
suspend Chime
update(optimisticReturn: (Chime) -> Unit, init: ChimeTrait.MutableAttributes.() -> Unit)

Creates a mutable copy of an object and calls the given function to mutate it, then saves it and returns a new immutable copy with the updated state.

Inherited properties
From com.google.home.matter.standard.ChimeTrait.Attributes
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.
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.
From com.google.home.Trait
Trait.TraitMetadata

Public functions

supports

fun supports(attribute: Chime.Attribute): Boolean

supports

fun supports(command: Chime.Command): Boolean

Public properties

factory

open val factory: TraitFactory<Chime>