beffroi-tools/docs/interfaces/midra-input-preview.md

54 lines
2.9 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# Midra input preview stills
This is a device-read interface, not a new project or export format. Verified on
Eikos 4K firmware 3.3.10, WebRCS `app.e42fce4879f318b28cde.js`.
## Discovery and request
The connected snapshot's `/device/inputList/items/INPUT_N` supplies:
- `status.pp.isAvailable`: only existing hardware inputs appear.
- `status.pp.plug`: selects `plugList.items[plug].status.signal.pp.isValid`
for the last-read signal indicator.
- `snapshot.pp.enable`: capture is disabled in the editor when WebRCS snapshots
are disabled. The application does not write this field or snapshot size.
One explicit **Capture still** issues
`GET http://<configured-IP>/api/device/snapshots/inputs/N`, with N an integer
1–16 and `Cache-Control: no-cache`. IPv4 and IPv6 literal addresses are accepted;
no proxy or redirect is followed. No retries, polling, WebSocket subscription,
still-library capture or source-routing/preset writes are involved.
Only one request may be in flight, with at least five seconds between starts.
Closing/cancelling discards the result but does not permit a second request until
the first completes or times out. The request has a 5-second connection timeout
and 20-second overall timeout. Device-provided resolution is retained; no request
to increase resolution or refresh frequency is made.
## Response and validation
A successful response must be a PNG, at most 16 MiB, and pass the common image
decoder's dimensions/allocation limits. HTTP errors, redirects, invalid PNGs,
oversize responses and decode errors leave references unchanged.
The active-input test returned 512 × 288 pixels; an inactive input returned a
blank 128 × 128 PNG. The device controls image freshness (Last-Modified) and
resolution; GET fetches the latest available snapshot, not a guaranteed
new full-resolution frame. Signal indicators may be stale until reconnect/refresh.
## Editor and persistence
The dialog displays the image and its actual pixel dimensions. **Add as reference**
is explicit and obeys the 32-image/64 MiB combined-reference limits. Existing
upscale/aspect warnings apply. Capture alone does not add, replace or move anything.
Changing device address/disconnecting invalidates the pending preview; input changes
clear the old preview. A cancelled/late result cannot become a new reference.
The initial image name contains the input number and configured device IP.
Added stills use the existing [project v10 reference object](midra-layout.md):
name, embedded PNG image_base64, visible, opacity, preserve_ratio,
native_size, offset. No new fields, version or migration are needed.
Reloading a project makes no capture requests. Captures are fixed viewport guides,
not layer-content textures, live feeds or export placeholders. Generic artwork
exports include them only through the existing visible-reference/background option.
Automatic refresh and separate image-file saving are not implemented.