Introducing the flows API

❗️

Please do not delete!

✏️

This is a beta feature and may have incomplete functionality or bugs; breaking changes may be introduced.

The flows API offers centralized control and monitoring of content flowing between sources and destinations.

The flows API is built on top of the Infrastructure API and - if relevant - the Fleet API. It relies on sites, networks and - again, if relevant - devices to be configured appropriately.

Use of the flows API is made up of four core operations:

  1. Define the content that you intend to carry through this system (e.g. the output of a specific camera) and the sources (multiple for high availability) that the content is available from.
  2. Define the destinations to which the processed content will be sent.
  3. Define the flow transforms that will be applied to the content (e.g. a JPEG-XS to h.265 transcode).
  4. Define the flows that creates the transformed and directed flow of media.