EYeyevinn
flows

Get the current runtime state of a vision mixer block.

Changed on

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

Request

  • The document declares no server URL.
  • Auth
    none declared

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.

input_media_age_msinteger[]

Milliseconds since each input last delivered a frame to the mixer (length = configured num_inputs). None for an input that has never delivered one. A value that keeps growing marks a frozen input: the compositor repeats its last frame, so a source that stopped looks the same on air as one that is motionless. It measures arrival, not display: an input whose timestamps jump backwards freezes on air for the length of the jump while its age stays low. Every input ageing together means the mixer's output stalled, not that every source stopped.

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.

Changes

  • 63c8e1da2a94Revision changes
    • info

      added the optional property to the response with the status

  • b6263c0a953bRevision changes
    • breaking

      added subschema #4 subschema #16 to the / response property oneOf list for the response status

    • breaking

      added subschema #4 subschema #16 to the response property oneOf list for the response status

    • info

      removed subschema #4 from the / response property oneOf list for the response status

    • info

      removed subschema #4 from the response property oneOf list for the response status