סכימת CameraClipPreview

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

sdm.devices.traits.CameraClipPreview

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

שדות

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

פקודות

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

אירועים

ClipPreview

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

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

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

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

אירוע של ClipPreview

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

{
  "eventId" : "54e55063-25e6-44a5-9aa7-704405bb1c91",
  "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 כתובת האתר שבה יש להציג את הקליפ בתצוגה מקדימה. ברירת המחדל לקודק הווידאו היא H264. string
דוגמה: "https://previewUrl/..."

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

שדה תיאור סוג הנתונים
eventId המזהה הייחודי של האירוע. string
דוגמה: "54e55063-25e6-44a5-9aa7-704405bb1c91"
timestamp השעה שבה התרחש האירוע. string
לדוגמה: "2019-01-01T00:00:01Z"
resourceUpdate אובייקט עם פרטים על עדכון המשאב. object
userId מזהה ייחודי ומעורפל שמייצג את המשתמש. string
דוגמה: AVPHwEuBfnPOnTqzVFT4IONX2Qqhu9EJ4ubO-bNnQ-yi'
resourceGroup אובייקט שמציין משאבים שעשויים לכלול עדכונים דומים לאירוע הזה. המשאב של האירוע עצמו (מהאובייקט resourceUpdate) תמיד יופיע באובייקט הזה. object

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

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

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

Preview

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

שגיאות

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