סכימת CameraClipPreview

Nest Doorbell (סוללה) Nest Doorbell (עם חיבור קווי) 

sdm.devices.traits.CameraClipPreview

התכונה הזו שייכת לכל מכשיר שתומך בהורדה של תצוגה מקדימה של קליפ.

שדות

אין שדות זמינים לתכונה הזו.

פקודות

אין פקודות זמינות לתכונה הזו.

אירועים

ClipPreview

קליפ זמין לתצוגה מקדימה.

תצוגה מקדימה של קליפ היא קובץ וידאו עם 10 פריימים בפורמט mp4. תוכלו להציג את קובץ הווידאו בפורמט mp4 או להמיר את הקידוד שלו לפורמט אחר (לדוגמה, קובץ GIF מונפש) כדי להציג רצף שלם של 10 פריימים. כשבוחרים שיטה לתצוגה מקדימה של קליפ, צריך להביא בחשבון את יכולות הלקוח של המכשיר.

האירוע הזה נתמך באירועים הבאים:

סוג רכיב תיאור
אירוע אירוע Motion של תכונת CameraMotion המצלמה זיהתה תנועה.
אירוע אירוע אדם בתכונת CameraMovie המצלמה זיהתה אדם.
אירוע אירוע Chime של התכונה DoorbellChime פעמון הדלת נלחץ.
צריך להשתמש ב-eventSessionId כדי לשייך את האירוע הזה ואת האירוע previewUrl שקשור אליו לאירוע נתמך אחד או יותר.

אירוע ClipPreview

מטען ייעודי (payload)

{
  "eventId" : "77cc2de2-5bfb-445c-9116-a1e09b351777",
  "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

שדה תיאור סוג הנתונים
eventSessionId מזהה שניתן לאירועים שמתרחשים כחלק מסשן יחיד של אירועים קשורים. אפשר להשתמש בה לאיחוד אירועים. string
דוגמה: "CjY5Y3VKaTZwR3o4Y19YbTVfMF..."
previewUrl כתובת ה-URL שבה יש לראות תצוגה מקדימה של הקליפ. קודק הווידאו שמוגדר כברירת מחדל הוא H264. string
דוגמה: "https://previewUrl/..."

שדות מטען ייעודי (payload) של אירועים

שדה תיאור סוג הנתונים
eventId המזהה הייחודי של האירוע. string
דוגמה: "77cc2de2-5bfb-445c-9116-a1e09b351777"
timestamp השעה שבה התרחש האירוע. string
לדוגמה: '2019-01-01T00:00:01Z'
resourceUpdate אובייקט שמכיל מידע על עדכון המשאב. object
userId מזהה ייחודי ומעורפל שמייצג את המשתמש. string
דוגמה: "AVPHwEuBfnPOnTqzVFT4IONX2Qqhu9EJ4ubO-bNnQ-yi"
resourceGroup אובייקט שמציין משאבים שייתכן שיש להם עדכונים דומים לאירוע הזה. המשאב של האירוע עצמו (מהאובייקט resourceUpdate) תמיד יופיע באובייקט הזה. object

מידע נוסף על סוגי האירועים השונים ועל אופן הפעולה שלהם מופיע במאמר אירועים.

תצוגה מקדימה של הקליפ

כדי לראות תצוגה מקדימה של הקליפ, צריך לבצע קריאת GET אל previewUrl באמצעות אסימון הגישה ל-OAuth שמופיע בכותרת 'HTTP Authorization':

Preview

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

שגיאות

הרשימה המלאה של קודי השגיאה של ה-API מופיעה בחומר העזר בנושא קוד שגיאה של API.