הסכימה CameraClipPreview

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

sdm.devices.traits.CameraClipPreview

המאפיין הזה שייך לכל מכשיר שתומך בהורדה של קטע מקדים של קליפים.

שדות

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

פקודות

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

אירועים

ClipPreview

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

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

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

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

האירוע ClipPreview

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

{
  "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"
  ]
}

שדות האירוע ClipPreview

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

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

Field תיאור סוג הנתונים
eventId המזהה הייחודי של האירוע. string
דוגמה: "cac055e6-c8df-471f-94ff-6cbfd6c7e969"
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 מופיעה רשימה מלאה של קודי השגיאה ב-API.