📖 OBS Commands Reference

Complete reference for all OBS WebSocket commands available through the bridge

← Back to Dashboard

🔴 Streaming Control

GetStreamStatus
Gets the status of the stream output
GET Streaming 
POST /api/connections/{id}/command
{
  "requestType": "GetStreamStatus"
}

Response Fields:

outputActive (boolean)
Whether the stream is active
outputDuration (number)
Current stream duration in milliseconds
StartStream
Starts the stream output
POST Streaming 
POST /api/connections/{id}/command
{
  "requestType": "StartStream"
}
StopStream
Stops the stream output
POST Streaming 
POST /api/connections/{id}/command
{
  "requestType": "StopStream"
}
ToggleStream
Toggles the stream output (start if stopped, stop if started)
POST Streaming 
POST /api/connections/{id}/command
{
  "requestType": "ToggleStream"
}

⏺️ Recording Control

GetRecordStatus
Gets the status of the record output
GET Recording 
POST /api/connections/{id}/command
{
  "requestType": "GetRecordStatus"
}
StartRecord
Starts recording
POST Recording 
POST /api/connections/{id}/command
{
  "requestType": "StartRecord"
}
StopRecord
Stops recording
POST Recording 
POST /api/connections/{id}/command
{
  "requestType": "StopRecord"
}
PauseRecord
Pauses the current recording
POST Recording 
POST /api/connections/{id}/command
{
  "requestType": "PauseRecord"
}
ResumeRecord
Resumes the current recording
POST Recording 
POST /api/connections/{id}/command
{
  "requestType": "ResumeRecord"
}

🎬 Scene Management

GetSceneList
Gets an array of all scenes
GET Scenes 
POST /api/connections/{id}/command
{
  "requestType": "GetSceneList"
}
GetCurrentProgramScene
Gets the current program scene
GET Scenes 
POST /api/connections/{id}/command
{
  "requestType": "GetCurrentProgramScene"
}
SetCurrentProgramScene
Sets the current program scene
POST Scenes 
POST /api/connections/{id}/command
{
  "requestType": "SetCurrentProgramScene",
  "requestData": {
    "sceneName": "Scene 2"
  }
}

Parameters:

sceneName (string, required)
Name of the scene to set as current
CreateScene
Creates a new scene
POST Scenes 
POST /api/connections/{id}/command
{
  "requestType": "CreateScene",
  "requestData": {
    "sceneName": "New Scene"
  }
}

Parameters:

sceneName (string, required)
Name for the new scene

⚙️ General

GetVersion
Gets OBS and plugin version information
GET General 
POST /api/connections/{id}/command
{
  "requestType": "GetVersion"
}
GetStats
Gets OBS statistics (CPU, memory, FPS, etc.)
GET General 
POST /api/connections/{id}/command
{
  "requestType": "GetStats"
}
GetHotkeyList
Gets an array of all hotkey names
GET General 
POST /api/connections/{id}/command
{
  "requestType": "GetHotkeyList"
}
TriggerHotkeyByName
Triggers a hotkey by name
POST General 
POST /api/connections/{id}/command
{
  "requestType": "TriggerHotkeyByName",
  "requestData": {
    "hotkeyName": "OBSBasic.StartStreaming"
  }
}

Parameters:

hotkeyName (string, required)
Name of the hotkey to trigger

🎥 Sources

GetSourceActive
Gets the active and show state of a source
GET Sources 
POST /api/connections/{id}/command
{
  "requestType": "GetSourceActive",
  "requestData": {
    "sourceName": "Webcam"
  }
}

Parameters:

sourceName (string, required)
Name of the source
GetSceneItemList
Gets a list of all scene items in a scene
GET Sources 
POST /api/connections/{id}/command
{
  "requestType": "GetSceneItemList",
  "requestData": {
    "sceneName": "Scene 1"
  }
}

Parameters:

sceneName (string, required)
Name of the scene
SetSceneItemEnabled
Sets the enable state of a scene item
POST Sources 
POST /api/connections/{id}/command
{
  "requestType": "SetSceneItemEnabled",
  "requestData": {
    "sceneName": "Scene 1",
    "sceneItemId": 1,
    "sceneItemEnabled": true
  }
}

Parameters:

sceneName (string, required)
Name of the scene
sceneItemId (number, required)
ID of the scene item
sceneItemEnabled (boolean, required)
New enable state