camera.getOptions

傳回所要求資源目前的設定。這個指令是在 API 級別 2 中修改。

參數

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

結果

  • options：所要求屬性的 JSON <key, value> 組合。 這個值可以是下列任一類型：String、String Array、Number、 Number Array、Boolean、Object、Object Array。詳情請見 選項。

錯誤

  • missingParameter：缺少一或多個必要參數； 例如未指定 optionNames
  • INVALIDParameterName：一或多個輸入參數名稱或選項 無法辨識或不支援的名稱，例如如果 當 clientVersion 時，系統會使用 API 級別 2 的選項 (例如 captureInterval) Options 為 1
  • 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."
   }
}