Zwraca bieżące ustawienia żądanych właściwości. To polecenie zostało zmienione na poziomie interfejsu API 2.
Parametry
- sessionId: unikalny identyfikator sesji typu uzyskanego ciągu znaków.
za pomocą polecenia
camera.startSession
. To pole zostało wycofane na poziomie interfejsu API 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. Wartościami mogą być te typy wartości:String
,String Array
,Number
,Number Array
,Boolean
,Object
,Object Array
. Zobacz Opcje.
Błędy
- missingparameter (brak parametru): brak co najmniej jednego wymaganego parametru;
na przykład
optionNames
nie został określony. - invalidparameterName:co najmniej 1 nazwa lub opcja parametru wejściowego.
nazwa jest nierozpoznana lub nieobsługiwana, np. ten kod powinien być zwracany, jeśli
gdy używana jest opcja
clientVersion
(np.captureInterval
) z interfejsu API poziomu 2 wOptions
wynosi 1. - invalidParameterValue::nazwy parametrów wejściowych są rozpoznawane,
co najmniej jedna wartość jest nieprawidłowa; na przykład
sessionId
nie istnieje, jest nieaktywny lub jego typ danych jest nieprawidłowy. Ten kod błędu został wycofany w Poziom 2 interfejsu API, ponieważ gdy jakakolwiek nazwa opcji jest nieprawidłowa,invalidParameterName
.
Polecenie I/O | |
---|---|
Dane wejściowe polecenia (poziom interfejsu API 1) | { "parameters": { "sessionId": "12ABC3", "optionNames": [ "iso", "isoSupport" ] } } |
Dane wyjściowe polecenia (poziom interfejsu 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 polecenia (poziom interfejsu API 2) | { "parameters": { "optionNames": [ "iso", "isoSupport" ] } } |
Dane wyjściowe polecenia (poziom interfejsu 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." } } |