Schéma CameraClipPreview
Nest Doorbell (batterie)
sdm.devices.traits.CameraClipPreview
Cette caractéristique appartient à tous les appareils compatibles avec le téléchargement d'un 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 en 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 transcoder vers un autre format (par exemple, un GIF animé) afin d'afficher une séquence complète de 10 cadres. Vous devez tenir compte des fonctionnalités du client de l'appareil lorsque vous choisissez une méthode d'aperçu du clip.
Cet événement est compatible avec les événements suivants:
Type | Élément | Description |
---|---|---|
Événement | Événement Mouvement de la caractéristique CameraMotion | Un mouvement a été détecté par la caméra. |
É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 de la caractéristique DoorbellChime | La sonnette a été déclenchée. |
eventSessionId
pour associer cet événement et le previewUrl
associé à un ou plusieurs événements compatibles.
Événement ClipPreview
Charge utile
{ "eventId" : "cac055e6-c8df-471f-94ff-6cbfd6c7e969",
"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 |
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..." |
previewUrl |
URL à laquelle prévisualiser l'extrait vidéo. Le codec vidéo par défaut est H.264. | 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: "cac055e6-c8df-471f-94ff-6cbfd6c7e969" |
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.
Prévisualiser l'extrait
Pour prévisualiser l'extrait, effectuez un appel GET à previewUrl
à l'aide du 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.