Schéma CameraSound

Nest Cam (ancienne) Nest Hub Max Nest Doorbell (ancienne) 

sdm.devices.traits.CameraSound

Cette caractéristique appartient à tous les appareils compatibles avec les événements de détection de son.

Champs

Aucun champ n'est disponible pour cette caractéristique.

Commandes

Aucune commande n'est disponible pour cette caractéristique.

Événements

Son

La caméra a détecté un son.

Événement sonore

Charge utile

{
  "eventId" : "5ef79c89-8de5-4a73-97c4-3bdcd4a745ac",
  "timestamp" : "2019-01-01T00:00:01Z",
  "resourceUpdate" : {
    "name" : "enterprises/project-id/devices/device-id",
    "events" : {
      "sdm.devices.events.CameraSound.Sound" : {
        "eventSessionId" : "CjY5Y3VKaTZwR3o4Y19YbTVfMF...",
        "eventId" : "vkVcJZ-T49pKxDCbTgk58pPSA5..."
      }
    }
  }
  "userId" : "AVPHwEuBfnPOnTqzVFT4IONX2Qqhu9EJ4ubO-bNnQ-yi",
  "resourceGroup" : [
    "enterprises/project-id/devices/device-id"
  ]
}

Champs d'événement sonore

Champ Description Type de données
eventSessionId ID attribué aux événements qui se produisent au cours d'une seule session d'événements associés. Peut être utilisé pour consolider des événements. string
Exemple: "CjY5Y3VKaTZwR3o4Y19YbTVfMF..."
eventId Identifiant associé à l'événement.

Utilisez-la avec la commande GenerateImage pour télécharger l'image de l'appareil photo associée à cet événement.

 string
Exemple: "vkVcJZ-T49pKxDCbTgk58pPSA5..."

Champs de la charge utile de l'événement

Champ Description Type de données
eventId Identifiant unique de l'événement. string
Exemple: "5ef79c89-8de5-4a73-97c4-3bdcd4a745ac"
timestamp Heure à laquelle l'événement s'est produit. string
Exemple: "2019-01-01T00:00:01Z"
resourceUpdate Objet contenant des informations détaillées sur la mise à jour de la ressource. object
userId Identifiant unique et brouillé représentant l'utilisateur. string
Exemple: "AVPHwEuBfnPOnTqzVFT4IONX2Qqhu9EJ4ubO-bNnQ-yi"
resourceGroup Objet qui indique les ressources susceptibles de disposer de mises à jour similaires à celles de cet événement. La ressource de l'événement lui-même (de l'objet resourceUpdate) sera toujours présente dans cet objet. object

Pour en savoir plus sur les différents types d'événements et leur fonctionnement, consultez la section Événements.

Erreurs

Les codes d'erreur suivants peuvent être renvoyés en lien avec cette caractéristique:

Message d'erreur RPC Dépannage
L'image de la caméra n'est plus disponible au téléchargement. DEADLINE_EXCEEDED Les images des événements expirent 30 secondes après la publication de l'événement. Veillez à télécharger l'image avant son expiration.
L'ID d'événement n'appartient pas à la caméra. FAILED_PRECONDITION Utilisez la eventID correcte renvoyée par l'événement de l'appareil photo.

Consultez la documentation de référence sur les codes d'erreur de l'API pour obtenir la liste complète des codes d'erreur de l'API.