Events (SSE)
Real-time event stream from the camera SDK. Subscribe to events from all cameras or a specific camera.
See the auto-generated API reference for full request/response schemas.
Subscribe to All Camera Events
Section titled “Subscribe to All Camera Events”GET /api/events
curl -N http://localhost:8080/api/eventsSubscribe to Select Camera Events
Section titled “Subscribe to Select Camera Events”GET /api/cameras/{cameraId}/events — same event types, filtered to a single camera.
curl -N http://localhost:8080/api/cameras/D10F60149B0C/eventsConnection & Lifecycle Events
Section titled “Connection & Lifecycle Events”Events related to camera connection state and SDK errors.
| Event | SDK Callback | Description |
|---|---|---|
connected |
OnConnected |
Camera connection established |
disconnected |
OnDisconnected |
Camera disconnected |
error |
OnError |
SDK error occurred |
connected
Section titled “connected”{"cameraId": "D10F60149B0C"}disconnected
Section titled “disconnected”{"error": "0x00000000"}{"code": "0x00008001", "message": "Generic error"}Property & Action Events
Section titled “Property & Action Events”Real-time notifications from camera activity — settings changes, shutter events, autofocus, and file transfers.
| Event | SDK Callback | Description |
|---|---|---|
propertyChanged |
OnPropertyChangedCodes |
Property values changed |
warning |
OnWarning |
Camera warning/notification |
afStatus |
OnWarningExt |
Autofocus state change |
downloadComplete |
OnCompleteDownload |
Auto-transferred image saved |
transferProgress |
OnNotifyRemoteTransferResult |
File pull completed |
lutImportResult |
OnWarning |
LUT import completed or failed |
propertyChanged
Section titled “propertyChanged”{"codes": ["0x104", "0x105"], "count": 2}warning
Section titled “warning”{"code": "0x20011", "message": "Captured_Event"}Code 0x20011 = image captured (shutter fired).
afStatus
Section titled “afStatus”{"state": "focused"}States: focused, unlocked, tracking
downloadComplete
Section titled “downloadComplete”{"filename": "/path/to/DSC09596.JPG", "type": "image"}Only fires in remote connection mode with still-image-store-destination set to Host PC or Both.
transferProgress
Section titled “transferProgress”{"percent": 100, "notify": "0x20093", "filename": "/path/to/DSC09598.JPG"}Only fires in remote-transfer mode after explicit file pull.
lutImportResult
Section titled “lutImportResult”{"slot": 1, "status": "success"}{"slot": 1, "status": "error", "error": "invalid_file"}Fires after a LUT import operation completes. Error codes: general_failure, invalid_filename, device_busy, storage_full, invalid_parameter, invalid_file, invalid.
Event Sequence Examples
Section titled “Event Sequence Examples”Capture with auto-transfer (remote mode)
Section titled “Capture with auto-transfer (remote mode)”event: afStatusdata: {"state":"focused"}
event: warningdata: {"code":"0x20011","message":"Captured_Event"}
event: downloadCompletedata: {"filename":"/path/to/DSC09596.JPG","type":"image"}
event: afStatusdata: {"state":"unlocked"}SD card file pull (remote-transfer mode)
Section titled “SD card file pull (remote-transfer mode)”event: transferProgressdata: {"percent":100,"notify":"0x20093","filename":"/path/to/DSC09598.JPG"}File Transfer by Mode
Section titled “File Transfer by Mode”| Mode | Auto-transfer? | SSE Event | Mechanism |
|---|---|---|---|
remote |
Yes (if StoreDestination = HostPC/Both) | downloadComplete |
SDK pushes via OnCompleteDownload |
remote-transfer |
No — explicit pull | transferProgress |
Pull via POST .../download |
contents |
No — pull only | contentsTransfer |
Pull-only, no shooting |
Keepalive
Section titled “Keepalive”The server sends a : keepalive comment every 30 seconds to detect dead connections.