Skip to main content

Documentation Index

Fetch the complete documentation index at: https://crsdk.app/llms.txt

Use this file to discover all available pages before exploring further.

Real-time event stream from the camera SDK. Subscribe to events from all cameras or a specific camera.

​
Subscribe to All Camera Events

​
method
GET
GET /api/events
curl -N http://localhost:8080/api/events

​
Subscribe to Select Camera Events

​
method
GET
GET /api/cameras/{cameraId}/events
Same event types, filtered to a single camera. 
curl -N http://localhost:8080/api/cameras/D10F60149B0C/events

​
Connection & Lifecycle Events

Events related to camera connection state and SDK errors.
When using the Client SDK, connection and lifecycle events can also be accessed via manager.on(). See Client SDK Events for details.
EventSDK CallbackDescription
connectedOnConnectedCamera connection established
disconnectedOnDisconnectedCamera disconnected
errorOnErrorSDK error occurred

​
connected

{"cameraId": "D10F60149B0C"}

​
disconnected

{"error": "0x00000000"}

​
error

{"code": "0x00008001", "message": "Generic error"}

​
Property & Action Events

Real-time notifications from camera activity — settings changes, shutter events, autofocus, and file transfers.
EventSDK CallbackDescription
propertyChangedOnPropertyChangedCodesProperty values changed
warningOnWarningCamera warning/notification
afStatusOnWarningExtAutofocus state change
downloadCompleteOnCompleteDownloadAuto-transferred image saved
transferProgressOnNotifyRemoteTransferResultFile pull completed
lutImportResultOnWarningLUT import completed or failed

​
propertyChanged

{"codes": ["0x104", "0x105"], "count": 2}

​
warning

{"code": "0x20011", "message": "Captured_Event"}
Code 0x20011 = image captured (shutter fired).

​
afStatus

{"state": "focused"}
States: focused, unlocked, tracking

​
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

{"percent": 100, "notify": "0x20093", "filename": "/path/to/DSC09598.JPG"}
Only fires in remote-transfer mode after explicit file pull.

​
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

​
Capture with auto-transfer (remote mode)

event: afStatus
data: {"state":"focused"}

event: warning
data: {"code":"0x20011","message":"Captured_Event"}

event: downloadComplete
data: {"filename":"/path/to/DSC09596.JPG","type":"image"}

event: afStatus
data: {"state":"unlocked"}

​
SD card file pull (remote-transfer mode)

event: transferProgress
data: {"percent":100,"notify":"0x20093","filename":"/path/to/DSC09598.JPG"}

​
File Transfer by Mode

ModeAuto-transfer?SSE EventMechanism
remoteYes (if StoreDestination = HostPC/Both)downloadCompleteSDK pushes via OnCompleteDownload
remote-transferNo — explicit pulltransferProgressPull via POST .../download
contentsNo — pull onlycontentsTransferPull-only, no shooting

​
Keepalive

The server sends a : keepalive comment every 30 seconds to detect dead connections.