Sign in

v1

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

Update one or more exposed properties on a block instance live.

Properties are expressed in block-level (user-facing) units — e.g. {"ch1_pfl": true, "fader_db": -3.0}. The backend resolves each name to its underlying GStreamer element via the block definition's PropertyMapping, applies the declared transform (bool_to_volume, db_to_linear, …), and writes through the standard live-property path (so ramp_ms produces the usual anti-click fade where applicable). ramp_ms_overrides lets the caller pin a different ramp duration for individual properties in the same batch — useful for crossfades where one fader rises while another falls at the same rate but other properties move instantly.

Only properties marked live: true are accepted. Unknown, non-live, or type-mismatched entries are returned in the rejected map without aborting the rest of the batch.

patch/api/flows/{flow_id}/blocks/{block_id}/properties

Path parameters

flow_idstring required

Flow ID (UUID)

block_idstring required

Block instance ID

Request body

propertiesobject required

Map of exposed property name → new value (in block-level units).

ramp_msinteger nullable

Optional default ramp duration in ms applied to every property in this batch (honored for volume-element writes — produces anti-click fades for bool/dB toggles that map to a volume property). Acts as the fallback when no per-property override is set in ramp_ms_overrides.

ramp_ms_overridesobject nullable

Optional per-property ramp duration overrides, keyed by exposed property name. When a property in properties has an entry here, that duration is used instead of the batch-level ramp_ms. Entries for names not present in properties are silently ignored. Only effective for properties whose underlying write goes through the ramp path (currently audio volume-element volume and mute); for other properties the override is accepted but has no effect, matching the behavior of the batch-level ramp_ms. Enables crossfades where individual faders ramp at different rates within a single PATCH.

Response

Block properties applied (see rejected for partial failures)

block_idstring required

The block instance ID

propertiesobject required

Current values (in block-level units, inverse-transformed from the live elements)

rejectedobject

Names of properties that could not be applied, mapped to a short reason. Empty on full success. Only populated on PATCH.