EYeyevinn
flows

Update an existing flow (PUT alias).

Changed on

This is an alias for the POST update endpoint, provided for RESTful API conventions.

put/api/flows/{id}

Request

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

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

Response

Flow updated

Changes

  • 92e85e5fb1dbRevision changes
    • warning

      added the new tai enum value to the // response property for the response status

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new tai enum value to the request property /

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

  • 10a3115dc8caRevision changes
    • info

      added the new optional request property /

    • info

      added the optional property // to the response with the status