Streaming
Toggles streaming on or off in the selected OBS instance.
Use this when the same button should start the stream if OBS is offline, or stop the stream if OBS is already live.
| Box Name | Type | Description |
|---|---|---|
| OBS | Dropdown | OBS to send this command to (if using multiple OBS) |
OBS WebSocket 5 Request: ToggleStream
No request fields — starts the stream if inactive, stops it if active.
| Response Field | Type | Description |
|---|---|---|
| outputActive | Boolean | true if the stream is now active, false if it was stopped. |
Starts streaming in the selected OBS instance.
Use this when you explicitly want the stream to go live. If OBS is already streaming, OBS may ignore the request or return an error depending on the OBS WebSocket version.
| Box Name | Type | Description |
|---|---|---|
| OBS | Dropdown | OBS to send this command to (if using multiple OBS) |
OBS WebSocket 5 Request: StartStream
No request fields — starts the configured stream output immediately. Returns an error if already streaming.
Stops the active stream in the selected OBS instance.
Use this when you explicitly want OBS to stop streaming. If OBS is not currently streaming, OBS may ignore the request or return an error depending on the OBS WebSocket version.
| Box Name | Type | Description |
|---|---|---|
| OBS | Dropdown | OBS to send this command to (if using multiple OBS) |
OBS WebSocket 5 Request: StopStream
No request fields — stops the active stream. Returns an error if OBS is not currently streaming.
Gets the current OBS stream status and saves it as an object.
| Box Name | Type | Description |
|---|---|---|
| OBS | Dropdown | OBS to send this command to, if using multiple OBS connections. |
| Save Variable As | String | Variable name to save the status object. |
Use Object Get Variable to read individual fields from the returned object.
Saved Payload:
| Variable Name | Type | Description |
|---|---|---|
| outputActive | Boolean | Whether the stream is currently live. |
| outputReconnecting | Boolean | Whether OBS is currently reconnecting to the stream server. |
| outputTimecode | String | Current stream uptime timecode (HH:MM:SS.mmm). |
| outputDuration | Number | Stream duration in milliseconds. |
| outputCongestion | Number | Congestion level of the stream (0.0–1.0). Higher = more dropped frames. |
| outputBytes | Number | Total bytes sent to the stream server. |
| outputSkippedFrames | Number | Number of skipped frames since streaming started. |
| outputTotalFrames | Number | Total frames rendered since streaming started. |
OBS WebSocket 5 Request: GetStreamStatus
No request fields.
Example SAMMI Response Object:
{
"outputActive": true,
"outputReconnecting": false,
"outputTimecode": "00:01:23.456",
"outputDuration": 83456,
"outputCongestion": 0.0,
"outputBytes": 15234567,
"outputSkippedFrames": 0,
"outputTotalFrames": 2490
}
Sends a text caption to the current OBS stream output.
| Box Name | Type | Description |
|---|---|---|
| OBS | Dropdown | OBS to send this command to, if using multiple OBS connections. |
| Text | String | The caption text to send to the stream. |
Captions are sent as accessibility closed-caption data embedded in the stream. Support depends on the streaming service and player. The stream must be active for this to have any effect.
OBS WebSocket 5 Request: SendStreamCaption
| Request Field | Type | Description |
|---|---|---|
| captionText | String | The caption text to send to the stream output. |