<br />

# CameraSound Schema

[Nest Cam (legacy)](https://developers.google.com/nest/device-access/api/camera.md.txt) [Nest Hub Max](https://developers.google.com/nest/device-access/api/display.md.txt) [Nest Doorbell (legacy)](https://developers.google.com/nest/device-access/api/doorbell.md.txt)

`sdm.devices.traits.CameraSound`

This trait belongs to any device that supports sound detection events.

<br />

## Fields


There are no fields available for this trait.

<br />

## Commands

There are no commands available for this trait.

## Events

<br />

### Sound

Sound has been detected by the camera.

#### Sound event

### Payload

    {
      "eventId" : "a9b5d63e-b6db-4a82-a412-70cf9113a1d8",
      "timestamp" : "2019-01-01T00:00:01Z",
      "resourceUpdate" : {
        "name" : "enterprises/project-id/devices/device-id",
        "events" : {
          "sdm.devices.events.CameraSound.Sound" : {
            "eventSessionId" : "CjY5Y3VKaTZwR3o4Y19YbTVfMF...",
            "eventId" : "6i4DjFzokaLpNYbnffrXvdaSHL..."
          }
        }
      }
      "userId" : "AVPHwEuBfnPOnTqzVFT4IONX2Qqhu9EJ4ubO-bNnQ-yi",
      "resourceGroup" : [
        "enterprises/project-id/devices/device-id"
      ]
    }

#### Sound event fields

| Field | Description | Data Type |
|---|---|---|
| `eventSessionId` | An ID given to events occurring as part of a single session of related events. May be used for consolidating events. | `string` Example: "CjY5Y3VKaTZwR3o4Y19YbTVfMF..." |
| `eventId` | An ID associated with the event. Use it with the [GenerateImage command](https://developers.google.com/nest/device-access/traits/device/camera-event-image.md.txt#generateimage) to download the camera image related to this event. | `string` Example: "6i4DjFzokaLpNYbnffrXvdaSHL..." |

#### Event payload fields

| Field | Description | Data Type |
|---|---|---|
| `eventId` | The unique identifier for the event. | `string` Example: "a9b5d63e-b6db-4a82-a412-70cf9113a1d8" |
| `timestamp` | The time when the event occurred. | `string` Example: "2019-01-01T00:00:01Z" |
| `resourceUpdate` | An object that details information about the resource update. | `object` |
| `userId` | A unique, obfuscated identifier that represents the user. | `string` Example: "AVPHwEuBfnPOnTqzVFT4IONX2Qqhu9EJ4ubO-bNnQ-yi" |
| `resourceGroup` | An object that indicates resources that might have similar updates to this event. The resource of the event itself (from the `resourceUpdate` object) will always be present in this object. | `object` |

See [Events](https://developers.google.com/nest/device-access/api/events.md.txt) for more information on the different
types of events and how they work.

<br />


## Errors

The following error code(s) may be returned in relation to this trait:

| Error Message | RPC | Troubleshooting |
|---|---|---|
| Camera image is no longer available for download. | `DEADLINE_EXCEEDED` | Event images expire 30 seconds after the event is published. Make sure to download the image prior to expiration. |
| Event id does not belong to the camera. | `FAILED_PRECONDITION` | Use the correct `eventID` returned by the camera event. |

See the [API Error Code Reference](https://developers.google.com/nest/device-access/reference/errors/api.md.txt) for
the full list of API error codes.

<br />