מצלמה.listFiles

רשימה של כל התמונות/כל הסרטונים/כל התמונות והסרטונים במצלמה. ייתכן שייקח מספר בקשות לרישום כל הקבצים. הפקודה הזו נוספה ברמת API 2.

אם מצלמה לא תומכת בפרמטרים המבוקשים, היא חייבת להחזיר את יכולת מקסימלית שזמינה לחומרה. לדוגמה, מקרה נדיר הבקשה: {entryCount: 500, maxSize: 2000}. במקום לזרוק הודעת שגיאה, התגובה צריכה להתבסס על היכולת המקסימלית שנתמכת על ידי המצלמה, למשל: {entryCount: 100, maxSize: 200}. יש לשלוח שגיאות לגבי כל שאר מקרים נוספים; לדוגמה, כשהבקשה היא {entryCount: 500, maxSize: -500}, היא אמורה להקפיץ את השגיאה invalidParameterValue כי maxSize הוא שלילי.

פרמטרים

  • fileType: סוג הקבצים שייכללו בדוח, והוא צריך להיות אחד או יותר שלושתם: "תמונה", "וידאו", "הכול".
  • startPosition: (אופציונלי) המיקום של הקובץ הראשון יוחזרו לרשימה. אם לא צוין, מיקום ההתחלה הוא 0, שמייצג את הקובץ הראשון. אם הוא גדול מהמיקום של הקובץ האחרון, יש להחזיר תגובה רגילה עם רשומות ריקות בתוצאות במקום תגובת שגיאה.
  • entryCount: מספר הרשומות הרצוי שיוחזרו. אם הוא יותר ממספר הקבצים שנותרו, פשוט מחזירים תשובה רגילה עם את הקבצים שנותרו בפועל במקום הודעת שגיאה.
  • maxThumbSize: הגודל המקסימלי של תמונות ממוזערות; max(thumbnail_width, JPEG_height) הערך מוגדר ל-null כשהלקוח רוצה להשמיט תמונות ממוזערות מהתוצאה.

תוצאות

  • רשומות: רשימה של מאפיינים של תמונות. כל רשומה צריכה להכיל את השדות הבאים מלבד קו רוחב וקו אורך, שהם אופציונליים:
    • שם: שם הקובץ.
    • fileUrl: כתובת ה-URL האבסולוטית של הקובץ, שניתן להשתמש בה כדי להוריד ישירות מהמצלמה.
    • size [גודל]: הגודל בבייטים של הקובץ.
    • dateTimeZone: התאריך, השעה ואזור הזמן של הקובץ, בפורמט: YYYY:MM:DD HH:MM:SS+(-)HH:MM. יש להשתמש בפורמט של 24 שעות לשעה. תאריך ו השעה מופרדת בתו ריק אחד. אזור הזמן מקוזז משעון UTC. שימו לב לדברים הבאים מייצג את סיום הצילום של סרטונים.
    • קו רוחב: (אופציונלי) קו הרוחב של המיקום בזמן צילום הקובץ.
    • lng: (אופציונלי) קו האורך של המיקום בזמן צילום הקובץ.
    • width: הרוחב של התמונה או כל פריים בסרטון.
    • height: גובה התמונה או כל פריים הווידאו.
    • תמונה ממוזערת: מחרוזת בקידוד Base64 לתמונה הממוזערת של הקובץ (כשהמשתמש maxThumbSize != null).
    • isProcessed:ערך בוליאני שמציין אם הקובץ מעובד (למשל, תפור) או שמדובר בתצוגה מקדימה בלבד. צריך להגדיר את הפרמטר הזה עד ברירת המחדל, אלא אם כן delayProcessing מוגדר כ-True. אם קיימת תמונה מעובדת, אסור שתמונת התצוגה המקדימה המתאימה תופיע גם אם היא קיימת, אחרת, הציגו את תמונת התצוגה המקדימה.
    • previewUrl: ברירת המחדל היא מחרוזת ריקה אם delayProcessing ללא תמיכה או כאשר הערך של isProcessed שווה ל-false או כאשר תצוגה מקדימה של התמונה היא false לא נוצרה אף פעם כתוצאה מתוצאת ביניים. אחרת, מדובר בכתובת ה-URL של תמונת התצוגה המקדימה שתואמת לתמונה הסופית. משמש ליצירת ההתאמה בין תמונת התצוגה המקדימה לבין התמונה הסופית.
  • totalEntries: מספר הרשומות הכולל של fileType ב- אחסון, למשל אם fileType הוא "image", זהו המספר הכולל של תמונות אחסון.

שגיאות

  • missingParameter: פרמטר נדרש לא צוין; לדוגמה, entryCount לא צוין.
  • falseParameterName: השם של פרמטר הקלט הוא לא מזוהה.
  • invalidParameterValue: השם של פרמטר הקלט מזוהה, אבל הערך שלו לא חוקי. לדוגמה, הערך entryCount הוא שלילי או שסוג הנתונים שלו שגוי.

Command I/O
קלט פקודה 
{
    "parameters": {
        "entryCount": 50,
        "maxThumbSize": 100
    }
}
פלט הפקודה 
{
    "results": {
        "entries": [
            {
                "name": "abc",
                "fileUrl": "file URL",
                "size":  file size, # of bytes,
                "dateTimeZone": "2014:12:27 08:00:00+08:00",
                "lat": 50.5324,
                "lng": -120.2332,
                "width": 2000,
                "height": 1000,
                "thumbnail": "ENCODEDSTRING",
                "isProcessed": true,
                "previewUrl": ""
            }
            ...
            {
                ...
            }
        ],
        "totalEntries": 250
    }
}
פלט הפקודה (שגיאה) 
{
    "error": {
        "code": "invalidParameterValue",
        "message": "Parameter entryCount is negative."
    }
}