Schéma de CameraClipPreview

Nest Doorbell (batterie) Nest Doorbell (filaire) 

sdm.devices.traits.CameraClipPreview

Cette caractéristique appartient à tous les appareils qui permettent de télécharger un extrait d'extrait.

Champs

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

Commandes

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

Événements

ClipPreview

Un extrait vidéo est disponible pour un aperçu.

Un aperçu d'extrait est un fichier vidéo de 10 images au format MP4. Vous pouvez choisir d'afficher le fichier vidéo MP4 ou de le convertir dans un autre format (un GIF animé, par exemple) afin d'afficher une séquence complète de 10 images. Les fonctionnalités du client de l'appareil doivent être prises en compte lorsque vous sélectionnez une méthode d'aperçu d'extrait.

Cet événement est compatible avec les événements suivants:

Type Element Description
Événement Événement Motion de la caractéristique CameraMotion La caméra a détecté un mouvement.
Événement Événement Person de la caractéristique CameraPerson Une personne a été détectée par la caméra.
Événement Événement carillon correspondant au trait de la sonnette Doorbell Une pression sur la sonnette a été déclenchée.
Utilisez eventSessionId pour associer cet événement et l'élément previewUrl associé à un ou plusieurs événements compatibles.

Événement ClipPreview

Charge utile

{
  "eventId" : "1049fe69-8e1d-4381-ad42-c7f32a90d1af",
  "timestamp" : "2019-01-01T00:00:01Z",
  "resourceUpdate" : {
    "name" : "enterprises/project-id/devices/device-id",
    "events" : {
      "sdm.devices.events.CameraClipPreview.ClipPreview" : {
        "eventSessionId" : "CjY5Y3VKaTZwR3o4Y19YbTVfMF...",
        "previewUrl" : "https://previewUrl/..."
      }
    }
  }
  "userId" : "AVPHwEuBfnPOnTqzVFT4IONX2Qqhu9EJ4ubO-bNnQ-yi",
  "resourceGroup" : [
    "enterprises/project-id/devices/device-id"
  ]
}

Champs d'événement ClipPreview

Champ Description Type de données
eventSessionId Identifiant attribué aux événements qui se produisent au cours d'une session unique de événements associés. Peut être utilisé pour regrouper des événements. string
Exemple : "CjY5Y3VKaTZwR3o4Y19YbTVfMF..."
previewUrl URL de l'aperçu de l'extrait vidéo. Le codec vidéo par défaut est H264 string
Exemple : "https://previewUrl/..."

Champs de charge utile de l'événement

Champ Description Type de données
eventId Identifiant unique de l'événement. string
Exemple : "1049fe69-8e1d-4381-ad42-c7f32a90d1af"
timestamp L'heure à laquelle l'événement s'est produit. string
Exemple : "2019-01-01T00:00:01Z"
resourceUpdate Objet qui détaille des informations sur la mise à jour de la ressource. object
userId Identifiant unique et obscurci qui représente l'utilisateur. string
Exemple : "AVPHwEuBfnPOnTqzVFT4IONX2Qqhu9EJ4ubO-bNnQ-yi"
resourceGroup Objet qui indique les ressources susceptibles d'avoir des mises à jour semblables à cet événement. La ressource de l'événement lui-même (à partir de l'objet resourceUpdate) sera toujours présente dans cet objet. object

Consultez l'article Événements pour en savoir plus sur les différents types d'événements et comment ils fonctionnent.

Prévisualiser l'extrait

Pour prévisualiser l'extrait, effectuez un appel GET auprès de previewUrl à l'aide du jeton d'accès OAuth dans l'en-tête HTTP Authorization:

Aperçu

curl -H 'Authorization: Bearer access-token' \
  https://previewUrl/...

Erreurs

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