Console

ChimeThemesTrait 

struct ChimeThemesTrait

This trait provides an interface for configuring and retrieving doorbell chime themes. It serves two purposes:

  • Seasonal/timeboxed themes: Allows applying timeboxed themes (such as Halloween or Holiday chimes) by selectedTimeboxedThemeName that temporarily override the permanent chime sound selected by the Matter standard Chime trait. Seasonal themes are active only during specific time periods.
  • Theme metadata and grouping: Provides metadata by GetAvailableThemes for both seasonal and permanent themes. For permanent themes, clients can correlate the chime asset IDs returned here with installedChimeSounds in the Matter standard Chime trait to organize individual permanent chimes by theme in the user interface.

  • No supported events for ChimeThemesTrait.

    Declaration

    Swift

    static let supportedEventTypes: [any Event.Type]

  • List of the commands that are supported by ChimeThemesTrait.

    Declaration

    Swift

    static let supportedCommandTypes: [any Command.Type]

  • The trait identifier.

    Declaration

    Swift

    static let identifier: String

  • Metadata about this Trait.

    Declaration

    Swift

    let metadata: TraitMetadata

  • List of attributes for the ChimeThemesTrait.

    Declaration

    Swift

    let attributes: Google.ChimeThemesTrait.Attributes

  • Creates a new Trait instance using data read from the given TraitDecoder.

    Throws

    HomeError.parseError when parsing fails.

    Declaration

    Swift

    init(decoder: TraitDecoder, interactionProxy: (any InteractionProxy)?, metadata: TraitMetadata) throws

    Parameters

    decoder

    The raw data representing this Trait.
    interactionProxy

    Proxy to the Interaction Client.
    metadata

    Metadata about this Trait.

  • Writes this object to the given TraitEncoder. Throws HomeError.encodingFailed if the data could not be encoded.

    Declaration

    Swift

    func encode(with encoder: TraitEncoder) throws

  • This API provides the ability to invalidate state retrieved through subscriptions to the target device in the cases where state is not being reported correctly, either intentionally (e.g attributes in Matter traits with the “C” quality) or unintentionally due to poor implementations.

    When successful, this API will result in a forced read of the convening scope as specified by the sub-class and return the result through existing Trait subscriptions if present and active.

    This API is to be used sparingly as it can impact the performance and battery life of the target device. As such, this API may be throttled by the platform. Callers SHALL be prepared to deal with HomeErrors thrown by this call.

    Declaration

    Swift

    func forceRead() async throws

  • Attributes for the ChimeThemesTrait.

    Declaration

    Swift

    struct Attributes

  • Returns a Boolean value indicating whether two values are equal.

    Equality is the inverse of inequality. For any values a and b, a == b implies that a != b is false.

    Declaration

    Swift

    static func == (lhs: Google.ChimeThemesTrait, rhs: Google.ChimeThemesTrait) -> Bool

    Parameters

    lhs

    A value to compare.
    rhs

    Another value to compare.

  • Hashes the essential components of this value by feeding them into the given hasher.

    Implement this method to conform to the Hashable protocol. The components used for hashing must be the same as the components compared in your type’s == operator implementation. Call hasher.combine(_:) with each of these components.

    Important

    In your implementation of hash(into:), don’t call finalize() on the hasher instance provided, or replace it with a different instance. Doing so may become a compile-time error in the future.

    Declaration

    Swift

    func hash(into hasher: inout Hasher)

  • Represents an individual audio chime file associated with a theme.

    Declaration

    Swift

    struct ChimeStruct

  • Represents a collection of chime sounds. A theme can be permanent (year-round collection with no start/end times) or timeboxed (seasonal collection active only between start and end times).

    Declaration

    Swift

    struct ThemeStruct

  • Whether the device supports the getAvailableThemes command for this trait.

    Declaration

    Swift

    var supportsGetAvailableThemesCommand: Bool { get }

  • Retrieves all themes currently available on the device. This includes permanent themes as well as timeboxed themes (both active and out of season).

    Declaration

    Swift

    func getAvailableThemes() async throws -> Google.ChimeThemesTrait.GetAvailableThemesCommandResponse

    Return Value

    The list of available themes.

    A theme can be timeboxed (seasonal) or permanent:

    Seasonal themes: Have startTimeSeconds and/or endTimeSeconds defined. A seasonal theme is active if the current time is within its startTimeSeconds and endTimeSeconds values in the ThemeStruct. Clients can filter for currently active seasonal themes to present a seasonal theme picker, and set selectedTimeboxedThemeName to activate a theme pack.

    Permanent themes: Have neither startTimeSeconds nor endTimeSeconds. Permanent themes cannot be selected directly as a theme pack; instead, their constituent chimes are selected individually by the selectedChime attribute of the Matter standard Chime trait. Clients can correlate the assetId of each chime in ThemeStruct.chimeSounds with the name field of ChimeSoundStruct entries in the installedChimeSounds attribute of the Matter standard Chime trait to categorize and group permanent sounds into sections or albums in the user interface.

  • The batchable version of getAvailableThemes command above.

    See also

    getAvailableThemes

    Declaration

    Swift

    func getAvailableThemesBatchable() throws -> BatchableCommand<Google.ChimeThemesTrait.GetAvailableThemesCommandResponse>