Resource icon

Free Command line tool for obs-websocket plugin (Windows) 2019-04-07

A small tool to enable control of OBS Studio via command line.

Requires obs-websocket plugin (included): https://obsproject.com/forum/resources/obs-websocket-remote-control-of-obs-studio-made-easy.466/

How to install:
1. Download OBSCommand_v1.4.3.zip
2. Extract the file
3. Download and install the latest version of websocket-plugin from https://github.com/Palakis/obs-websocket/releases
4. In OBS Studio menu, go to "Tools"->"Websocket server settings"
5. Uncheck "Enable System Tray Alerts" (unless you want to get spammed)
6. Use OBSCommand.exe to control OBS Studio local or from a remote machine


Usage:
OBSCommand.exe /server=127.0.0.1:4444 /password=xxxx /profile=myprofile /scene=myscene /hidesource=myscene/mysource /showsource=myscene/mysource /toggleaudio=myaudio /mute=myaudio /unmute=myaudio /setvolume=mysource,volume,delay /startstream /stopstream /startrecording /stoprecording /command=mycommand,myparam


Note: If Server is omitted, default 127.0.0.1:4444 will be used.
Use quotes if your item name includes spaces.
Password can be empty if no password is set in OBS Studio.

You can use the same option multiple times.
If you use Server and Password, those must be the first 2 options!



Examples:
OBSCommand.exe /scene=myscene
OBSCommand.exe /toggleaudio="Desktop Audio"
OBSCommand.exe /mute=myAudioSource
OBSCommand.exe /unmute="my Audio Source"
OBSCommand.exe /setvolume=Mic/Aux,0,50
OBSCommand.exe /setvolume=Mic/Aux,100
OBSCommand.exe /stopstream
OBSCommand.exe /profile=myprofile /scene=myscene /showsource=mysource
OBSCommand.exe /showsource=mysource
OBSCommand.exe /hidesource=myscene/mysource
OBSCommand.exe /showsource="my scene" "my source"
OBSCommand.exe /command=SaveReplayBuffer


Code:
Options:
--------

/server=127.0.0.1:4444            define server address and port
  Note: If Server is omitted, default 127.0.0.1:4444 will be used.
/password=xxxx                    define password (can be omitted)
/profile=myprofile                switch to profile "myprofile"
/scene=myscene                    switch to scene "myscene"
/hidesource=myscene/mysource      hide source "scene/mysource"
/showsource=myscene/mysource      show source "scene/mysource"
  Note:  if scene is omitted, current scene is used
/toggleaudio=myaudio              toggle mute from audio source "myaudio"
/mute=myaudio                     mute audio source "myaudio"
/unmute=myaudio                   unmute audio source "myaudio"
/setvolume=myaudio,volume,delay   set volume of audio source "myaudio"
                                  volume is 0-100, delay is in milliseconds
                                  between steps (min. 10, max. 1000) for fading
  Note:  if delay is omitted volume is set instant
/startstream                      starts streaming
/stopstream                       stop streaming
/startrecording                   starts recording
/stoprecording                    stops recording
/command=mycommand,myparam        issues user command,parameter (optional)
                                  (see list of commands below)
List of commands:
https://github.com/Palakis/obs-websocket/blob/4.x-current/docs/generated/protocol.md
Author
FSC
Downloads
1,171
First release
Last update
Rating
5.00 star(s) 1 ratings

Latest updates

  1. Update 1.4.3

    - Changed syntax of /command now using comma instead of space as separator between command and...
  2. Update 1.4.2

    - Added universal /command option - Updated included obs-websocket installer to version 4.5.1
  3. Update 1.4.1

    - Fixed remote server issue

Latest reviews

great idea!
very useful thanks
Top