camera.getOptions

Trả về chế độ cài đặt hiện tại cho các thuộc tính được yêu cầu. Lệnh này đã được sửa đổi trong API cấp 2.

Các tham số

  • sessionId: Giá trị nhận dạng phiên duy nhất của chuỗi loại thu được bằng lệnh camera.startSession. Trường này không còn được dùng trong API cấp 2.
  • optionsNames: Một mảng chuỗi gồm các tên thuộc tính cần trả về.

Kết quả

  • options:Các cặp thuộc tính được yêu cầu ở dạng JSON <key, value>. Giá trị có thể là bất kỳ loại nào sau đây: String, String Array, Number, Number Array, Boolean, Object, Object Array. Xem Tuỳ chọn.

Lỗi

  • missingParameter: (Thiếu tham số bắt buộc): Thiếu một hoặc nhiều tham số bắt buộc; ví dụ: optionNames chưa được chỉ định.
  • invalidParameterName: Một hoặc nhiều tên lựa chọn hoặc tên tham số đầu vào không được nhận dạng hoặc không được hỗ trợ, chẳng hạn như hệ thống sẽ trả về mã này nếu một lựa chọn (ví dụ: captureInterval) từ API cấp 2 được sử dụng khi clientVersion trong Options là 1.
  • invalidParameterValue: Tên tham số đầu vào được nhận dạng, nhưng một hoặc nhiều giá trị không hợp lệ; ví dụ: sessionId không tồn tại, không hoạt động hoặc loại dữ liệu của tham số đó không chính xác. Mã lỗi này không còn được dùng trong API cấp 2 vì khi có bất kỳ tên tuỳ chọn nào không hợp lệ, hệ thống sẽ trả về invalidParameterName.

I/O lệnh
Command Input (API cấp 1) 
{
  "parameters": {
      "sessionId": "12ABC3",
      "optionNames": [
          "iso",
          "isoSupport"
      ]
  }
}
Đầu ra của lệnh (API cấp 1) 
{
  "results": {
      "options": {
           "iso": 200,
           "isoSupport": [100, 200, 400, 800, 1600]
      }
  }
}
Đầu ra của lệnh (Lỗi) (API cấp 1) 
{
  "error": {
      "code": "invalidParameterName",
      "message": "Parameter optionNames contains unrecognized option XYZ."
   }
}
Command Input (API cấp 2) 
{
  "parameters": {
      "optionNames": [
          "iso",
          "isoSupport"
      ]
  }
}
Đầu ra của lệnh (API cấp 2) 
{
  "results": {
      "options": {
           "iso": 200,
           "isoSupport": [100, 200, 400, 800, 1600]
      }
  }
}
Đầu ra của lệnh (Lỗi) (API cấp 2) 
{
  "error": {
      "code": "invalidParameterName",
      "message": "Parameter optionNames contains unrecognized option XYZ."
   }
}