camera.listImages

تمام تصاویر موجود در دوربین را فهرست می کند. این دستور در سطح 2 API منسوخ شد. لطفاً به جای آن از camera.listFiles استفاده کنید.

اگر دوربینی از پارامترهای درخواستی پشتیبانی نمی کند، دوربین باید حداکثر قابلیت موجود برای سخت افزار را برگرداند. برای مثال، یک مورد نادر ممکن است این درخواست باشد: {entryCount: 500, maxSize: 2000} . به جای ارسال خطا، پاسخ باید بر اساس حداکثر قابلیت پشتیبانی شده توسط دوربین باشد، مانند: {entryCount: 100, maxSize: 200} . لطفا برای همه موارد دیگر خطاها را مطرح کنید. برای مثال، وقتی درخواست {entryCount: 500, maxSize: -500} باشد، باید خطای invalidParameterValue ایجاد کند زیرا maxSize منفی است.

پارامترها

  • enterCount: تعداد دلخواه ورودی برای بازگشت.
  • maxSize: حداکثر اندازه تصاویر کوچک. حداکثر (عرض_تصویر کوچک، ارتفاع_تصویر کوچک). فقط زمانی مورد نیاز است که includeThumb درست باشد (در زیر).
  • ContinuationToken: (اختیاری) یک نشانه ادامه غیرشفاف از نوع رشته، که با فراخوانی listImages قبلی برگردانده می شود، که برای بازیابی تصاویر بعدی استفاده می شود. این پارامتر را برای اولین تماس listImages حذف کنید. توجه: دوربین مسئول الگوریتم تولید توکن است.
  • includeThumb: (اختیاری) پیش فرض به true . false برای حذف تصاویر کوچک از نتیجه استفاده کنید.

نتایج

  • ورودی ها: فهرستی از ویژگی های تصویر. هر ورودی باید دارای فیلدهای زیر باشد به جز طول و عرض جغرافیایی که اختیاری هستند:
    • name : نام
    • uri : URI
    • size : اندازه بر حسب بایت
    • dateTimeZone : تاریخ، زمان، و منطقه زمانی تصویر، در قالب: YYYY:MM:DD HH:MM:SS+(-)HH:MM . از قالب 24 ساعته برای زمان استفاده کنید. تاریخ و زمان با یک کاراکتر خالی از هم جدا می شوند. منطقه زمانی از زمان UTC جدا شده است.
    • lat : (اختیاری) عرض جغرافیایی محل ثبت تصویر.
    • lng : (اختیاری) طول جغرافیایی محل ثبت تصویر.
    • width : عرض تصویر
    • height : ارتفاع تصویر
    • thumbnail : رشته کدگذاری شده Base64 برای تصویر بند انگشتی (زمانی که includeThumb == true ).
  • totalEntries: تعداد کل ورودی های ذخیره شده.
  • ContinuationToken: (اختیاری) تنها در صورتی تنظیم شود که نتیجه ناقص باشد ( ناقص به معنای هر فهرستی است که آخرین تصویر را شامل نمی شود). برای واکشی ورودی های باقی مانده، مشتری باید دستور listImages دوباره با توکن فراخوانی کند.

خطاها

  • missingParameter: هیچ پارامتر مورد نیاز مشخص نشده است. برای مثال، entryCount مشخص نشده است.
  • invalidParameterName: نام پارامتر ورودی شناسایی نشده است.
  • invalidParameterValue: نام پارامتر ورودی شناسایی می شود، اما مقدار آن نامعتبر است. به عنوان مثال، continuationToken وجود ندارد، خارج از محدوده است، نوع داده آن نادرست است، نوع داده includeThumb نادرست است، یا maxSize دارای نوع داده اشتباه است زمانی که includeThumb درست است.

دستور I/O

ورودی فرمان
{
    "parameters": {
        "entryCount": 50,
        "maxSize": 100,
        "includeThumb": true
    }
}
خروجی فرمان
{
    "results": {
        "entries": [
            {
                "name": "abc",
                "uri": "image URI",
                "size": image size in bytes,
                "dateTimeZone": "2014:12:27 08:00:00+08:00"
                "lat": 50.5324
                "lng": -120.2332
                "width": 2000
                "height": 1000
                "thumbnail": "ENCODEDSTRING"
            }
            ...
            {
                ...
            }
        ],
        "totalEntries": 250,
        "continuationToken": "50"
    }
}
خروجی فرمان (خطا)
{
    "error": {
        "code": "invalidParameterValue",
        "message": "Parameter continuationToken is out of range."
    }
}