v1

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

flows

Get the current runtime state of a vision mixer block.

Reflects the live overlay state — bus inputs, PiP visibility, FTB, DSK, overlay alpha, per-PiP composition. Clients use this on (re)connect to reconcile state; subsequent changes flow over the VisionMixerStateChanged WebSocket event.

get/api/flows/{flow_id}/blocks/{block_id}/state

Path parameters

flow_idstring required

Flow ID (UUID)

block_idstring required

Vision mixer block instance ID

Response

Current vision mixer state

dsk_enabledboolean[] required

DSK on/off state, one entry per configured DSK input.

ftb_activeboolean required

Whether Fade to Black is currently active.

fx_availableboolean

Whether the shader FX engine is built into this pipeline (GPU backend with Shader FX enabled). When false, effect endpoints reject and shader transitions downgrade to Fade.

overlay_alphanumber double required

Multiview overlay alpha (0.0–1.0).

preview_inputinteger nullable

Current PVW input. None when PVW is a PiP source.

preview_pipinteger nullable

PiP index currently displayed on PVW, or None if PVW is an input.

program_inputinteger nullable

Current PGM input. None when PGM is a PiP source.

program_pipinteger nullable

PiP index currently displayed on PGM, or None if PGM is an input.