סכימת CameraClipPreview

‫Nest Doorbell (battery) Nest Doorbell (wired) 

sdm.devices.traits.CameraClipPreview

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

שדות

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

פקודות

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

אירועים

ClipPreview

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

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

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

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

אירוע ClipPreview

מטען ייעודי

{
  "eventId" : "1bb063ae-09d3-4fb3-b7a3-6795e5e18d47",
  "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/..."‎

שדות המטען הייעודי של האירוע

שדה תיאור סוג הנתונים
eventId המזהה הייחודי של האירוע. ‫string
דוגמה: "1bb063ae-09d3-4fb3-b7a3-6795e5e18d47"
timestamp השעה שבה האירוע התרחש. ‫string
דוגמה: ‎"2019-01-01T00:00:01Z"‎
resourceUpdate אובייקט שמכיל פרטים על עדכון המשאב. object
userId מזהה ייחודי ומעורפל שמייצג את המשתמש. ‫string
דוגמה: ‎AVPHwEuBfnPOnTqzVFT4IONX2Qqhu9EJ4ubO-bNnQ-yi‎
resourceGroup אובייקט שמציין משאבים שעשויים להיות להם עדכונים דומים לאירוע הזה. המשאב של האירוע עצמו (מהאובייקט resourceUpdate) תמיד יהיה נוכח באובייקט הזה. object

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

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

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

תצוגה מקדימה

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

שגיאות

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