struct CameraTimelineTrait

This trait provides an interface to a camera's timeline data.
- `


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


  ` No supported events for `CameraTimelineTrait`.

  #### Declaration

  Swift

      static let supportedEventTypes: [any Event.Type]

- `


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


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

  #### Declaration

  Swift

      static let supportedCommandTypes: [any Command.Type]

- `


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


  ` The trait identifier.

  #### Declaration

  Swift

      static let identifier: String

- `


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


  ` Metadata about this `Trait`.

  #### Declaration

  Swift

      let metadata: TraitMetadata

- `


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


  ` List of attributes for the `CameraTimelineTrait`.

  #### Declaration

  Swift

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

- `


  ### [init(decoder:interactionProxy:metadata:)](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google/CameraTimelineTrait#/s:15GoogleHomeTypes0A0O19CameraTimelineTraitV7decoder16interactionProxy8metadataAE0aB3SDK0F7DecoderV_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/CameraTimelineTrait#/s:15GoogleHomeTypes0A0O19CameraTimelineTraitV6encode4withy0aB3SDK0F7EncoderC_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/CameraTimelineTrait#/s:15GoogleHomeTypes0A0O19CameraTimelineTraitV9forceReadyyYaKF)


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


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

  #### Declaration

  Swift

      struct Attributes

- `


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

  #### Parameters

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

- `


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

- `


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


  ` Defines a zone where the event occurred.

  #### Declaration

  Swift

      struct Zone

- `


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


  ` An instance of a face.

  #### Declaration

  Swift

      struct FaceInstance

- `


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


  ` A face category.

  #### Declaration

  Swift

      struct Face

- `


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


  ` A track of detected events within a camera session.

  #### Declaration

  Swift

      struct EventTrack

- `


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


  ` Caption for the event session.

  #### Declaration

  Swift

      struct Caption

- `


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


  ` URL for accessing media related to the event session.

  #### Declaration

  Swift

      struct MediaUrl

- `


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


  ` Represents a single event session recorded by the camera.

  #### Declaration

  Swift

      struct CameraHistoryItem

- `


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


  ` Information about a period of time when no video was recorded.

  #### Declaration

  Swift

      struct NoVideoPeriodData

- `


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


  ` The period of the timeline data.

  #### Declaration

  Swift

      struct TimelinePeriodStruct

- `


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


  ` The timeline period stream.

  #### Declaration

  Swift

      struct TimelinePeriodsStream

- `


  ### [supportsListTimelinePeriodsCommand](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google/CameraTimelineTrait#/s:15GoogleHomeTypes0A0O19CameraTimelineTraitV012supportsListE14PeriodsCommandSbvp)


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

  #### Declaration

  Swift

      var supportsListTimelinePeriodsCommand: Bool { get }

- `


  ### [listTimelinePeriods(startTimeMillis:endTimeMillis:modes:optionalArgsProvider:)](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google/CameraTimelineTrait#/s:15GoogleHomeTypes0A0O19CameraTimelineTraitV04listE7Periods15startTimeMillis03endjK05modes20optionalArgsProviderAE04ListeH7CommandV8ResponseVs6UInt64V_APSayAE0E4ModeOGyAL08OptionalO0CYbcSgtYaKF)


  ` Lists the timeline periods for the camera.

  #### Declaration

  Swift

      func listTimelinePeriods(startTimeMillis: UInt64, endTimeMillis: UInt64, modes: [https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google.html.CameraTimelineTrait.https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google/CameraTimelineTrait/TimelineMode.html], optionalArgsProvider: (@Sendable (https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google.html.CameraTimelineTrait.ListTimelinePeriodsCommand.OptionalArgs) -> Void)? = nil) async throws -> https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google.html.CameraTimelineTrait.ListTimelinePeriodsCommandResponse

  #### Parameters

  |---|---|
  | ` startTimeMillis ` | The start time of the timeline data in milliseconds since the Unix epoch. |
  | ` endTimeMillis ` | The end time of the timeline data in milliseconds since the Unix epoch. |
  | ` modes ` | The timeline data modes. |

  #### Return Value

  The response from the `ListTimelinePeriods` command.
- `


  ### [listTimelinePeriodsBatchable(startTimeMillis:endTimeMillis:modes:optionalArgsProvider:)](https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google/CameraTimelineTrait#/s:15GoogleHomeTypes0A0O19CameraTimelineTraitV04listE16PeriodsBatchable15startTimeMillis03endkL05modes20optionalArgsProvider0aB3SDK0I7CommandVyAE04ListehS0V8ResponseVGs6UInt64V_ATSayAE0E4ModeOGyAO08OptionalP0CcSgtKF)


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

  #### Declaration

  Swift

      func listTimelinePeriodsBatchable(startTimeMillis: UInt64, endTimeMillis: UInt64, modes: [https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google.html.CameraTimelineTrait.https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google/CameraTimelineTrait/TimelineMode.html], optionalArgsProvider: ((https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google.html.CameraTimelineTrait.ListTimelinePeriodsCommand.OptionalArgs) -> Void)? = nil) throws -> BatchableCommand<https://developers.home.google.com/reference/swift/GoogleHomeTypes/Enums/Google.html.CameraTimelineTrait.ListTimelinePeriodsCommandResponse>

- `


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


  ` The type of the period data.

  #### Declaration

  Swift

      enum PeriodType

- `


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


  ` The reason why the video is unavailable.

  #### Declaration

  Swift

      enum VideoUnavailableReason

- `


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


  ` The mode of the timeline data.

  #### Declaration

  Swift

      enum TimelineMode

- `


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


  ` The type of event that the camera recorded.

  #### Declaration

  Swift

      enum EventType

- `


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


  ` A face category.

  #### Declaration

  Swift

      enum FaceCategory

- `


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


  ` The type of caption for the event session.

  #### Declaration

  Swift

      enum CaptionType