# Chime


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

<br />

*** ** * ** ***

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 |
|---|
| `enum https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/Chime.Attribute : https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html, https://developers.home.google.com/reference/kotlin/com/google/home/Field` Descriptor enum for this trait's attributes. |
| `class https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/Chime.ChimeStartedPlayingEvent : https://developers.home.google.com/reference/kotlin/com/google/home/Event, https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ChimeTrait.ChimeStartedPlaying` |
| `enum https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/Chime.ChimeStartedPlayingEvent.EventFields : https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html, https://developers.home.google.com/reference/kotlin/com/google/home/Field` Descriptor enum for this event's fields. |
| `enum https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/Chime.Command : https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html` Descriptor enum for this trait's commands. |

| ### Public functions |
|---|---|
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/Chime#supports(com.google.home.matter.standard.Chime.Attribute)(attribute: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/Chime.Attribute)` |
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/Chime#supports(com.google.home.matter.standard.Chime.Command)(command: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/Chime.Command)` |

| ### Public properties |
|---|---|
| `open https://developers.home.google.com/reference/kotlin/com/google/home/TraitFactory<https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/Chime>` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/Chime#factory()` |

### Inherited functions

From [com.google.home.matter.standard.ChimeCommands](https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ChimeCommands) `suspend https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html` `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ChimeCommands#playChimeSound(kotlin.Function1)(optionalArgs: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ChimeTrait.PlayChimeSoundCommand.OptionalArgs.() -> https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`

Play the currently selected chime.
`https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html>` `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ChimeCommands#playChimeSoundBatchable(kotlin.Function1)(optionalArgs: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ChimeTrait.PlayChimeSoundCommand.OptionalArgs.() -> https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`

The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ChimeCommands#playChimeSound(kotlin.Function1)` command.
From [com.google.home.matter.standard.ChimeTrait.Attributes](https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ChimeTrait.Attributes) `open https://developers.home.google.com/reference/kotlin/com/google/home/StructDescriptor` `@https://developers.home.google.com/reference/kotlin/com/google/home/annotation/HomeExperimentalGenericApi
https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ChimeTrait.Attributes#getDescriptor()()`

Returns the descriptor for the struct.
`open https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html?` `@https://developers.home.google.com/reference/kotlin/com/google/home/annotation/HomeExperimentalGenericApi
https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ChimeTrait.Attributes#getFieldValueById(kotlin.UInt)(tagId: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-int/index.html)`

Returns the value of the field for the given tag ID.
From [com.google.home.TraitStateInvalidation](https://developers.home.google.com/reference/kotlin/com/google/home/TraitStateInvalidation) `suspend https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html` `https://developers.home.google.com/reference/kotlin/com/google/home/TraitStateInvalidation#forceRead()()` From [com.google.home.Updatable](https://developers.home.google.com/reference/kotlin/com/google/home/Updatable) `suspend https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/Chime` `https://developers.home.google.com/reference/kotlin/com/google/home/Updatable#update(kotlin.Function1,kotlin.Function1)(optimisticReturn: (https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/Chime) -> https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html, init: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ChimeTrait.MutableAttributes.() -> https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`

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](https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ChimeTrait.Attributes) `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-int/index.html>` `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ChimeTrait.Attributes#acceptedCommandList()`

A list of client-generated commands which are supported by this cluster server instance.
`https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-int/index.html>` `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ChimeTrait.Attributes#attributeList()`

A list of the attribute IDs of the attributes supported by the cluster instance.
`https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html` `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ChimeTrait.Attributes#clusterRevision()`

The revision of the server cluster specification supported by the cluster instance.
`https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html?` `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ChimeTrait.Attributes#enabled()`

Whether chime sounds can currently be played.
`https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ChimeTrait.Feature` `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ChimeTrait.Attributes#featureMap()`

Whether the server supports zero or more optional cluster features.
`https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-int/index.html>` `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ChimeTrait.Attributes#generatedCommandList()`

A list of server-generated commands (server to client) which are supported by this cluster server instance.
`https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html<https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ChimeTrait.ChimeSoundStruct>?` `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ChimeTrait.Attributes#installedChimeSounds()`

All installed chime sounds, represented by a list of chime sounds.
`https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html?` `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ChimeTrait.Attributes#selectedChime()`

The currently selected chime sound that will be played.
From [com.google.home.Trait](https://developers.home.google.com/reference/kotlin/com/google/home/Trait) `https://developers.home.google.com/reference/kotlin/com/google/home/Trait.TraitMetadata` `https://developers.home.google.com/reference/kotlin/com/google/home/Trait#metadata()`

## Public functions

### supports

```
fun supports(attribute: Chime.Attribute): Boolean
```

### supports

```
fun supports(command: Chime.Command): Boolean
```

## Public properties

### factory

```
open val factory: TraitFactory<Chime>
```