Streams
Streams gives each live feed a stable operational identity above the transport endpoint. Use it when an SRT or RTMP server exists, but your team also needs a durable stream name, role, stream ID, optional host binding, and saved inspection data.
This is the record operators use to follow one feed across monitoring, playback, troubleshooting, and automation. If a listener is restarted or a server object is reused, the stream identity stays the same.
role_namedefines whether the feed is apublisherorreceiver.stream_idgives the feed a durable identifier for routing and operations.hostoptionally ties the stream to a known remote source.audio_settingsandstream_meta_datastore inspection results for later reuse.
Common stream records
Publisher on an SRT listener. Use this when a known encoder publishes into an SRT ingest point and you want a consistent stream record for dashboards and troubleshooting.
{
"name": "Main stage publisher",
"role_name": "publisher",
"stream_id": "publisher/main-stage/srt-main",
"entity_id": "680400000000000000000001",
"module_name": "MODULE_SRT_SERVERS",
"active": true
}Receiver with host binding. Use this when a return feed should be associated with a specific remote host, such as a contribution partner or field unit.
{
"name": "Remote return receiver",
"role_name": "receiver",
"stream_id": "receiver/main-stage/return-feed",
"host": "198.51.100.24",
"entity_id": "680400000000000000000001",
"module_name": "MODULE_SRT_SERVERS",
"active": true
}Publisher on an RTMP server. Use this for RTMP contribution or origin workflows where the published feed needs a stable operational identity.
{
"name": "RTMP primary publish",
"role_name": "publisher",
"stream_id": "studio/live/program",
"entity_id": "680500000000000000000001",
"module_name": "MODULE_RTMP_SERVERS",
"active": true
}If operators trigger actions from vMix, the create, start, and stop methods also include vMix Script examples.
Operational workflows
Register a feed once and keep it traceable
Create a stream record as soon as a contribution path is assigned. Use that record in dashboards, incident notes, and operator tools instead of referring only to the underlying server object.
Inspect a live source and save what matters
After a source connects, run getStreamInfo to inspect the real feed. Save the resulting audio layout or other media details in audio_settings or stream_meta_data with create, update, or setStreamInfo. This avoids rediscovering channel order, codec details, or other source-specific settings each time the feed returns.
Resolve the live address for playback or downstream routing
Use start to activate the stream, then getStreamInfo when a player, monitoring probe, or downstream workflow needs the concrete SRT or RTMP URL for the current session.
Creates a new stream row in Callaba Engine.
The stream object does not replace an SRT server or RTMP server. It sits on top of one of those entities and keeps the stream-facing identity stable: name, role, stream id, optional host, and any saved audio metadata the team should not have to rediscover later.
If your team triggers provisioning from an operator workflow, the example set below also includes vMix Script tabs for the same create call.
Examples by preset
Start with the preset that matches the transport backing the stream. Publisher and receiver rows on top of SRT listeners behave differently in practice, and RTMP-backed rows normally carry a different stream id convention again.
Workflow-oriented use cases
Register a publisher stream above an SRT server
Use this when one managed SRT listener serves multiple named publisher flows and you want those flows to stay visible as first-class rows that operators can recognize quickly.
Persist receiver-side stream identity
Use this when routed or pulled traffic should keep a stable receiver-facing identity instead of only being implied by transport state.
Store stream-specific audio metadata
Use this when channel naming, layout, or per-track meaning should live with the stream object instead of being rediscovered every time.
Use this when one SRT listener hosts a named publisher stream that operators should treat as a first-class object.
Use this when a receiver-side or returned feed should keep its own stream identity and optional host binding.
Use this when the backing transport entity is an RTMP server rather than an SRT listener.
Use this when channel layout and naming should be stored with the stream row after inspection.
Dashboard label: Name.
Human-facing name of the saved stream row.
Dashboard label: Role.
Typical product values include publisher, receiver, pusher, and puller.
Stable stream identifier stored above the backing transport entity.
Optional host binding used when the stream identity should stay tied to a concrete remote peer.
Identifier of the backing transport-side entity, for example an SRT server or RTMP server.
Module family behind the stream row. In practice this is most often MODULE_SRT_SERVERS or MODULE_RTMP_SERVERS.
Optional saved audio layout with named tracks and channels.
Dashboard label: Enable once created.
Controls whether the stream row should be active right after provisioning.
Identifiers and the saved stream identity fields.
Reference back to the transport object that owns or serves the stream.
Saved inspection output, codec notes, and optional channel mapping metadata.
Runtime flag and backend-managed timestamps.
Successful stream model responses expose success: true as a virtual field.
Returns the number of stream rows that match the current filter.
This is the count companion to getAll and is most useful when the team wants quick inventory numbers for stream rows without pulling the full list first.
Total number of stream rows visible to the authenticated user.
Returns the stream rows visible to the authenticated account.
Use this when the team needs one view of the active stream identities across SRT and RTMP-backed workflows, especially when publisher and receiver roles should stay easy to scan during operations.
Optional page size for the listing query.
Optional offset for paginated listing.
Optional sort descriptor. The dashboard store defaults to { created: 1 }.
Optional filter object used for search and role/module filtering.
The backend returns a bare array of stream rows, not a wrapped object.
Loads one saved stream row by id.
Use this before editing when you need the current stream identity, associated transport entity, or stored audio settings exactly as they are persisted.
Identifier of the stream row you want to load.
The backend returns the saved stream row with its transport link and any stored metadata.
Updates a saved stream row.
In practice this is where teams rename a stream, adjust its role-facing metadata, attach or revise saved audio settings, or correct the stream id and host pairing after live inspection.
Identifier of the stream row to update.
Updated stream identity fields.
Optional replacement audio layout or saved channel naming data.
Current runtime-enabled flag after the update.
The backend returns the updated stream row.
Stores stream information for a concrete live flow identified by stream_id, role, and port context.
Use it when the team already knows which live flow is the right one and wants its discovered details saved without manually re-entering everything through a broader edit flow.
Short stream identifier, usually the tail of the full stream id.
Full stream identifier in the product-specific role path format.
Runtime role for this stream info write, for example publisher or receiver.
Transport context used to resolve where the stream info belongs.
The backend confirms that the stream info write finished successfully.
Removes a saved stream row.
Use this when the stream identity should disappear from the operator layer and no longer be shown as an active managed stream object.
Identifier of the stream row to delete.
The backend confirms that the stream row was removed.
Starts the underlying stream runtime for the selected stream row.
This is the operational companion to stream provisioning. It matters when a saved stream identity should immediately become an active runtime flow that another team, player, or downstream step can rely on.
If this action is triggered from an operator workflow, the example set below includes a vMix Script tab as well.
Identifier of the stream row to start.
The backend returns the stream row after the start action is accepted.
Stops the runtime for the selected stream row.
Use this to take the stream offline without deleting the saved metadata and identity around it.
If this action is triggered from an operator workflow, the example set below includes a vMix Script tab as well.
Identifier of the stream row to stop.
The backend returns the stream row after the stop action is accepted.
Runs a stream inspection against a live URL and returns codec, audio, and timing details for the real upstream feed.
Use it when the team needs facts from the live signal before deciding what should be saved into the stream row or passed on to another workflow.
Live input URL that should be inspected with FFprobe.
FFprobe-style stream descriptors for video, audio, or data tracks discovered on the live input.
Codec identity for each discovered track.
Representative video properties when the input includes a video track.
Representative audio properties when the input includes audio tracks.
Top-level FFprobe format object for the inspected URL.