Console

VolumeTrait 

struct VolumeTrait

This trait provides a volume extension to the LevelControl trait and is only for use with the Automation API.

  • No supported events for VolumeTrait.

    Declaration

    Swift

    static let supportedEventTypes: [any Event.Type]

  • List of the commands that are supported by VolumeTrait.

    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 VolumeTrait.

    Declaration

    Swift

    let attributes: Google.VolumeTrait.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 VolumeTrait.

    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.VolumeTrait, rhs: Google.VolumeTrait) -> 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)

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

    Declaration

    Swift

    var supportsMoveToVolumeCommand: Bool { get }

  • Move the volume of the device to the specified volume.

    Declaration

    Swift

    func moveToVolume(volumePercent: UInt8) async throws

    Parameters

    volumePercent

    The desired volume percentage setting in the range of 0 to 100.

  • The batchable version of moveToVolume command above.

    See also

    moveToVolume

    Declaration

    Swift

    func moveToVolumeBatchable(volumePercent: UInt8) throws -> BatchableCommand<Void>

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

    Declaration

    Swift

    var supportsVolumeStepCommand: Bool { get }

  • Incremental step volume. If volume + step is greater than 100, the volume is set to 100. If volume + step is less than 0, the volume is set to 0.

    Declaration

    Swift

    func volumeStep(stepMode: Google.VolumeTrait.VolumeStepModeEnum, step: UInt8) async throws

    Parameters

    stepMode

    Indicates whether to increase or decrease the volume.
    step

    Indicates the increment by which to increase or decrease the volume. Valid values are between 0 and 100.

  • The batchable version of volumeStep command above.

    See also

    volumeStep

    Declaration

    Swift

    func volumeStepBatchable(stepMode: Google.VolumeTrait.VolumeStepModeEnum, step: UInt8) throws -> BatchableCommand<Void>

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

    Declaration

    Swift

    var supportsMuteCommand: Bool { get }

  • Mutes the device.

    Declaration

    Swift

    func mute() async throws

  • The batchable version of mute command above.

    See also

    mute

    Declaration

    Swift

    func muteBatchable() throws -> BatchableCommand<Void>

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

    Declaration

    Swift

    var supportsUnmuteCommand: Bool { get }

  • Unmutes the device and sets the volume to the last non-zero volume.

    Declaration

    Swift

    func unmute() async throws

  • The batchable version of unmute command above.

    See also

    unmute

    Declaration

    Swift

    func unmuteBatchable() throws -> BatchableCommand<Void>

  • Step values that indicate whether to increase or decrease the volume.

    Declaration

    Swift

    enum VolumeStepModeEnum