camera.getOptions

傳回所要求屬性目前的設定。這個指令已在 API 級別 2 中修改。

參數

  • sessionId:使用 camera.startSession 指令取得類型字串的不重複工作階段 ID。這個欄位已在 API 級別 2 中淘汰。
  • optionNames:要傳回的屬性名稱字串陣列。

成果

  • options:要求屬性的 JSON <key, value> 組合。這個值可以是下列任一類型:StringString ArrayNumberNumber ArrayBooleanObjectObject Array。請參閱「選項」一節。

錯誤

  • missingParameter:缺少一或多個必要參數;例如,未指定 optionNames
  • invalidParameterName:一或多個輸入參數名稱或選項名稱無法辨識或不受支援。舉例來說,如果在 Options 中的 clientVersion 為 1 時使用 API 級別 2 的選項 (例如 captureInterval),就應傳回此代碼。
  • invalidParameterValue:系統可辨識輸入參數名稱,但一或多個值無效;例如 sessionId 不存在、無效或資料類型不正確。由於任何選項名稱無效,因此此錯誤代碼已在 API 級別 2 中淘汰,因此應傳回 invalidParameterName

指令 I/O

指令輸入 (API 級別 1)
{
  "parameters": {
      "sessionId": "12ABC3",
      "optionNames": [
          "iso",
          "isoSupport"
      ]
  }
}
指令輸出 (API 級別 1)
{
  "results": {
      "options": {
           "iso": 200,
           "isoSupport": [100, 200, 400, 800, 1600]
      }
  }
}
指令輸出 (錯誤) (API 級別 1)
{
  "error": {
      "code": "invalidParameterName",
      "message": "Parameter optionNames contains unrecognized option XYZ."
   }
}
指令輸入 (API 級別 2)
{
  "parameters": {
      "optionNames": [
          "iso",
          "isoSupport"
      ]
  }
}
指令輸出 (API 級別 2)
{
  "results": {
      "options": {
           "iso": 200,
           "isoSupport": [100, 200, 400, 800, 1600]
      }
  }
}
指令輸出 (錯誤) (API 級別 2)
{
  "error": {
      "code": "invalidParameterName",
      "message": "Parameter optionNames contains unrecognized option XYZ."
   }
}