v1

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

Update a property on a pad in a running pipeline element.

Allows live modification of pad properties while the pipeline is running. This is essential for elements like compositor, glvideomixer, and audiomixer where you need to control individual input pad properties. Common pad properties include:

  • alpha: Opacity/transparency (0.0 to 1.0)
  • xpos, ypos: Position in pixels
  • width, height: Size in pixels
  • zorder: Layer order (higher values are on top)
patch/api/flows/{flow_id}/elements/{element_id}/pads/{pad_name}/properties

Path parameters

flow_idstring required

Flow ID (UUID)

element_idstring required

Element instance ID

pad_namestring required

Pad name (e.g., sink_0, sink_1)

Request body

property_namestring required

The name of the property to update

Response

Pad property updated successfully

element_idstring required

The element ID

pad_namestring required

The pad name

propertiesobject required

Current property values