OBS WebSocket

Control OBS Studio via WebSocket

Actions58

Streaming Actions
Recording Actions
Virtual Camera Actions
Scene Actions
Source Actions
Audio Actions
Filter Actions
Transition Actions
Media Actions
Text Source Actions
- Set Text
- Get Text
Hotkey Actions
- Trigger Hotkey
- List Hotkeys
Profile Actions
Screenshot Actions
- Take Screenshot
- Save Screenshot
General Actions

Source → Get Settings

AI-generated

Summary

Retrieve the current settings of a specified source in OBS Studio via WebSocket.

Inputs

Source Name (required) — Specify the name of the OBS source whose settings you want to retrieve.

Output shape

a single record containing the source name, kind, and its settings as key-value pairs.

Returns an error object in case of failure. The settings returned reflect the OBS input settings for the provided source name.

Discussion