This article explains the basic overview of OBS WebSocket, how to verify OBS Studio’s compatibility, initial setup, and specific code examples<\/strong>.<\/p>\n\n\n\n Additionally, it covers simultaneous control of multiple devices and troubleshooting connection issues.<\/p>\n\n\n\n By the end of this article, you will be able to reduce operational errors during your streams and create an environment where multiple tasks can be performed with a single action.<\/p>\n\n\n\n OBS WebSocket is a plugin that integrates OBS Studio with external applications<\/strong>. It allows remote control of OBS Studio.<\/p>\n\n\n\n Internally, it uses a communication method called “WebSocket API,” enabling you to send commands to OBS Studio.<\/p>\n\n\n\n For instance, the following remote operations are possible.<\/p>\n\n\n\n Automation and remote execution can be done with just a single program or button, greatly enhancing the workflow for VTubers and streamers.<\/p>\n\n\n\n This is especially effective when you want to process multiple operations simultaneously or reduce mouse usage during streams.<\/p>\n\n\n\n To install OBS WebSocket, you need to have OBS version 28 or later installed.<\/strong><\/p>\n\n\n\n If you already use OBS, you need to check its compatibility.<\/strong><\/p>\n\n\n\n Let’s go over the basic steps for installation.<\/p>\n\n\n\n OBS WebSocket can be prepared simply by installing OBS Studio version 28 or later<\/strong>.<\/p>\n\n\n\n Since WebSocket is a built-in feature, no additional adjustments are necessary.<\/p>\n\n\n\n Previously, a plugin was required. Currently, using a plugin may cause malfunctions, so be cautious.<\/p>\n\n\n\n The latest version of OBS Studio can be downloaded for free from the official website<\/a>.<\/p>\n\n\n\n If you are already using OBS Studio, you can check compatibility through two methods: verifying the version and WebSocket feature<\/strong>.<\/p>\n\n\n\n The version can be checked with the following steps.<\/p>\n\n\n\n The red underlined section in the image that appears following the above steps indicates compatibility if it is version 28 or later.<\/p>\n\n\n\n Additionally, you can check compatibility with the following method.<\/p>\n\n\n\n If you see “WebSocket Server Settings,” it indicates compatibility.<\/p>\n\n\n\n If the version is outdated or if “Tools” does not display this option, consider installing the latest version of OBS Studio.<\/p>\n\n\n\n I’ll break down the settings needed before using OBS WebSocket into four steps<\/strong>.<\/p>\n\n\n\n This article uses Python.<\/p>\n\n\n\n Let’s look at each step in detail.<\/p>\n\n\n\n First, we need to set up OBS Studio<\/strong>.<\/p>\n\n\n\n Proceed with the following steps.<\/p>\n\n\n\n Once the settings screen opens, move on to STEP2.<\/p>\n\n\n\n Next, configure the settings to enable the feature.<\/p>\n\n\n\n Check the box to “Enable WebSocket server”<\/strong>.<\/p>\n\n\n\n Then, proceed to STEP3.<\/p>\n\n\n\n In STEP3, you will perform server configuration<\/strong>.<\/p>\n\n\n\n First, you need to set the port.<\/p>\n\n\n\n The server port can stay at the default setting, but you will need to change it if it is being used by other applications.<\/p>\n\n\n\n Next, check the box for “Enable authentication” and set a password.<\/p>\n\n\n\n For testing purposes, it might be more convenient to keep authentication disabled; however, for actual usage, enable it to enhance security.<\/p>\n\n\n\n The password will not be visible as shown in the image below, but you can see it by clicking “Show connection info.”<\/p>\n\n\n\n The password will be used later when integrating with external systems.<\/p>\n\n\n\n Python is a programming language used to automate streaming operations and API integration, serving as a bridge between OBS Studio and external tools.<\/p>\n\n\n\n To issue remote control commands using Python<\/strong>, follow the steps below for installation.<\/p>\n\n\n\n With that, your preparations are complete.<\/p>\n\n\n\n Note that during installation, if you do not check “Add python.exe to PATH” on the initial screen, the command “pip install obs-websocket-py” will not work properly.<\/p>\n\n\n\n To remotely control OBS Studio, you will need to write code using tools like Visual Studio Code (VS Code).<\/p>\n\n\n\n In this section, I will introduce four specific steps for remote control using code<\/strong>, along with the basic information for operating OBS WebSocket.<\/p>\n\n\n\n Let’s take a detailed look at how to use it.<\/p>\n\n\n\n To control it remotely, you need to include the IP, port, and authentication password in your code<\/strong>.<\/p>\n\n\n\n First, let’s write the following code.<\/p>\n\n\n\n The above code will allow you to establish a stable connection with OBS Studio.<\/p>\n\n\n\n Using the command to retrieve the scene list<\/strong>, you can grasp the structure of scenes in OBS Studio.<\/p>\n\n\n\n Append the following code to the above basic information in the section marked “Insert your remote operation code here.”<\/p>\n\n\n\n When you execute this in VS Code, you will receive a response showing the three scenes registered in OBS Studio (Test Registration 1, Test Registration 2, Test Registration 3) as follows.<\/p>\n\n\n\n This allows you to check the names of the scenes registered in OBS Studio, confirming your current OBS Studio configuration.<\/p>\n\n\n\n Next, let’s retrieve the source information registered in a scene<\/strong>.<\/p>\n\n\n\n In VS Code, write the following code in the “Insert your remote operation code here” section.<\/p>\n\n\n\n When you run the above code, you will receive a response showing the sources (Window Capture, Browser, Media Source) registered in Test Registration 1 as follows.<\/p>\n\n\n\n This allows you to grasp all the source names registered in Test Registration 1.<\/p>\n\n\n\n With a command, you can also retrieve the IDs assigned to the sources<\/strong>.<\/p>\n\n\n\n Write the following code in the “Insert your remote operation code here” section in VS Code.<\/p>\n\n\n\n When you execute this, you will receive the IDs of the sources registered in Test Registration 1 as follows.<\/p>\n\n\n\n The above source IDs correspond to the following source names obtained in “Step 2: Retrieve Sources of a Scene.”<\/p>\n\n\n\n By retrieving the source IDs, coding and operations become much easier.<\/p>\n\n\n\n You can use the retrieved source IDs to toggle the visibility of sources<\/strong>.<\/p>\n\n\n\n To toggle visibility, write the following code in the “Insert your remote operation code here” section in VS Code.<\/p>\n\n\n\n Setting the value of “scene_Enabled” to True will display it, and setting it to False will hide it.<\/p>\n\n\n\n There are many other codes available to remotely control OBS Studio, so feel free to write your own unique code.<\/p>\n\n\n\n A list of commands available in OBS WebSocket can be found on the GitHub<\/strong><\/a> dedicated page, specifically in docs > generated > protocol.md<\/strong>.<\/p>\n\n\n\n The protocol.md file defines all the command structures, names, and usage instructions.<\/p>\n\n\n\n Below are some of the representative command examples.<\/p>\n\n\n\nWhat is OBS WebSocket?<\/h2>\n\n\n\n
\n
How to Install OBS WebSocket<\/h2>\n\n\n\n
Install OBS version 28 or later<\/h3>\n\n\n\n
How to Check Compatibility if You Use OBS<\/h3>\n\n\n\n
\n
\n
![\"\"](\"https:\/\/streamer-magazine-en.lolipop.io\/wp-content\/uploads\/2025\/08\/image-2.png\")
<\/figure>\n\n\n\n\n
4 Essential Steps for Configuring OBS WebSocket<\/h2>\n\n\n\n
\n
STEP1: Open the settings menu in OBS<\/h3>\n\n\n\n
\n
\n
STEP2: Enable the WebSocket server<\/h3>\n\n\n\n
STEP3: Configure the server settings<\/h3>\n\n\n\n
STEP4: Install Python<\/h3>\n\n\n\n
\n
![\"\"](\"https:\/\/streamer-magazine-en.lolipop.io\/wp-content\/uploads\/2025\/08\/image-3.png\")
<\/figure>\n\n\n\n\n
![\"\"](\"https:\/\/streamer-magazine-en.lolipop.io\/wp-content\/uploads\/2025\/08\/image-4.png\")
<\/figure>\n\n\n\n\n
![\"\"](\"https:\/\/streamer-magazine-en.lolipop.io\/wp-content\/uploads\/2025\/08\/image-5.png\")
<\/figure>\n\n\n\nSpecific Steps to Utilize OBS WebSocket<\/h2>\n\n\n\n
Basic Information for Operating OBS WebSocket<\/h3>\n\n\n\n
<\/code><\/pre>\n\n\n\nfrom obswebsocket import obsws, requests\n# Below is the connection information for OBS Studio\nhost = \"localhost\" # Use localhost if on the same PC\nport = 4455 # Specify the port\npassword = \"your_password\" # Specify the password\nws = obsws(host, port, password)\nws.connect()\nprint(\"success\")\n# Insert your remote operation code here\nws.disconnect()\nprint(\"finish\")<\/code><\/pre>\n\n\n\nStep 1: Retrieve the List of Scenes<\/h3>\n\n\n\n
scenes = ws.call(requests.GetSceneList())\nprint(\"Scene List:\")\nif scenes.status: # Check if retrieved successfully\n for scene in scenes.getScenes():\n print(f\"Scene Name: {scene['sceneName']}\")<\/code><\/pre>\n\n\n\nScene List:\nScene Name: Test Registration 3\nScene Name: Test Registration 2\nScene Name: Test Registration 1<\/code><\/pre>\n\n\n\nStep 2: Retrieve Sources of a Scene<\/h3>\n\n\n\n
scene_name = \"Test Registration 1\" # Use the scene name you want to retrieve sources from\nsources = ws.call(requests.GetSceneItemList(sceneName=scene_name))\nprint(\"Source List:\")\nfor source in sources.getSceneItems():\n print(f\"Source Name: {source['sourceName']}\")<\/code><\/pre>\n\n\n\nSource List:\nSource Name: Window Capture\nSource Name: Browser\nSource Name: Media Source<\/code><\/pre>\n\n\n\nStep 3: Retrieve Source IDs<\/h3>\n\n\n\n
scene_name = \"Test Registration 1\" # Use the scene name from which you want to get source IDs\nsources = ws.call(requests.GetSceneItemList(sceneName=scene_name))\nprint(\"Source ID List:\")\nfor source in sources.getSceneItems():\n print(f\"Source ID: {source['sceneItemId']}\")<\/code><\/pre>\n\n\n\nSource ID List:\nSource ID: 11\nSource ID: 12\nSource ID: 13<\/code><\/pre>\n\n\n\n\n
Step 4: Toggle Source Visibility<\/h3>\n\n\n\n
scene_name = \"Test Registration 1\" # The scene containing the target source\nsid = 13 # The ID of the target source\nscene_Enabled = False # True=visible, False=hidden\nws.call(requests.SetSceneItemEnabled(sceneName=scene_name, sceneItemId=sid, sceneItemEnabled=scene_Enabled))<\/code><\/pre>\n\n\n\nCommands Available in OBS WebSocket<\/h2>\n\n\n\n
![\"\"](\"https:\/\/streamer-magazine-en.lolipop.io\/wp-content\/uploads\/2025\/08\/image-6.png\")
<\/figure>\n\n\n\n![\"\"](\"https:\/\/streamer-magazine-en.lolipop.io\/wp-content\/uploads\/2025\/08\/image-7.png\")
<\/figure>\n\n\n\n![\"\"](\"https:\/\/streamer-magazine-en.lolipop.io\/wp-content\/uploads\/2025\/08\/image-8.png\")
<\/figure>\n\n\n\n![\"\"](\"https:\/\/streamer-magazine-en.lolipop.io\/wp-content\/uploads\/2025\/08\/image-9.png\")
<\/figure>\n\n\n\n![\"\"](\"https:\/\/streamer-magazine-en.lolipop.io\/wp-content\/uploads\/2025\/08\/image-10.png\")
<\/figure>\n\n\n\n![\"\"](\"https:\/\/streamer-magazine-en.lolipop.io\/wp-content\/uploads\/2025\/08\/image-11.png\")
<\/figure>\n\n\n\n![\"\"](\"https:\/\/streamer-magazine-en.lolipop.io\/wp-content\/uploads\/2025\/08\/image-12.png\")
<\/figure>\n\n\n\n