# CameraAvStreamManagementTrait.SnapshotCapabilitiesStruct

# CameraAvStreamManagementTrait.SnapshotCapabilitiesStruct


```
class CameraAvStreamManagementTrait.SnapshotCapabilitiesStruct : ClusterStruct
```

<br />

*** ** * ** ***

## Summary

| ### Nested types |
|---|
| `@https://developers.home.google.com/reference/kotlin/com/google/home/annotation/HomeExperimentalGenericApi enum https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/CameraAvStreamManagementTrait.SnapshotCapabilitiesStruct.StructFields : https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html, https://developers.home.google.com/reference/kotlin/com/google/home/Field` Descriptor enum for this struct's fields. |

| ### Public constructors |
|---|
| `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/CameraAvStreamManagementTrait.SnapshotCapabilitiesStruct#SnapshotCapabilitiesStruct(com.google.home.matter.standard.CameraAvStreamManagementTrait.VideoResolutionStruct,kotlin.UShort,com.google.home.matter.standard.CameraAvStreamManagementTrait.ImageCodecEnum,kotlin.Boolean,com.google.home.matter.serialization.OptionalValue)( resolution: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/CameraAvStreamManagementTrait.VideoResolutionStruct, maxFrameRate: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html, imageCodec: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/CameraAvStreamManagementTrait.ImageCodecEnum, requiresEncodedPixels: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html, requiresHardwareEncoder: https://developers.home.google.com/reference/kotlin/com/google/home/matter/serialization/OptionalValue<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html> )` |

| ### Public functions |
|---|---|
| `open https://developers.home.google.com/reference/kotlin/com/google/home/StructDescriptor` | `@https://developers.home.google.com/reference/kotlin/com/google/home/annotation/HomeExperimentalGenericApi https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/CameraAvStreamManagementTrait.SnapshotCapabilitiesStruct#getDescriptor()()` Returns the descriptor for the struct. |
| `open https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html?` | `@https://developers.home.google.com/reference/kotlin/com/google/home/annotation/HomeExperimentalGenericApi https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/CameraAvStreamManagementTrait.SnapshotCapabilitiesStruct#getFieldValueById(kotlin.UInt)(tagId: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-int/index.html)` Returns the value of the field for the given tag ID. |

| ### Public properties |
|---|---|
| `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/CameraAvStreamManagementTrait.ImageCodecEnum` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/CameraAvStreamManagementTrait.SnapshotCapabilitiesStruct#imageCodec()` |
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/CameraAvStreamManagementTrait.SnapshotCapabilitiesStruct#maxFrameRate()` |
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/CameraAvStreamManagementTrait.SnapshotCapabilitiesStruct#requiresEncodedPixels()` |
| `https://developers.home.google.com/reference/kotlin/com/google/home/matter/serialization/OptionalValue<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html>` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/CameraAvStreamManagementTrait.SnapshotCapabilitiesStruct#requiresHardwareEncoder()` |
| `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/CameraAvStreamManagementTrait.VideoResolutionStruct` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/CameraAvStreamManagementTrait.SnapshotCapabilitiesStruct#resolution()` |

## Public constructors

### SnapshotCapabilitiesStruct

```
SnapshotCapabilitiesStruct(
    resolution: CameraAvStreamManagementTrait.VideoResolutionStruct = VideoResolutionStruct(),
    maxFrameRate: UShort,
    imageCodec: CameraAvStreamManagementTrait.ImageCodecEnum = ImageCodecEnum.JPEG,
    requiresEncodedPixels: Boolean = false,
    requiresHardwareEncoder: OptionalValue<Boolean> = OptionalValue.absent()
)
```

## Public functions

### getDescriptor

```
@HomeExperimentalGenericApi
open fun getDescriptor(): StructDescriptor
```

Returns the descriptor for the struct.

### getFieldValueById

```
@HomeExperimentalGenericApi
open fun getFieldValueById(tagId: UInt): Any?
```

Returns the value of the field for the given tag ID.

## Public properties

### imageCodec

```
val imageCodec: CameraAvStreamManagementTrait.ImageCodecEnum
```

### maxFrameRate

```
val maxFrameRate: UShort
```

### requiresEncodedPixels

```
val requiresEncodedPixels: Boolean
```

### requiresHardwareEncoder

```
val requiresHardwareEncoder: OptionalValue<Boolean>
```

### resolution

```
val resolution: CameraAvStreamManagementTrait.VideoResolutionStruct
```