EYeyevinn
flows

Create a new flow.

Changed on

Creates a flow under the id supplied in the body, so a caller can pre-generate an id and then start the flow by it. id is a required field: to have the server assign one instead, send the nil uuid (00000000-0000-0000-0000-000000000000) and read the assigned id from the flow.id of the response. Reusing the id of an existing flow is a 409; use POST /api/flows/{id} to update that flow instead.

post/api/flows

Request

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

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 Playing or in Paused due to an async element that has not yet completed its transition.

Response

Flow created

Changes