latestOpenAPI 3.1.0MIT OR Apache-2.02026-07-17107151343.7 KB
flows
Update an existing flow.
post/api/flows/{id}
Path parameters
idstring required
Flow ID (UUID)
Request body
gst_state'Null' | 'Ready' | 'Paused' | 'Playing'
GStreamer pipeline state.
These states correspond to the GStreamer GST_STATE enum.
idstring uuid required
Unique identifier for this flow
namestring required
Human-readable name
runningboolean
Whether the pipeline is actively running (data flowing).
This is the field most callers should use. It is true when the
GStreamer pipeline is in Playingor in Paused due to an
async element that has not yet completed its transition.