camera.getOptions

Restituisce le impostazioni correnti per le proprietà richieste. Questo comando è stato modificato nel livello API 2.

Parametri

  • sessionId: identificatore di sessione univoco di una stringa di tipo ottenuto mediante il comando camera.startSession. Questo campo è stato ritirato nel livello API 2.
  • optionNames: un array di stringhe di nomi di proprietà da restituire.

Risultati

  • options:coppie JSON <key, value> delle proprietà richieste. Il valore può essere uno dei seguenti tipi: String, String Array, Number, Number Array, Boolean, Object, Object Array. Vedi le opzioni.

Errori

  • missingParameter: mancano uno o più parametri obbligatori. Ad esempio, optionNames non è specificato.
  • invalidParameterName: il nome di uno o più parametri di input o di opzione non sono riconosciuti o non sono supportati, ad esempio questo codice deve essere restituito se viene utilizzata un'opzione (ad es. captureInterval) dal livello API 2 quando clientVersion in Options è 1.
  • invalidParameterValue: i nomi dei parametri di input vengono riconosciuti, ma uno o più valori non sono validi. Ad esempio, sessionId non esiste, è inattivo o il tipo di dati non è corretto. Questo codice di errore è stato deprecato nel livello API 2 poiché, quando un nome di opzione non è valido, deve essere restituito invalidParameterName.

I/O comando
Input dei comandi (livello API 1) 
{
  "parameters": {
      "sessionId": "12ABC3",
      "optionNames": [
          "iso",
          "isoSupport"
      ]
  }
}
Output comando (livello API 1) 
{
  "results": {
      "options": {
           "iso": 200,
           "isoSupport": [100, 200, 400, 800, 1600]
      }
  }
}
Output comando (errore) (livello API 1) 
{
  "error": {
      "code": "invalidParameterName",
      "message": "Parameter optionNames contains unrecognized option XYZ."
   }
}
Input dei comandi (livello API 2) 
{
  "parameters": {
      "optionNames": [
          "iso",
          "isoSupport"
      ]
  }
}
Output comando (livello API 2) 
{
  "results": {
      "options": {
           "iso": 200,
           "isoSupport": [100, 200, 400, 800, 1600]
      }
  }
}
Output comando (errore) (livello API 2) 
{
  "error": {
      "code": "invalidParameterName",
      "message": "Parameter optionNames contains unrecognized option XYZ."
   }
}