ListFan
Text · Free

OBS WebSocket request builder

Prepare an OBS WebSocket v5 request for a scene, mute state or input volume without connecting to OBS.

01Enter your values

Runs in your browser

Runs offline in your browser. Once the page and required files have loaded, processing needs no internet.

Map the selected action and exact scene or input name into requestData. Wrap it in a v5 op: 6 request envelope with the supplied requestId. Output JSON for a separately authenticated OBS WebSocket client.

Example

How it works

Prepare an OBS WebSocket v5 request for a scene, mute state or input volume without connecting to OBS.

op = 6; d = {requestType, requestId, requestData}

No connection is opened and no command is executed. A compatible, identified WebSocket client must send the request. Preview scene selection requires Studio Mode. Scene and input names must exist in your OBS setup. Volume is in decibels, not a percentage; supported range is −100 to +26 dB.

Your data stays yours

Inputs are processed on this page and are never sent to a server.

About this tool

Prepare an OBS WebSocket v5 request for a scene, mute state or input volume without connecting to OBS.

Map the selected action and exact scene or input name into requestData. Wrap it in a v5 op: 6 request envelope with the supplied requestId. Output JSON for a separately authenticated OBS WebSocket client.

Use tool ↑

How to use it

  1. Enter your values

    Request action · Exact scene or input name · Request ID · Mute state · Input volume · dB

  2. Calculate / generate

    Prepare an OBS WebSocket v5 request for a scene, mute state or input volume without connecting to OBS.

  3. Result

    { "op": 6, "d": { "requestType": "SetCurrentProgramScene", "requestId": "scene-1", "requestData": { "sceneName": "Camera" } } }

Calculation method

  1. Map the selected action and exact scene or input name into requestData.
  2. Wrap it in a v5 op: 6 request envelope with the supplied requestId.
  3. Output JSON for a separately authenticated OBS WebSocket client.
op = 6; d = {requestType, requestId, requestData}
Example scenario

OBS WebSocket request builder

Request action
Set program scene
Exact scene or input name
Camera
Request ID
scene-1
Mute state
Muted
Input volume · dB
Result
{
  "op": 6,
  "d": {
    "requestType": "SetCurrentProgramScene",
    "requestId": "scene-1",
    "requestData": {
      "sceneName": "Camera"
    }
  }
}

Frequently asked questions

Will generating JSON control OBS?

No connection is opened and no command is executed. A compatible, identified WebSocket client must send the request. Preview scene selection requires Studio Mode. Scene and input names must exist in your OBS setup. Volume is in decibels, not a percentage; supported range is −100 to +26 dB.

Where does my data go?

Calculations run on your device. Form inputs are not sent to a server.

Terms and definitions

Enter your values

Request action

Choose the v5 operation. Names and options are validated syntactically, not against a running OBS instance.

Choose the mode that matches the data you entered.

Options: Set program scene · Set preview scene · Set input mute · Toggle input mute · Set input volume

Exact scene or input name

Use a scene name for scene actions; use an input name for mute or volume. Case and spelling must match OBS.

Enter the source text; it is processed locally.

Request ID

A nonempty identifier, up to 100 characters, for matching a response in your external client.

Enter the source text; it is processed locally.

Mute state

Used only by SetInputMute. Other actions ignore this selection.

Choose the mode that matches the data you entered.

Options: Muted · Unmuted

Input volume · dB

Used only by SetInputVolume. Enter −100 to +26 dB; do not enter a percentage.

Enter a numerical value for this quantity.

Minimum: -100 · Maximum: 26

Result

Result

Map the selected action and exact scene or input name into requestData. Wrap it in a v5 op: 6 request envelope with the supplied requestId. Output JSON for a separately authenticated OBS WebSocket client.

Calculated from your entries using the method below.

Common mistakes and quick fixes

Input volume

Mistake: Entering 50 to mean 50 percent.

Fix: Enter a decibel value instead: 0 dB is unity gain; approximately −6.02 dB is half amplitude.

Limits and key assumptions

  • No connection is opened and no command is executed. A compatible, identified WebSocket client must send the request. Preview scene selection requires Studio Mode. Scene and input names must exist in your OBS setup. Volume is in decibels, not a percentage; supported range is −100 to +26 dB.
  • Displayed results may be rounded; rounding does not add measurement precision.

More tools

All tools