Stan

Interfejs /osc/state API zwraca state atrybuty kamery. Różnica między tym a interfejsem API info polega na tym, że state zawiera zmienne wartości reprezentujące stan aparatu (np. batteryLevel), a info zawiera tylko statyczne atrybuty kamery (na przykład manufacturer lub atrybuty, które rzadko się zmieniają, jak 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. Patrz następna tabela.

state obiekt

Ten obiekt JSON podaje stan różnych stanów kamery. Producenci mogą dodawać nowe stany niestandardowe. Aby zapobiec konfliktom przestrzeni nazw, należy je poprzedzić znakiem podkreślenia ( _ ).

Nazwa Typ Opis
sessionId Ciąg znaków Identyfikator bieżącej sesji. To pole zostało wycofane w interfejsie API poziomu 2.
batteryLevel Liczby Wyrażona w liczbach zmiennoprzecinkowych pozostałej baterii, np. 0,5
storageChanged Wartość logiczna Wartość to „prawda”, jeśli zostanie włożony lub wyjęty nowy typ pamięci (np. karta SD lub dysk USB). To pole zostało wycofane w interfejsie API poziomu 2.
storageUri Ciąg znaków Unikalny identyfikator pozwalający rozróżnić różne miejsca na dane. Jest używany do określenia, czy miejsce na dane uległo zmianie. To pole zostało dodane na poziomie 2 interfejsu API.
_vendorSpecific [typ](opcjonalnie) Dodatkowy stan dotyczący kamery określony przez dostawcę. Prefiks z podkreśleniem ( _ ), aby zapobiec kolizji przestrzeni nazw.

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
    }
}