CameraClipPreview-Schema

Nest Doorbell (mit Akku) Nest Doorbell (mit Kabel) 

sdm.devices.traits.CameraClipPreview

Dieses Attribut gehört zu allen Geräten, die das Herunterladen einer Clip-Vorschau unterstützen.

Felder

Für dieses Attribut sind keine Felder verfügbar.

Befehle

Für dieses Attribut sind keine Befehle verfügbar.

Ereignisse

ClipPreview

Ein Videoclip ist für die Vorschau verfügbar.

Eine Clip-Vorschau ist eine Videodatei mit 10 Frames im MP4-Format. Sie können die MP4-Videodatei anzeigen lassen oder sie in ein anderes Format (z. B. ein animiertes GIF) transcodieren, um eine vollständige Sequenz von 10 Frames zu präsentieren. Bei der Auswahl einer Methode für die Clip-Vorschau sollten die Clientfunktionen des Geräts berücksichtigt werden.

Dieses Ereignis wird für die folgenden Ereignisse unterstützt:

Typ Element Beschreibung
Ereignis Motion-Ereignis des CameraMotion-Traits Die Kamera hat eine Bewegung erkannt.
Ereignis Person-Ereignis des CameraPerson-Traits Eine Person wurde von der Kamera erkannt.
Ereignis Chime-Ereignis des DoorbellChime-Traits Die Türklingel wurde betätigt.
Verwenden Sie die eventSessionId, um dieses Ereignis und die zugehörige previewUrl einem oder mehreren unterstützten Ereignissen zuzuordnen.

ClipPreview-Ereignis

Nutzlast

{
  "eventId" : "9d44bf37-06da-4c11-9390-1dab1589289c",
  "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"
  ]
}

ClipPreview-Ereignisfelder

Feld Beschreibung Datentyp
eventSessionId Eine ID, die Ereignissen zugewiesen wird, die im Rahmen einer einzelnen Sitzung mit zugehörigen Ereignissen auftreten. Kann zum Konsolidieren von Ereignissen verwendet werden. string
Beispiel: „CjY5Y3VKaTZwR3o4Y19YbTVfMF...“
previewUrl Die URL, unter der der Videoclip in der Vorschau angezeigt werden kann. Der Standard-Video-Codec ist H264. string
Beispiel: „https://previewUrl/...“

Felder der Ereignisnutzlast

Feld Beschreibung Datentyp
eventId Die eindeutige Kennung für das Ereignis. string
Beispiel: „9d44bf37-06da-4c11-9390-1dab1589289c“
timestamp Die Zeit, zu der das Ereignis aufgetreten ist. string
Beispiel: „2019-01-01T00:00:01Z“
resourceUpdate Ein Objekt mit Details zur Ressourcenaktualisierung. object
userId Eine eindeutige, verschleierte Kennung, die den Nutzer darstellt. string
Beispiel: „AVPHwEuBfnPOnTqzVFT4IONX2Qqhu9EJ4ubO-bNnQ-yi“
resourceGroup Ein Objekt, das Ressourcen angibt, die möglicherweise ähnliche Aktualisierungen wie dieses Ereignis haben. Die Ressource des Ereignisses selbst (aus dem resourceUpdate-Objekt) ist immer in diesem Objekt vorhanden. object

Weitere Informationen zu den verschiedenen Arten von Ereignissen und ihrer Funktionsweise finden Sie unter Ereignisse.

Clip in der Vorschau ansehen

Um den Clip in der Vorschau anzusehen, senden Sie einen GET-Aufruf an previewUrl und verwenden Sie das OAuth-Zugriffstoken im HTTP-Autorisierungsheader:

Vorschau

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

Fehler

Eine vollständige Liste der API-Fehlercodes finden Sie in der API-Fehlercode-Referenz.