v1

latestOpenAPI 3.1.0MIT OR Apache-2.02026-07-17107151343.7 KB

flows

Update a PiP composition (background + overlay inputs) on a vision mixer block.

The change is applied live to all places where the PiP is currently visible: the multiview PiP thumbnail tile, plus PGM/PVW if either bus is showing this PiP.

put/api/flows/{flow_id}/blocks/{block_id}/pip/{pip_idx}

Path parameters

flow_idstring required

Flow ID (UUID)

block_idstring required

Vision mixer block instance ID

pip_idxinteger required

PiP index (0-based)

Request body

bginteger nullable

Background input index. Omit/null for no bg.

transformsobject

Per-source crop ("zoom"/"punch-in"), keyed by input index. Applies to the source wherever it renders inside this PiP (bg or zone). Missing key = no crop. Entries for sources currently outside the PiP are retained and re-apply when the source returns (swap-zone workflow); removing a crop is explicit — omit/delete its entry while the source is present. See [crate::vision_mixer::SourceCrop].

Response

PiP config updated

bginteger nullable

messagestring required

pip_idxinteger required

transformsobject

Authoritative per-source crop state. Identical to the request except that crop fractions are clamped (see SourceCrop::clamped).