Jump to content

Featured Replies

Posted
comment_4

🔍 General Description

The OBS Control mod allows seamless interaction with OBS Studio via the official WebSocket API. It lets you remotely control streaming, recording, scene switching, and audio sources – directly from within the aiostool environment.
This mod is ideal for automation workflows, bot triggers, or external control systems integrated into your stream setup.


⚠️ Requirements

  • OBS Studio with the obs-websocket plugin installed
    (OBS v28+ includes it by default)

  • OBS WebSocket server must be running and accessible (e.g. ws://localhost:4455)

  • A config file named obs-config.json must be present in the mod directory

  • OBS must be running when commands are triggered


🛠️ Configuration

Create a file named obs-config.json in your mod’s config folder with the following structure:

{
	"host": "ws://localhost:4455",
	"password": "YOUR_PASSWORD"}

This tells the mod how to connect to your OBS WebSocket server.


⚙️ Functions

Function

Description

main

Initializes and tests the WebSocket connection to OBS.

switchScene

Switches to a specific OBS scene. Requires scene as parameter.

startRecording

Starts local recording in OBS.

stopRecording

Stops the current recording session.

startStream

Starts the live stream.

stopStream

Stops the ongoing stream.

muteSource

Mutes a specific audio input. Requires source as parameter.

unmuteSource

Unmutes a muted audio input. Requires source as parameter.

refreshBrowserSource

Refreshes a browser source. Requires source as parameter.


💬 Example Commands

🎬 Switch Scene

Key

Value

script

obsControl

function

switchScene

scene

Intro


🔇 Mute Source

Key

Value

script

obsControl

function

muteSource

source

Microphone


🌐 Refresh Browser Source

Key

Value

script

obsControl

function

refreshBrowserSource

source

OverlayBrowser

@BlackRider
Founder · Lead Developer · System Administrator
Development · Infrastructure · Feature Design · Community & Project Management
🔗 My links & socials

Join the conversation

You can post now and register later. If you have an account, sign in now to post with your account.

Guest
Reply to this topic...