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 |
✓ |
|
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 |
✓ |
|
initialState |
The ingest state of this component on start-up (default: "enabled") |
✗ |
|
streamMappings |
Configure which streams to accept from this input |
✗ |
|
debugDumpSource |
Debug only — dump the raw source input to this directory. Leave unset in production. |
✗ |
|
notes |
Additional notes about this component |
✗ |
|
Options with an environment override can be set when Studio starts, without
editing the workflow. |
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 (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) |
✗ |