TamsFlowInputSettings interface

Signature:

export interface TamsFlowInputSettings extends InputSettings<TamsFlowInputNode>

Extends: InputSettings<TamsFlowInputNode>

Properties

Property Type Description

Property	Type	Description
atEnd?	"stop" \| "follow"	(Optional) What to do on reaching the end of what currently exists. Says nothing about where playback starts — that is . `"stop"` (the default) ends the input once the flow runs out of segments; `"follow"` treats the flow as live and waits for more to be published.
auth?	HttpAuth	(Optional) HTTP authentication scheme to use
debugDumpSource?	string	(Optional) When specified dump the raw source input for debug purposes to the given directory
flowIds	string[]	IDs of all the flows to include in this input. These should be either elementary flows with overlapping timelines covering the period to play, or a flow collecting such flows
range?	{ from?: TamsPlayPosition; to?: TamsPlayEnd; }	(Optional) Which part of the flow to play. Omitted entirely is all of it, from the start — which for a long-retention live flow means starting at the oldest media retained, and never catching up. Independent of .
timeDomain?	TimeDomain	(Optional) Optional time-domain configuration. When set, the input is placed into a named coordinator and is timestamp-aligned with all other inputs sharing the same domain id within this Norsk instance. Omit for the default (uncoordinated) behaviour.
url	string	URL of the TAMS service, eg http://example.com:12345/shiny-tams-api/

atEnd?

"stop" | "follow"

(Optional) What to do on reaching the end of what currently exists. Says nothing about where playback starts — that is .

"stop" (the default) ends the input once the flow runs out of segments; "follow" treats the flow as live and waits for more to be published.

auth?

HttpAuth

(Optional) HTTP authentication scheme to use

debugDumpSource?

string

(Optional) When specified dump the raw source input for debug purposes to the given directory

flowIds

string[]

IDs of all the flows to include in this input. These should be either elementary flows with overlapping timelines covering the period to play, or a flow collecting such flows

range?

{ from?: TamsPlayPosition; to?: TamsPlayEnd; }

(Optional) Which part of the flow to play. Omitted entirely is all of it, from the start — which for a long-retention live flow means starting at the oldest media retained, and never catching up. Independent of .

timeDomain?

TimeDomain

(Optional) Optional time-domain configuration. When set, the input is placed into a named coordinator and is timestamp-aligned with all other inputs sharing the same domain id within this Norsk instance. Omit for the default (uncoordinated) behaviour.

url

string

URL of the TAMS service, eg http://example.com:12345/shiny-tams-api/