TamsFlowCommonOutputSettings interface

Signature:

export interface TamsFlowCommonOutputSettings

Properties

Property Type Description

Property	Type	Description
auth?	HttpAuth	(Optional) HTTP authentication scheme to use
container?	"ts" \| "mp4"	(Optional) Container/wrapping format for the written flow segments. "ts" = MPEG-TS (default), "mp4" = fragmented MP4 with init segments.
flow?	TamsFlowMetadata	(Optional) Identity and metadata for the flow registered with the store. Every field is optional and omitting the whole thing keeps the engine’s existing behaviour: freshly generated ids and a machine-derived label.
onFlowRegistered?	(registration: TamsFlowRegistration) ⇒ void	(Optional) Called once the store has accepted the flow. Distinct from `onCreate`, and worth waiting for even when you supplied the ids yourself: knowing an id is not knowing the flow exists, and anything that references it — a collection flow linking this push to its companion, say — is rejected by stores that validate those references if it is written first.
retry?	TamsRetrySettings	(Optional) How hard to try when pushing a segment fails, and how much backlog to tolerate while trying. Omit for engine defaults; individual fields may be omitted too. Note that only transient failures (5xx, timeouts, connection errors) are retried. A rejection the request itself caused (4xx) is not, and an authentication failure (401/403) additionally pauses pushing until fresh credentials are supplied — both are reported via `onNotification`.
url	string	URL of the TAMS service, eg http://example.com:12345/shiny-tams-api/

auth?

HttpAuth

(Optional) HTTP authentication scheme to use

container?

"ts" | "mp4"

(Optional) Container/wrapping format for the written flow segments. "ts" = MPEG-TS (default), "mp4" = fragmented MP4 with init segments.

flow?

TamsFlowMetadata

(Optional) Identity and metadata for the flow registered with the store.

Every field is optional and omitting the whole thing keeps the engine’s existing behaviour: freshly generated ids and a machine-derived label.

onFlowRegistered?

(registration: TamsFlowRegistration) ⇒ void

(Optional) Called once the store has accepted the flow.

Distinct from onCreate, and worth waiting for even when you supplied the ids yourself: knowing an id is not knowing the flow exists, and anything that references it — a collection flow linking this push to its companion, say — is rejected by stores that validate those references if it is written first.

retry?

TamsRetrySettings

(Optional) How hard to try when pushing a segment fails, and how much backlog to tolerate while trying. Omit for engine defaults; individual fields may be omitted too.

Note that only transient failures (5xx, timeouts, connection errors) are retried. A rejection the request itself caused (4xx) is not, and an authentication failure (401/403) additionally pauses pushing until fresh credentials are supplied — both are reported via onNotification.

url

string

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