camera.getOptions

Retorna as configurações atuais das propriedades solicitadas. Esse comando foi modificado no nível 2 da API.

Parâmetros

  • sessionId::identificador exclusivo de sessão do tipo string recebido usando o comando camera.startSession. Esse campo foi descontinuado no nível 2 da API.
  • optionNames:uma matriz de strings de nomes de propriedades a serem retornados.

Resultados

  • options: pares JSON <key, value> das propriedades solicitadas. O valor pode ser qualquer um destes tipos: String, String Array, Number, Number Array, Boolean, Object e Object Array. Consulte Opções.

Erros

  • missingParameter: um ou mais parâmetros obrigatórios estão ausentes. por exemplo, optionNames não é especificado.
  • invalidParameterName:um ou mais nomes ou opções de parâmetros de entrada nome não reconhecido ou suportado, por exemplo, este código deve ser retornado se uma (por exemplo, captureInterval) do nível 2 da API é usada quando clientVersion em Options é 1.
  • invalidParameterValue: os nomes dos parâmetros de entrada são reconhecidos, mas um ou mais valores são inválidos; Por exemplo, sessionId não existe, está inativo ou o tipo de dados está incorreto. Esse código de erro foi descontinuado em API de nível 2 porque, quando qualquer nome de opção é inválido, invalidParameterName deve ser retornado.

E/S de comando
Entrada de comando (nível 1 da API) 
{
  "parameters": {
      "sessionId": "12ABC3",
      "optionNames": [
          "iso",
          "isoSupport"
      ]
  }
}
Resposta ao comando (nível 1 da API) 
{
  "results": {
      "options": {
           "iso": 200,
           "isoSupport": [100, 200, 400, 800, 1600]
      }
  }
}
Resposta ao comando (erro) (nível 1 da API) 
{
  "error": {
      "code": "invalidParameterName",
      "message": "Parameter optionNames contains unrecognized option XYZ."
   }
}
Entrada de comando (nível 2 da API) 
{
  "parameters": {
      "optionNames": [
          "iso",
          "isoSupport"
      ]
  }
}
Resposta ao comando (nível 2 da API) 
{
  "results": {
      "options": {
           "iso": 200,
           "isoSupport": [100, 200, 400, 800, 1600]
      }
  }
}
Resposta ao comando (erro) (nível 2 da API) 
{
  "error": {
      "code": "invalidParameterName",
      "message": "Parameter optionNames contains unrecognized option XYZ."
   }
}