Interfejs API na poziomie 1 w specyfikacji OSC API skupia się na typie obrazu, a obsługa wideo została dodana na poziomie API 2. Zachęcamy producentów aparatów do zdefiniowania poleceń niestandardowych lub w razie potrzeby do rozszerzenia zestawu parametrów standardowych. Są to tzw. Polecenia dostawcy i Parametry dostawcy.
Nazwa poleceń i parametrów specyficznych dla dostawcy musi być alfanumeryczna i poprzedzona podkreśleniem ( _ ).
Funkcje dostawców mogą działać w 4 miejscach:
- Dane wyjściowe interfejsu API /osc/info
- Dane wyjściowe interfejsu API /osc/state
- Specyfikacja interfejsu OSC API, polecenia do /osc/commands/execute
- Specyfikacja interfejsu OSC API, parametry polecenia; np. parametry poleceń
setOptions
igetOptions
.
Przykład | |
---|---|
Żądanie (API 1) | POST /osc/commands/execute HTTP/1.1 Host: [camera ip address]:[httpPort] Content-Type: application/json;charset=utf-8 Accept: application/json Content-Length: {CONTENT_LENGTH} X-XSRF-Protected: 1 { "name": "camera.setOptions", "parameters": { "sessionId": "12ABC3", "iso": 200, "exposureCompensation": -2, "captureMode": "_video" } } |
Odpowiedź | HTTP/1.1 200 OK Content-Type: application/json;charset=utf-8 Content-Length: {CONTENT_LENGTH} X-Content-Type-Options: nosniff { "name": "camera.setOptions", "state": "done" } |
Wyślij prośbę | POST /osc/commands/execute HTTP/1.1 Host: [camera ip address]:[httpPort] Content-Type: application/json;charset=utf-8 Accept: application/json Content-Length: {CONTENT_LENGTH} X-XSRF-Protected: 1 { "name": "camera._startRecording", "parameters": { "sessionId": "12ABC3", ... } } |
Odpowiedź | HTTP/1.1 200 OK Content-Type: application/json;charset=utf-8 Content-Length: {CONTENT_LENGTH} X-Content-Type-Options: nosniff { "name": "camera._startRecording", "state": "done" } |