camera.getOptions

リクエストされたプロパティの現在の設定を返します。このコマンドは API レベル 2 で変更されました。

パラメータ

  • sessionId: camera.startSession コマンドを使用して取得した文字列タイプの一意のセッション ID。このフィールドは API レベル 2 で非推奨になりました。
  • optionNames: 返すプロパティ名の文字列配列。

結果

  • options: リクエストされたプロパティの JSON <key, value> ペア。値は、String、String Array、Number、Number Array、Boolean、Object、Object Array のいずれかのタイプです。オプションをご覧ください。

エラー

  • missingParameter: 1 つ以上の必須パラメータがありません。たとえば、optionNames が指定されていません。
  • invalidParameterName: 1 つ以上の入力パラメータ名またはオプション名が認識できない、またはサポートされていません。たとえば、Options の clientVersion が 1 のときに API レベル 2 のオプション（captureInterval など）を使用した場合、このコードが返されます。
  • invalidParameterValue: 入力パラメータ名は認識されましたが、1 つ以上の値が無効です。たとえば、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."
   }
}