Stan

Interfejs /osc/state API zwraca atrybuty kamery o nazwie state. Różnica między tym a interfejsem API info jest to, że state zawiera zmienne wartości reprezentujące stan kamery (np. batteryLevel), a info zawiera tylko statyczne atrybuty kamery (na przykład manufacturer lub atrybutów, które rzadko się zmieniają, np. firmwareVersion).

Dane wejściowe

  • To polecenie nie wymaga wprowadzania danych.

Wyniki

Nazwa Typ Opis
fingerprint Ciąg znaków Odcisk cyfrowy (unikalny identyfikator) bieżącego stanu aparatu.
state Obiekt Obiekt JSON zawierający stan różnych stanów kamery. Zobacz następną tabelę.

state obiekt

Ten obiekt JSON udostępnia stan różnych stanów kamery. Producenci mogą podaj nowe, niestandardowe stany, które powinny być poprzedzone znakiem podkreślenia ( _ ) , aby zapobiec konfliktom przestrzeni nazw.

Nazwa Typ Opis
sessionId Ciąg znaków Identyfikator bieżącej sesji. To pole zostało wycofane na poziomie interfejsu API 2.
batteryLevel Liczba Wyrażona jako zmiennoprzecinkowa pozostałego czasu pracy baterii, np. 0,5
storageChanged Wartość logiczna Prawda, jeśli został włożony lub wyjęty nowy typ pamięci (np. karta SD lub dysk USB). To pole zostało wycofane na poziomie interfejsu API 2.
storageUri Ciąg znaków Unikalny identyfikator umożliwiający rozróżnienie różnych pamięci. Wskazuje, czy ilość miejsca na dane się zmieniła. To pole zostało dodane na poziomie interfejsu API 2.
_vendorSpecific [typ](opcjonalnie) Dodatkowy stan kamery specyficzny dla dostawcy. Aby zapobiegać kolizji z przestrzeniami nazw, poprzedź prefiksem podkreślenia ( _ ).

Błąd

  • To polecenie nie zwraca żadnych błędów.

Przykład
Wyślij prośbę 
POST /osc/state HTTP/1.1
Host: [camera ip address]:[httpPort]
Accept: application/json
X-XSRF-Protected: 1
Odpowiedź 
HTTP/1.1 200 OK
Content-Type: application/json;charset=utf-8
Content-Length: {CONTENT_LENGTH}
X-Content-Type-Options: nosniff

{
    "fingerprint": "12EGA33",
    "state": {
        "sessionId": "12ABC3",
        "batteryLevel": 0.5,
        "storageChanged": false
    }
}