Streams and arming

GET /streams lists every input Rheocles can record, with a stable id, a kind, a human name, a model, a capability summary, and whether it is armed. Nothing in the list is on until you arm it.

Kinds

{ "streams": [
    { "id": "display:56A96CFC-7F21-168E-0857-D6964E3302DB", "kind": "display",
      "name": "BenQ PD3220U", "model": "vendor 2513 model 32813",
      "capabilities": { "video": { "width": 3840, "height": 2160, "maxFrameRate": 60 } },
      "armed": false },
    { "id": "microphone:Scarlett_2i2", "kind": "microphone",
      "name": "Scarlett 2i2 USB", "model": "Scarlett 2i2 USB:1235:8210",
      "capabilities": { "audio": { "sampleRate": 48000, "channels": 2 } },
      "armed": true,
      "active": { "audio": { "sampleRate": 48000, "channels": 2 } },
      "framesSeen": 4812 } ],
  "permissions": { "camera": "notDetermined", "microphone": "authorized", "screen": "authorized" } }

Ids are <kind>:<identifier>, URL-safe, and stable for as long as the thing they name is: cameras and microphones use the device’s unique id, displays their CoreGraphics UUID (which survives reconnects where the display number does not), windows their window number, which survives nothing and is not meant to. The order is fixed — displays, windows, cameras, microphones, system audio — so the list is stable between calls as devices come and go.

Three identity fields — id, name, model — are all recorded in the manifest, because display ids change across reconnects and a take must stay legible after the hardware does.

capabilities.video is native pixels and the highest advertised rate; the signal’s real rate can be lower, and the writer follows the frames, not this field. Recording is always 48 kHz 24-bit BWF whatever capabilities.audio says the device is doing.

active and framesSeen appear only while armed. active is the format the device is actually delivering — which is what a take records — and framesSeen is how many frames or audio buffers it has delivered since arming. A live device counts up; a stuck one does not, and that is how a client tells the difference before the cue.

permissions is what macOS has let this process do — authorized, denied, restricted or notDetermined. Screen Recording gates displays and windows both: with screen anything but authorized the list simply has none, and this field is how a client tells “no displays” from “not allowed to see them”.

Windows are supported by the engine and the API from day one and hidden in the popover behind a Show windows setting: window lists are long and volatile, and the UI for choosing one well is a later design pass. Per-process audio is later too; systemAudio is the whole output for now.

Armed means live

An armed stream has its capture session running — frames flowing, discarded — so that when the cue comes the writer starts on frames that already exist, rather than waiting hundreds of milliseconds for a device to spin up. That is the entire reason there is an arm button rather than only a record button: arming is what makes “on one cue” true.

curl -s -H "$H" -X POST localhost:7447/streams/camera:0x2300000fd9009c/arm -d '{"armed": true}'

{ "id": "camera:0x2300000fd9009c", "kind": "camera", "name": "Elgato 4K X", "model": "…",
  "capabilities": { "video": { "width": 3840, "height": 2160, "maxFrameRate": 30 } },
  "armed": true,
  "active": { "video": { "width": 1280, "height": 720, "maxFrameRate": 120 } },
  "framesSeen": 0 }

Both directions are idempotent and answer the stream as it now is. Every change of armed state is also pushed as a stream event to anything listening on /events or the WebSocket.

What arming holds, per kind

When arming fails

Three verbs, and only these

start on a take is join for every armed stream at once. That is the cue.

join on a stream that is not yet armed arms it first, so one call gets a cold stream into a running take — it just does not get there on frames that already existed. Disarming a joined stream implies leave. Nothing else is implicit.

T=localhost:7447/takes/tk_7f3a
curl -s -H "$H" -X POST $T/join  -d '{"stream": "window:11597"}'
curl -s -H "$H" -X POST $T/leave -d '{"stream": "window:11597"}'

Late join

A file that started four minutes into the take is stamped four minutes into the take, and an editor places it at four minutes. Nothing about one stream’s timing depends on another’s — each file carries its own time-of-day timecode from its own first written frame, and the manifest records each stream’s started separately. See Timecode and sync.

The honest case: a 4K display capture that is only needed for a two-minute demo in the middle of an hour-long take. Leave it unarmed so the cue does not take it, join it a moment before the demo — which arms it, and costs the spin-up — and leave it after, and the other fifty-eight minutes do not cost an encoder. The dishonest case is anything where the join and leave are the edit.

What the popover shows