Actions
Network cards
1 action in the Network cards group. Each is its own JSON-RPC method, and also runs through action.run.
network.stream_onStream on network card
Chooses the network card every stream goes out on (Settings › Advanced › Network cards), and a backup for when it's unplugged, gone or without an address: for two internet connections on two cards. auto (the default) is the system's default network. Each stream connection reads the choice as it opens: a change applies from its next connection (a reconnect, or the next Go Live), and a connection that's up is never cut. When the preferred card comes back, streams move to it at their next reconnect. A card that can't be used is never a reason a stream doesn't go out: it falls back to the backup, then to the system's default network, and says why. RTMP, RTMPS, WHIP and VELoQ honor it; SRT follows the system's default network for now (the stream says so).
Parameters
auto, or the card to stream on: its key from the network topic, or its name. Give auto or none, or a card's key or name from the network topic.
none, or the card to fall back to: its key or its name. Give auto or none, or a card's key or name from the network topic.
Result
next_connection: each stream's next connection (a reconnect, or the next Go Live); one that's up is never cut.
backupstringalwaysThe backup now: none, or its key.
preferredstringalwaysThe card streams go out on now: auto, or its key.
Live state
network.preferred string
auto, or the chosen card's key. From the network topic. How to read it.
{
"jsonrpc": "2.0",
"id": 1,
"method": "network.stream_on"
}In the SDKs
Task<NetworkStreamOnResult> NetworkStreamOnAsync(CancellationToken cancellationToken = default)async def network_stream_on(self, *, backup: str | None = None, card: str | None = None) -> NetworkStreamOnResultJSON Schema
{
"params_schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"backup": {
"description": "none, or the card to fall back to: its key or its name. Give auto or none, or a card's key or name from the network topic.",
"minLength": 1,
"type": "string"
},
"card": {
"description": "auto, or the card to stream on: its key from the network topic, or its name. Give auto or none, or a card's key or name from the network topic.",
"minLength": 1,
"type": "string"
}
},
"required": [],
"type": "object"
},
"result_schema": {
"additionalProperties": false,
"properties": {
"applies": {
"description": "next_connection: each stream's next connection (a reconnect, or the next Go Live); one that's up is never cut.",
"enum": [
"next_connection"
],
"title": "NetworkApplies",
"type": "string"
},
"backup": {
"description": "The backup now: none, or its key.",
"type": "string"
},
"preferred": {
"description": "The card streams go out on now: auto, or its key.",
"type": "string"
}
},
"required": [
"preferred",
"backup",
"applies"
],
"type": "object"
}
}
