# VolumeTrait

    struct VolumeTrait

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


  ### [supportedEventTypes](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google/VolumeTrait#/s:15GoogleHomeTypes0A0O11VolumeTraitV014supportedEventC0Say0aB3SDK0G0_pXpGvpZ)


  ` No supported events for `VolumeTrait`.

  #### Declaration

  Swift

      static let supportedEventTypes: [any Event.Type]

- `


  ### [supportedCommandTypes](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google/VolumeTrait#/s:15GoogleHomeTypes0A0O11VolumeTraitV016supportedCommandC0Say0aB3SDK0G0_pXpGvpZ)


  ` List of the commands that are supported by `VolumeTrait`.

  #### Declaration

  Swift

      static let supportedCommandTypes: [any Command.Type]

- `


  ### [identifier](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google/VolumeTrait#/s:15GoogleHomeTypes0A0O11VolumeTraitV10identifierSSvpZ)


  ` The trait identifier.

  #### Declaration

  Swift

      static let identifier: String

- `


  ### [metadata](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google/VolumeTrait#/s:15GoogleHomeTypes0A0O11VolumeTraitV8metadata0aB3SDK0E8MetadataVvp)


  ` Metadata about this `Trait`.

  #### Declaration

  Swift

      let metadata: TraitMetadata

- `


  ### [attributes](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google/VolumeTrait#/s:15GoogleHomeTypes0A0O11VolumeTraitV10attributesAE10AttributesVvp)


  ` List of attributes for the `VolumeTrait`.

  #### Declaration

  Swift

      let attributes: https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google.html.VolumeTrait.https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google/VolumeTrait/Attributes.html

- `


  ### [init(decoder:interactionProxy:metadata:)](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google/VolumeTrait#/s:15GoogleHomeTypes0A0O11VolumeTraitV7decoder16interactionProxy8metadataAE0aB3SDK0E7DecoderV_AI011InteractionH0_pSgAI0E8MetadataVtKcfc)


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

- `


  ### [encode(with:)](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google/VolumeTrait#/s:15GoogleHomeTypes0A0O11VolumeTraitV6encode4withy0aB3SDK0E7EncoderC_tKF)


  ` 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

- `


  ### [forceRead()](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google/VolumeTrait#/s:15GoogleHomeTypes0A0O11VolumeTraitV9forceReadyyYaKF)


  ` 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 `HomeError`s thrown by this call.

  #### Declaration

  Swift

      func forceRead() async throws

- `


  ### [Attributes](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google/VolumeTrait/Attributes.html)


  ` Attributes for the `https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google/VolumeTrait.html`.

  #### Declaration

  Swift

      struct Attributes

- `


  ### [==(_:_:)](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google/VolumeTrait#/s:15GoogleHomeTypes0A0O11VolumeTraitV2eeoiySbAE_AEtFZ)


  ` 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: https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google.html.VolumeTrait, rhs: https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google.html.VolumeTrait) -> Bool

  #### Parameters

  |---|---|
  | ` lhs ` | A value to compare. |
  | ` rhs ` | Another value to compare. |

- `


  ### [hash(into:)](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google/VolumeTrait#/s:15GoogleHomeTypes0A0O11VolumeTraitV4hash4intoys6HasherVz_tF)


  ` 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)

- `


  ### [supportsMoveToVolumeCommand](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google/VolumeTrait#/s:15GoogleHomeTypes0A0O11VolumeTraitV014supportsMoveToD7CommandSbvp)


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

  #### Declaration

  Swift

      var supportsMoveToVolumeCommand: Bool { get }

- `


  ### [moveToVolume(volumePercent:)](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google/VolumeTrait#/s:15GoogleHomeTypes0A0O11VolumeTraitV06moveToD013volumePercentys5UInt8V_tYaKF)


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

- `


  ### [moveToVolumeBatchable(volumePercent:)](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google/VolumeTrait#/s:15GoogleHomeTypes0A0O11VolumeTraitV06moveToD9Batchable13volumePercent0aB3SDK0H7CommandVyytGs5UInt8V_tKF)


  ` The batchable version of moveToVolume command above.
  See also
  moveToVolume

  #### Declaration

  Swift

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

- `


  ### [supportsVolumeStepCommand](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google/VolumeTrait#/s:15GoogleHomeTypes0A0O11VolumeTraitV08supportsD11StepCommandSbvp)


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

  #### Declaration

  Swift

      var supportsVolumeStepCommand: Bool { get }

- `


  ### [volumeStep(stepMode:step:)](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google/VolumeTrait#/s:15GoogleHomeTypes0A0O11VolumeTraitV10volumeStep8stepMode0H0yAE0dgI4EnumO_s5UInt8VtYaKF)


  ` 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: https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google.html.VolumeTrait.https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google/VolumeTrait/VolumeStepModeEnum.html, 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. |

- `


  ### [volumeStepBatchable(stepMode:step:)](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google/VolumeTrait#/s:15GoogleHomeTypes0A0O11VolumeTraitV19volumeStepBatchable8stepMode0I00aB3SDK0H7CommandVyytGAE0dgJ4EnumO_s5UInt8VtKF)


  ` The batchable version of volumeStep command above.
  See also
  volumeStep

  #### Declaration

  Swift

      func volumeStepBatchable(stepMode: https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google.html.VolumeTrait.https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google/VolumeTrait/VolumeStepModeEnum.html, step: UInt8) throws -> BatchableCommand<Void>

- `


  ### [supportsMuteCommand](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google/VolumeTrait#/s:15GoogleHomeTypes0A0O11VolumeTraitV19supportsMuteCommandSbvp)


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

  #### Declaration

  Swift

      var supportsMuteCommand: Bool { get }

- `


  ### [mute()](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google/VolumeTrait#/s:15GoogleHomeTypes0A0O11VolumeTraitV4muteyyYaKF)


  ` Mutes the device.

  #### Declaration

  Swift

      func mute() async throws

- `


  ### [muteBatchable()](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google/VolumeTrait#/s:15GoogleHomeTypes0A0O11VolumeTraitV13muteBatchable0aB3SDK0G7CommandVyytGyKF)


  ` The batchable version of mute command above.
  See also
  mute

  #### Declaration

  Swift

      func muteBatchable() throws -> BatchableCommand<Void>

- `


  ### [supportsUnmuteCommand](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google/VolumeTrait#/s:15GoogleHomeTypes0A0O11VolumeTraitV21supportsUnmuteCommandSbvp)


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

  #### Declaration

  Swift

      var supportsUnmuteCommand: Bool { get }

- `


  ### [unmute()](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google/VolumeTrait#/s:15GoogleHomeTypes0A0O11VolumeTraitV6unmuteyyYaKF)


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

  #### Declaration

  Swift

      func unmute() async throws

- `


  ### [unmuteBatchable()](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google/VolumeTrait#/s:15GoogleHomeTypes0A0O11VolumeTraitV15unmuteBatchable0aB3SDK0G7CommandVyytGyKF)


  ` The batchable version of unmute command above.
  See also
  unmute

  #### Declaration

  Swift

      func unmuteBatchable() throws -> BatchableCommand<Void>

- `


  ### [VolumeStepModeEnum](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google/VolumeTrait/VolumeStepModeEnum.html)


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

  #### Declaration

  Swift

      enum VolumeStepModeEnum