camera.getOptions

返回所请求属性的当前设置。此命令在 API 级别 2 中进行了修改。

参数

  • sessionId:：使用 camera.startSession 命令获取的字符串类型的唯一会话标识符。此字段在 API 级别 2 中已废弃。
  • optionNames：要返回的属性名称的字符串数组。

成果

  • options：所请求属性的 JSON <key, value> 对。其值可以是以下任意类型：String、String Array、Number、Number Array、Boolean、Object、Object 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."
   }
}