struct LightEffectsTrait

This trait belongs to devices that can support complex lighting commands to change states, such
as looping through various colors.
- `


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


  ` No supported events for `LightEffectsTrait`.

  #### Declaration

  Swift

      static let supportedEventTypes: [any Event.Type]

- `


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


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

  #### Declaration

  Swift

      static let supportedCommandTypes: [any Command.Type]

- `


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


  ` The trait identifier.

  #### Declaration

  Swift

      static let identifier: String

- `


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


  ` Metadata about this `Trait`.

  #### Declaration

  Swift

      let metadata: TraitMetadata

- `


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


  ` List of attributes for the `LightEffectsTrait`.

  #### Declaration

  Swift

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

- `


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


  ` 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/LightEffectsTrait#/s:15GoogleHomeTypes0A0O17LightEffectsTraitV6encode4withy0aB3SDK0F7EncoderC_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/LightEffectsTrait#/s:15GoogleHomeTypes0A0O17LightEffectsTraitV9forceReadyyYaKF)


  ` 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/LightEffectsTrait/Attributes.html)


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

  #### Declaration

  Swift

      struct Attributes

- `


  ### [==(_:_:)](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google/LightEffectsTrait#/s:15GoogleHomeTypes0A0O17LightEffectsTraitV2eeoiySbAE_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.LightEffectsTrait, rhs: https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google.html.LightEffectsTrait) -> Bool

  #### Parameters

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

- `


  ### [hash(into:)](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google/LightEffectsTrait#/s:15GoogleHomeTypes0A0O17LightEffectsTraitV4hash4intoys6HasherVz_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)

- `


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


  ` Represents a color using the HSV model.

  #### Declaration

  Swift

      struct SpectrumHSV

- `


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


  ` Color of the light for the duration of the effect.

  #### Declaration

  Swift

      struct Color

- `


  ### [supportsPulseEffectSetCommand](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google/LightEffectsTrait#/s:15GoogleHomeTypes0A0O17LightEffectsTraitV29supportsPulseEffectSetCommandSbvp)


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

  #### Declaration

  Swift

      var supportsPulseEffectSetCommand: Bool { get }

- `


  ### [pulseEffectSet(durationSeconds:color:)](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google/LightEffectsTrait#/s:15GoogleHomeTypes0A0O17LightEffectsTraitV14pulseEffectSet15durationSeconds5colorys6UInt32V_AE5ColorVtYaKF)


  ` Activates the pulse effect.

  #### Declaration

  Swift

      func pulseEffectSet(durationSeconds: UInt32, color: https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google.html.LightEffectsTrait.https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google/LightEffectsTrait/Color.html) async throws

  #### Parameters

  |---|---|
  | ` durationSeconds ` | Duration for the pulse effect, in seconds. |
  | ` color ` | Color of the light for the duration of the effect. |

- `


  ### [pulseEffectSetBatchable(durationSeconds:color:)](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google/LightEffectsTrait#/s:15GoogleHomeTypes0A0O17LightEffectsTraitV23pulseEffectSetBatchable15durationSeconds5color0aB3SDK0J7CommandVyytGs6UInt32V_AE5ColorVtKF)


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

  #### Declaration

  Swift

      func pulseEffectSetBatchable(durationSeconds: UInt32, color: https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google.html.LightEffectsTrait.https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google/LightEffectsTrait/Color.html) throws -> BatchableCommand<Void>

- `


  ### [supportsSleepEffectSetCommand](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google/LightEffectsTrait#/s:15GoogleHomeTypes0A0O17LightEffectsTraitV29supportsSleepEffectSetCommandSbvp)


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

  #### Declaration

  Swift

      var supportsSleepEffectSetCommand: Bool { get }

- `


  ### [sleepEffectSet(durationSeconds:)](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google/LightEffectsTrait#/s:15GoogleHomeTypes0A0O17LightEffectsTraitV14sleepEffectSet15durationSecondsys6UInt32V_tYaKF)


  ` Activates the sleep effect.

  #### Declaration

  Swift

      func sleepEffectSet(durationSeconds: UInt32) async throws

  #### Parameters

  |---|---|
  | ` durationSeconds ` | Duration for the sleep effect, in seconds. |

- `


  ### [sleepEffectSetBatchable(durationSeconds:)](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google/LightEffectsTrait#/s:15GoogleHomeTypes0A0O17LightEffectsTraitV23sleepEffectSetBatchable15durationSeconds0aB3SDK0J7CommandVyytGs6UInt32V_tKF)


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

  #### Declaration

  Swift

      func sleepEffectSetBatchable(durationSeconds: UInt32) throws -> BatchableCommand<Void>

