Subscribe to all camera events (SSE)

SDK generation note: marked x-fern-ignore: true because Server-Sent Events don’t map cleanly onto synchronous SDK methods. The TypeScript and Swift SDKs ship hand-written SSE clients that consume this endpoint and expose typed EventStream APIs.

Server-Sent Events stream for all connected cameras. The server sends a keepalive comment (: keepalive) every 30 seconds and immediately fires an initial connected event with the subscription’s camera ID payload (see the quirk note below).

Event Types

⚠ The dual connected event quirk

Two distinct conditions emit an event named connected:

1. Initial SSE handshake — fired immediately when the EventSource connects, with payload {"cameraId":"<subscription-id-or-*>"}. Use it to confirm the SSE channel is open. NOT a camera state change.
2. Real camera connect — fired when the SDK’s OnConnected callback fires for a camera, with the full camera info payload.

Discriminate by payload shape if you need to distinguish them. The cleanest pattern is to ignore the first connected event after opening the EventSource and treat any subsequent connected as a real camera-state change.

Example

const events = new EventSource("http://localhost:8080/api/events");
events.addEventListener("downloadComplete", (e) => {
  console.log("File saved:", JSON.parse(e.data).savedPath);
});
events.addEventListener("propertyChanged", (e) => {
  const { codes } = JSON.parse(e.data);
  // Refresh affected properties via getProperty / getAllProperties
});