TAMS Ingest (pull)

Connects to a remote TAMS API and ingests as a real-time stream

Component Configuration

Option Description Required Environment override

id

A unique identifier for the component instance

✓

displayName

The name shown in the Studio UI of this component

✓

flowIds

Flows to ingest — select from the TAMS server, or add IDs manually (default: [])

✗

url

Base URL of the TAMS API

✓

<COMPONENT_ID>_URL

startAt

Where to start playing within the flow (default: {"kind":"start"})

✗

endAt

Where to stop playing (default: to the end of the flow) (default: {"kind":"open"})

✗

atEnd

What to do when playback reaches the end of what the flow currently holds (default: "stop")

✗

auth

Authentication settings

✓

<COMPONENT_ID>_AUTH

initialState

The ingest state of this component on start-up (default: "enabled")

✗

<COMPONENT_ID>_INITIALSTATE

streamMappings

Configure which streams to accept from this input

✗

sourceRecordingDirectory

Record each source's transport stream, exactly as it arrives, to this directory: one <source name>.ts file per connected stream. An absolute path on the Norsk engine's filesystem, which must already exist. Leave unset to record nothing.

✗

sourceRecordingMode

Raw writes the bytes as they arrive; segmented cuts them into segments, each led by a copy of the source's PAT and PMT, so each plays on its own. (default: "raw")

✗

notes

Additional notes about this component

✗

Options with an environment override can be set when Studio starts, without editing the workflow. <COMPONENT_ID> is this component’s id in your workflow, uppercased, with spaces and dashes replaced by underscores and other punctuation removed — a component named SRT Input reads SRT_INPUT_PORT. Renaming a component changes its id, and so changes these variable names.

Start At (Start of flow)

Option Description Required

kind

"start"

✓

Start At (Absolute timestamp)

Option Description Required

kind

"absolute"

✓

timestamp

Absolute TAMS timestamp, seconds:nanoseconds

✓

Start At (Offset from start)

Option Description Required

kind

"afterStart"

✓

seconds

Seconds after the start of the flow (default: 0)

✗

Start At (Behind live edge)

Option Description Required

kind

"beforeEnd"

✓

seconds

Seconds before the live edge (keep a few seconds' headroom) (default: 10)

✗

End At (End of flow)

Option Description Required

kind

"open"

✓

End At (Absolute timestamp)

Option Description Required

kind

"absolute"

✓

timestamp

Absolute TAMS timestamp, seconds:nanoseconds

✓

End At (Offset from start)

Option Description Required

kind

"afterStart"

✓

seconds

Seconds after the start of the flow (default: 0)

✗

End At (Behind live edge)

Option Description Required

kind

"beforeEnd"

✓

seconds

Seconds before the live edge (default: 0)

✗

End At (Duration)

Option Description Required

kind

"duration"

✓

seconds

Length to play, in seconds, from wherever the range begins (default: 30)

✗

Auth (None)

Option Description Required

kind

"none"

✓

Auth (Basic)

Option Description Required

kind

"basic"

✓

username

Username

✓

password

Password

✓

Auth (Bearer token)

Option Description Required

kind

"bearer"

✓

token

Token

✓

Auth (OAuth2 (OIDC) Credentials)

Option Description Required

kind

"oidc"

✓

url

OIDC Discovery URL

✓

clientId

Client ID

✓

secret

Client Secret

✓

Tags: ingest