Sign in
Flows

List Flows

Return flows path headers

head/flows

Query parameters

source_idstring

Filter on source identifier.

timerangestring

A timerange of timestamps. It is represented using one or two timestamps with inclusivity and exclusivity markers.

E.g.

  • [0:0_10:0) represents 10 seconds of media starting at timestamp 0:0 and ending before 10:0.
  • (5:0_ represents a timerange starting after 5:0 and to eternity.
  • [1694429247:0_1694429248:0) is a 1 second TAI timerange starting at 2023-09-11T10:46:50.0Z UTC.
  • [1694429247:0] is an instantaneous TAI timerange at 2023-09-11T10:46:50.0Z UTC. This is equivalent to [1694429247:0_1694429247:0]. The short syntax is preferred due to ease of identification as instantaneous. Instantaneous TimeRanges cannot use exclusive markers (i.e. ( or )).
  • A [ or ] indicates that bound is inclusive, and a ( or ) indicates that bound is exclusive.

Details of the format can be found in the Timestamps in TAMS application note.

Filter on flows that overlap the given timerange.

format'urn:x-nmos:format:video' | 'urn:x-nmos:format:audio' | 'urn:x-nmos:format:data' | 'urn:x-nmos:format:multi'

Identifies the content format for a flow or source using a URN string.

Filter on flow format.

codecstring

MIME Type string.

Filter on flow codec.

labelstring

Filter on flows that have the given label.

tag.{name}string

Filter on flows that have a tag named {name} and with the given value. The {name} could contain escaped characters to allow it to be used in a URL.

tag_exists.{name}boolean

Filter on flows that have a tag named {name} regardless of value. The {name} could contain escaped characters to allow it to be used in a URL. If set to true then the presence of the tag is filtered for. If set to false then its absence is. If left out then no filtering on tag presence is performed.

frame_widthinteger

Filter on video flows that have the given frame width.

frame_heightinteger

Filter on video flows that have the given frame height.

pagestring

Opaque string used by backend to access a specific page of results. Clients should read the next URL from the Link header returned with responses, or use value of the returned X-Paging-NextKey header. If not supplied, the first page is accessed. Implementations should ensure a consistent sort order is applied to pages of results.

limitinteger

Restrict the response to the specified number of results. Implementations may specify their own default and maximum for the limit

Response

string required

Changes