Files.list

يسرد جميع الصور/جميع الفيديوهات/جميع الصور والفيديوهات المتوفّرة في الكاميرا. قد يستغرق عدة طلبات لسرد جميع الملفات. تمت إضافة هذا الأمر في المستوى 2 من واجهة برمجة التطبيقات.

إذا كانت الكاميرا لا تتوافق مع المعلَمات المطلوبة، يجب أن تعرض الكاميرا أقصى إمكانات متاحة للأجهزة. على سبيل المثال، قد تكون هناك حالة نادرة الطلب: {entryCount: 500, maxSize: 2000}. وبدلاً من طرح خطأ، يجب أن يستند الرد إلى أقصى حد تدعمه الكاميرا، مثل: {entryCount: 100, maxSize: 200}. يُرجى طرح أخطاء لكل العناصر الأخرى الحالات على سبيل المثال، عندما يكون الطلب، {entryCount: 500, maxSize: -500}، من المفترض أن يعرض الخطأ invalidParameterValue لأن maxSize قيمة سالبة.

المعلمات

  • fileType: نوع الملفات المطلوب إدراجها، ويجب أن يكون أيًا من الثلاثة: "الصورة" و"الفيديو" و"الكل".
  • startPosition: (اختياري) موضع الملف الأول في القائمة. إذا تم إسقاطها، يكون موضع البداية 0، والذي يمثل الملف الأول. إذا كان حجمه أكبر من موضع الملف الأخير، فارجع استجابة عادية بإدخالات فارغة في النتائج بدلاً من استجابة خطأ.
  • entryCount: عدد الإدخالات المطلوب عرضها. إذا كان أكبر من عدد الملفات المتبقية، ما عليك سوى عرض استجابة عادية الملفات الفعلية المتبقية بدلاً من استجابة الخطأ.
  • maxThumbSize: الحد الأقصى لحجم الصور المصغّرة max(الصورة المصغّرة: العرض المصغرة، الصورة المصغرة: الارتفاع). ويتم ضبطها على null عندما ينفِّذ البرنامج يريد حذف الصور المصغرة من النتيجة.

النتائج

  • الإدخالات: قائمة بخصائص الصور. يجب أن يحتوي كل إدخال على الحقول التالية باستثناء خطوط الطول والعرض، وهما اختياريتان:
    • name: اسم الملف.
    • fileUrl: عنوان URL كامل للملف، والذي يمكن استخدامه للتنزيل من الكاميرا مباشرة.
    • size: حجم الملف بالبايت.
    • dateTimeZone: التاريخ والوقت والمنطقة الزمنية للملف، بالتنسيق: YYYY:MM:DD HH:MM:SS+(-)HH:MM استخدم تنسيق 24 ساعة للوقت. التاريخ الوقت مفصولة بحرف واحد فارغ. تختلف المنطقة الزمنية عن التوقيت العالمي المنسّق (UTC). يُرجى ملاحظة هذا إلى نهاية التقاط الفيديوهات.
    • lat (خط العرض): (اختيارية) خط العرض للموقع الجغرافي وقت التقاط الملف.
    • lng: (اختياري) خط الطول للموقع أثناء التقاط الملف.
    • width: عرض الصورة أو كل إطار فيديو.
    • height: ارتفاع الصورة أو كل إطار فيديو.
    • الصورة المصغّرة: سلسلة Base64 مرمّزة للصورة المصغّرة للملف (عند maxThumbSize != null).
    • isProcessed: قيمة منطقية تشير إلى ما إذا كان الملف التي تمت معالجتها (مثلاً، مجمعة) أو أنها مجرد معاينة. يجب أن يكون هذا صحيحًا بحلول تلقائي ما لم يتم ضبط delayProcessing على "صحيح". في حال وجود صورة تمت معالجتها، عدم إدراج صورة المعاينة المقابلة حتى إن كانت موجودة، وإلا، فقم بإدراج صورة المعاينة.
    • previewUrl: يتم ضبط القيمة التلقائية على سلسلة فارغة إذا كانت القيمة delayProcessing. غير متاحة أو عندما تساوي isProcessed القيمة "خطأ" أو عند معاينة الصورة لم يتم إنشاؤه مطلقًا كنتيجة وسيطة، وبخلاف ذلك، يكون عنوان URL الخاص بـ لصورة المعاينة المقابلة للصورة النهائية. يستخدم هذا لبناء الارتباط بين صورة المعاينة والصورة النهائية.
  • totalEntries: إجمالي عدد الإدخالات fileType في التخزين، على سبيل المثال إذا كان fileType هو "image"، فهو إجمالي عدد الصور في مساحة التخزين.

الأخطاء

  • مَعلمة مفقودة: لم يتم تحديد أي مَعلمة مطلوبة. على سبيل المثال، لم يتم تحديد entryCount.
  • spamPARAMName: اسم مَعلمة الإدخال هو. لم يتم التعرّف عليها.
  • 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."
    }
}