Schéma CameraClipPreview

Nest Doorbell (batterie) Nest Doorbell (filaire) 

sdm.devices.traits.CameraClipPreview

Cette caractéristique appartient à tout appareil compatible avec le téléchargement d'un aperçu d'extrait.

Champs

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

Commandes

Aucune commande n'est disponible pour ce trait.

Événements

ClipPreview

Un extrait vidéo est disponible en aperçu.

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

Cet événement est accepté pour les événements suivants :

Type Élément Description
Événement Événement Motion du trait CameraMotion Un mouvement a été détecté par la caméra.
Événement Événement Person du trait CameraPerson Une personne a été détectée par la caméra.
Événement Événement Chime du trait DoorbellChime Quelqu'un a appuyé sur la sonnette.
Utilisez l'eventSessionId pour associer cet événement et la previewUrl associée à un ou plusieurs événements compatibles.

Événement ClipPreview

Charge utile

{
  "eventId" : "07b6c1ae-a358-4ba9-a7d0-e43065daaed3",
"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 de l'événement ClipPreview

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

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

Champ Description Type de données
eventId Identifiant unique de l'événement. string
Exemple : "07b6c1ae-a358-4ba9-a7d0-e43065daaed3"
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 modification de la ressource. object
userId Identifiant unique et obscurci représentant l'utilisateur. string
Exemple : "AVPHwEuBfnPOnTqzVFT4IONX2Qqhu9EJ4ubO-bNnQ-yi"
resourceGroup Objet qui indique les ressources susceptibles d'avoir des modifications de cet événement similaires. La ressource de l'événement lui-même (à partir 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 Événements.

Prévisualiser l'extrait

Pour prévisualiser l'extrait, effectuez un appel GET à previewUrl en utilisant le jeton d'accès OAuth dans l'en-tête d'autorisation HTTP :

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 obtenir la liste complète des codes d'erreur de l'API.