aparat.getOptions

Zwraca bieżące ustawienia żądanych właściwości. To polecenie zostało zmodyfikowane na poziomie API 2.

Parametry

  • sessionId: unikalny identyfikator sesji w postaci ciągu znaków uzyskanego za pomocą polecenia camera.startSession. To pole zostało wycofane w interfejsie API poziomu 2.
  • optionNames: tablica ciągów znaków z nazwami właściwości do zwrócenia.

Wyniki

  • options: pary JSON <key, value> żądanych właściwości. Możliwe typy wartości: String, String Array, Number, Number Array, Boolean, Object, Object Array. Zobacz Opcje.

Błędy

  • missingParameter: brakuje co najmniej jednego wymaganego parametru, np. optionNames.
  • NieprawidłowyParametrName: co najmniej 1 nazwa parametru wejściowego lub nazwa opcji jest nierozpoznana lub nieobsługiwana. Np. ten kod powinien zostać zwrócony, jeśli zostanie użyta opcja (np. captureInterval) z poziomu interfejsu API 2, gdy clientVersion w Options ma wartość 1.
  • Nieprawidłowy parametr: nazwy parametrów wejściowych zostały rozpoznane, ale co najmniej jedna wartość jest nieprawidłowa, np. sessionId nie istnieje, jest nieaktywny lub ma nieprawidłowy typ danych. Ten kod błędu został wycofany na poziomie 2 interfejsu API, ponieważ gdy nazwa opcji jest nieprawidłowa, wartość invalidParameterName powinna być zwracana.

Command I/O
Dane wejściowe (poziom interfejsu API 1) 
{
  "parameters": {
      "sessionId": "12ABC3",
      "optionNames": [
          "iso",
          "isoSupport"
      ]
  }
}
Dane wyjściowe polecenia (poziom API 1) 
{
  "results": {
      "options": {
           "iso": 200,
           "isoSupport": [100, 200, 400, 800, 1600]
      }
  }
}
Dane wyjściowe polecenia (błąd) (poziom interfejsu API 1) 
{
  "error": {
      "code": "invalidParameterName",
      "message": "Parameter optionNames contains unrecognized option XYZ."
   }
}
Dane wejściowe (poziom interfejsu API 2) 
{
  "parameters": {
      "optionNames": [
          "iso",
          "isoSupport"
      ]
  }
}
Dane wyjściowe polecenia (poziom API 2) 
{
  "results": {
      "options": {
           "iso": 200,
           "isoSupport": [100, 200, 400, 800, 1600]
      }
  }
}
Dane wyjściowe polecenia (błąd) (poziom interfejsu API 2) 
{
  "error": {
      "code": "invalidParameterName",
      "message": "Parameter optionNames contains unrecognized option XYZ."
   }
}