- `


  ### [supportsSleepEffectSetDefaultCommand](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google/LightEffectsTrait#/s:15GoogleHomeTypes0A0O17LightEffectsTraitV36supportsSleepEffectSetDefaultCommandSbvp)


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

  #### Declaration

  Swift

      var supportsSleepEffectSetDefaultCommand: Bool { get }

- `


  ### [sleepEffectSetDefaultBatchable()](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google/LightEffectsTrait#/s:15GoogleHomeTypes0A0O17LightEffectsTraitV30sleepEffectSetDefaultBatchable0aB3SDK0K7CommandVyytGyKF)


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

  #### Declaration

  Swift

      func sleepEffectSetDefaultBatchable() throws -> BatchableCommand<Void>

- `


  ### [supportsWakeEffectSetCommand](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google/LightEffectsTrait#/s:15GoogleHomeTypes0A0O17LightEffectsTraitV28supportsWakeEffectSetCommandSbvp)


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

  #### Declaration

  Swift

      var supportsWakeEffectSetCommand: Bool { get }

- `


  ### [wakeEffectSet(durationSeconds:)](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google/LightEffectsTrait#/s:15GoogleHomeTypes0A0O17LightEffectsTraitV13wakeEffectSet15durationSecondsys6UInt32V_tYaKF)


  ` Activates the wake effect.

  #### Declaration

  Swift

      func wakeEffectSet(durationSeconds: UInt32) async throws

  #### Parameters

  |---|---|
  | ` durationSeconds ` | Duration for the wake effect, in seconds. |

- `


  ### [wakeEffectSetBatchable(durationSeconds:)](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google/LightEffectsTrait#/s:15GoogleHomeTypes0A0O17LightEffectsTraitV22wakeEffectSetBatchable15durationSeconds0aB3SDK0J7CommandVyytGs6UInt32V_tKF)


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

  #### Declaration

  Swift

      func wakeEffectSetBatchable(durationSeconds: UInt32) throws -> BatchableCommand<Void>

- `


  ### [supportsWakeEffectSetDefaultCommand](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google/LightEffectsTrait#/s:15GoogleHomeTypes0A0O17LightEffectsTraitV35supportsWakeEffectSetDefaultCommandSbvp)


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

  #### Declaration

  Swift

      var supportsWakeEffectSetDefaultCommand: Bool { get }

- `


  ### [wakeEffectSetDefaultBatchable()](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google/LightEffectsTrait#/s:15GoogleHomeTypes0A0O17LightEffectsTraitV29wakeEffectSetDefaultBatchable0aB3SDK0K7CommandVyytGyKF)


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

  #### Declaration

  Swift

      func wakeEffectSetDefaultBatchable() throws -> BatchableCommand<Void>

- `


  ### [supportsStopEffectCommand](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google/LightEffectsTrait#/s:15GoogleHomeTypes0A0O17LightEffectsTraitV25supportsStopEffectCommandSbvp)


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

  #### Declaration

  Swift

      var supportsStopEffectCommand: Bool { get }

- `


  ### [stopEffect()](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google/LightEffectsTrait#/s:15GoogleHomeTypes0A0O17LightEffectsTraitV10stopEffectyyYaKF)


  ` Stops the active effect.

  #### Declaration

  Swift

      func stopEffect() async throws

- `


  ### [stopEffectBatchable()](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google/LightEffectsTrait#/s:15GoogleHomeTypes0A0O17LightEffectsTraitV19stopEffectBatchable0aB3SDK0I7CommandVyytGyKF)


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

  #### Declaration

  Swift

      func stopEffectBatchable() throws -> BatchableCommand<Void>

- `


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


  ` Contains specific capabilities related to light effects.

  #### Declaration

  Swift

      struct LightEffectsFeature