camera.getOptions

Mantenha tudo organizado com as coleções Salve e categorize o conteúdo com base nas suas preferências.

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

Parâmetros

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

Resultados

  • opções: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âmetro de entrada ou opção não são reconhecidos ou não são compatíveis. Por exemplo, esse código precisa ser retornado se uma opção (por exemplo, captureInterval) do nível 2 da API 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 no nível 2 da API, já que quando qualquer nome de opção é inválido, invalidParameterName precisa 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) (API de nível 1)
{
  "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) (API de nível 2)
{
  "error": {
      "code": "invalidParameterName",
      "message": "Parameter optionNames contains unrecognized option XYZ."
   }
}