camera.getOptions

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

Parâmetros

  • sessionId::identificador de sessão exclusivo da string de tipo recebida usando o comando camera.startSession. Esse campo foi descontinuado na API de nível 2.
  • 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, Object Array. Consulte Opções.

Erros

  • missingParameter: um ou mais parâmetros obrigatórios estão ausentes. Por exemplo, optionNames não está especificado.
  • invalidParameterName:um ou mais nomes de parâmetros de entrada ou opções não são reconhecidos ou são incompatíveis. Por exemplo, esse código vai ser retornado se uma opção (por exemplo, captureInterval) da API de nível 2 for usada quando clientVersion em Options for 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 na API de nível 2 porque, quando qualquer nome de opção é inválido, invalidParameterName precisa ser retornado.

E/S do comando
Entrada de comando (API de nível 1) 
{
  "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 (API de nível 2) 
{
  "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."
   }
}