camera.getOptions

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

المَعلمات

  • sessionId: معرّف الجلسة الفريد من نوع السلسلة الذي تم الحصول عليه باستخدام الأمر camera.startSession. تم إيقاف هذا الحقل نهائيًا في المستوى 2 من واجهة برمجة التطبيقات.
  • optionNames: مصفوفة سلسلة من أسماء الخصائص المطلوب عرضها

النتائج

  • الخيارات: أزواج JSON <key, value> من السمات المطلوبة. يمكن أن تكون القيمة من الأنواع التالية: String أو String Array أو Number أو Number Array أو Boolean أو Object أو Object Array. راجِع الخيارات.

الأخطاء

  • missingParameter: هناك معلمة مطلوبة واحدة أو أكثر غير موجودة، على سبيل المثال، لم يتم تحديد optionNames.
  • unusedParameterName: اسم معلَمة إدخال أو اسم خيار واحد أو أكثر غير معروف أو غير متوافق. على سبيل المثال، يجب عرض هذا الرمز إذا تم استخدام خيار (مثل captureInterval) من المستوى 2 لواجهة برمجة التطبيقات عندما يكون clientVersion في Options بقيمة 1.
  • validParameterValue: يتم التعرّف على أسماء معلَمات الإدخال، ولكن قيمة واحدة أو أكثر غير صالحة، على سبيل المثال، السمة sessionId غير موجودة أو غير نشطة أو نوع البيانات غير صحيح. تم إيقاف رمز الخطأ هذا في المستوى 2 لواجهة برمجة التطبيقات لأنّه عندما يكون أي اسم خيار غير صالح، يجب عرض invalidParameterName.

Command I/O (إدخال وإخراج)
إدخال الأوامر (المستوى 1 من واجهة برمجة التطبيقات) 
{
  "parameters": {
      "sessionId": "12ABC3",
      "optionNames": [
          "iso",
          "isoSupport"
      ]
  }
}
مخرجات الأوامر (المستوى 1 من واجهة برمجة التطبيقات) 
{
  "results": {
      "options": {
           "iso": 200,
           "isoSupport": [100, 200, 400, 800, 1600]
      }
  }
}
مخرجات الأمر (الخطأ) (مستوى واجهة برمجة التطبيقات 1) 
{
  "error": {
      "code": "invalidParameterName",
      "message": "Parameter optionNames contains unrecognized option XYZ."
   }
}
إدخال الأوامر (المستوى 2 من واجهة برمجة التطبيقات) 
{
  "parameters": {
      "optionNames": [
          "iso",
          "isoSupport"
      ]
  }
}
مخرجات الأوامر (المستوى 2 لواجهة برمجة التطبيقات) 
{
  "results": {
      "options": {
           "iso": 200,
           "isoSupport": [100, 200, 400, 800, 1600]
      }
  }
}
مخرجات الأمر (الخطأ) (مستوى واجهة برمجة التطبيقات 2) 
{
  "error": {
      "code": "invalidParameterName",
      "message": "Parameter optionNames contains unrecognized option XYZ."
   }
}