v1

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

flows

Update a property on a running pipeline element.

Allows live modification of element properties while the pipeline is running. Only properties marked as mutable in the current pipeline state can be updated. The property mutability flags (mutable_in_playing, etc.) can be checked via the element info endpoint.

patch/api/flows/{flow_id}/elements/{element_id}/properties

Path parameters

flow_idstring required

Flow ID (UUID)

element_idstring required

Element instance ID

Request body

property_namestring required

The name of the property to update

ramp_msinteger nullable

Optional ramp duration in milliseconds. Currently honored for audio volume-element volume and mute updates — when set, volume is interpolated per-sample over the given duration (anti-zipper / fade) and mute=true is preceded by a fade-out of the same length while mute=false is followed by a 0→pre_mute fade-in. Useful for broadcast-style on-air / off-air route transitions (e.g. 500 ms). When omitted, a short default ramp is used for volume/mute; other properties are set immediately.

Response

Property updated successfully

element_idstring required

The element ID

propertiesobject required

Current property values