Free Command line tool for obs-websocket plugin (Windows) 1.6.3

[PoWeR-Ding]

for OBS below version 28
for OBSCommand_v1.5.7

OBSCommand.exe /command=SetCurrentSceneCollection,sc-name="123"

Why is this command always errr

 

[FSC]

View attachment 97041
View attachment 97043

OBSCommand.exe /command=SetStreamSettings,settings=server='srt://pushtx.surgerycast.com:9000?streamid=#!::h=pushtx.surgerycast.com%2Cr=onelive/11009599-BtBuqqFfn'


Can be passed in normally in cmd.exe
However, after being passed in, OBS cannot connect to the server using this str address.

server:srt://pushtx.surgerycast.com:9000?streamid=#!::h=pushtx.surgerycast.com%2Cr=onelive/11009599-BtBuqqFfn
key:r=onelive/11009599-BtBuqqFfn

you can try to use /sendjson, command should look something like this (sorry can't test it):
/sendjson="SetStreamSettings={'settings': {'server': 'srt://pushtx.surgerycast.com:9000?streamid=#!::h=pushtx.surgerycast.com,r=onelive/11009599-BtBuqqFfn'}}"

 

[FSC]

for OBS below version 28
for OBSCommand_v1.5.7

OBSCommand.exe /command=SetCurrentSceneCollection,sc-name="123"

Why is this command always errr

what is the error?

 

[Overlookedfile]

I feel like a complete idiot, and I'm not sure whether to comment here or on VoiceMacro, but the gist is this:

I'm attempting to get OBS studio, via OBScommand, to save the replay buffer when VoiceMacro recognizes a specific voice command. VM appears to be doing its job, as I have a tone associated with it when it fires and I reliably hear that when the command is spoken, but nothing seems to happen in OBS Studio. Am I supposed to connect OBSc and the OBS web socket in some manner and, if so, how? What am I doing wrong? OBSc is "installed" on my desktop, if that makes any difference.

OBS version 29.1.3 (x64) on Windows 11
OBScommand version 1.6.3 (run as admin)
VoiceMacro version 1.4 (run as admin)

Screenshots attached

 

[FSC]

I feel like a complete idiot, and I'm not sure whether to comment here or on VoiceMacro, but the gist is this:

I'm attempting to get OBS studio, via OBScommand, to save the replay buffer when VoiceMacro recognizes a specific voice command. VM appears to be doing its job, as I have a tone associated with it when it fires and I reliably hear that when the command is spoken, but nothing seems to happen in OBS Studio. Am I supposed to connect OBSc and the OBS web socket in some manner and, if so, how? What am I doing wrong? OBSc is "installed" on my desktop, if that makes any difference.

OBS version 29.1.3 (x64) on Windows 11
OBScommand version 1.6.3 (run as admin)
VoiceMacro version 1.4 (run as admin)

Screenshots attached

Make sure you have enabled OBS Websocket server in OBS WebSocket Server settings

Also, you don't need to use "OBSCommand" as an argument for OBSCommand.exe in VoiceMacro OpenFile action, this is not necessary and will just be ignored by OBSCommand, all the YT videos seem to copy from each other and have this wrong. If all is working you can set Window Style to "Hidden" so you won't see a popup of the command line Window.

 

[Overlookedfile]

So, apparently the difference is in whether the video is recording or not? Within OBS I can press the "Save Replay" button while the buffer is running and it will save just that video even if the overal recording is not turned on. It appears that OBSc/VM will only save the replay buffer if the overall recording is also on. It's not the worst thing ever to have that be the case, but given the amount of video my use-case already requires, it'd be fantastic if just the buffer could be saved instead of a whole video.

Any help or direction you could offer would be most appreciated. Oh, and thank you very, very much for both applications, whether you're able to help with that snag or not.

 

[FSC]

You're welcome, I'm glad my apps are useful for you. Sorry I can't help a lot with OBS itself, I'm not a streamer and don't have that much experience with it. All the available commands from OBS Websocket are here if there is no command for what you can do on the OBS UI, you might have to address this to OBS/OBS Websocket devs. OBS Websocket dev's github is here.

 

[tim.calderwood]

We are using OBSCommand.exe to start and stop recordings of our test automation scripts. We are running into an issue of not knowing if the OBSCommand request fails or not. We tried using the returned error code, however, it seems to always return 0. Here is our batch script. If the command fails, IE OBS is not running or web service is disabled, we should get Error Found, but we dont. Is there a workaround for this?

rem Stop the Video Recording
echo off
cd C:\\Program Files\\obs-studio\\bin\\64bit
OBSCommand.exe /stoprecording
if errorlevel 0 goto stop_recording
else goto error_found

:stop_recording
ECHO Stop Recording
ECHO OBS was recording, trying to stop recording. Returned error code of: %ERRORLEVEL%
goto :eof

:error_found
ECHO Error Found
ECHO An error was found w/ error code of: %ERRORLEVEL%
goto :eof

 

[tim.calderwood]

We are using OBSCommand.exe to start and stop recordings of our test automation scripts. We are running into an issue of not knowing if the OBSCommand request fails or not. We tried using the returned error code, however, it seems to always return 0. Here is our batch script. If the command fails, IE OBS is not running or web service is disabled, we should get Error Found, but we dont. Is there a workaround for this?

After serveral hours of fun, here is what I have got to work

To stop a recording

cd C:\\Program Files\\obs-studio\\bin\\64bit || exit 0
OBSCommand.exe /stoprecording | findstr "Ok 501" || exit 1
echo OBSCommand.exe /stoprecording will return
echo * Ok - Stopped recording
echo * 501 - Not recording, nothing to stop
echo * Everything else is an error

To start a recording

del /Q /F %userprofile%\\Videos\\*.mkv || exit 0
cd C:\\Program Files\\obs-studio\\bin\\64bit || exit 0
OBSCommand.exe /startrecording | findstr "Ok 500" || exit 1
echo OBSCommand.exe /startrecording will return
echo * Ok - Started recording
echo * 500 - Already recording, nothing to start
echo * Everything else is an error

For a Jenkins pipeline

stage('Start Recording using OBS software') {
steps {
script {
try {
bat '''
del /Q /F %userprofile%\\Videos\\*.mkv || exit 0
cd C:\\Program Files\\obs-studio\\bin\\64bit || exit 0
OBSCommand.exe /startrecording | findstr "Ok 500" || exit 1
echo OBSCommand.exe /startrecording will return
echo * Ok - Started recording
echo * 500 - Already recording, nothing to start
echo * Everything else is an error
'''
} catch (err) {
echo "Error detected, sending an email then we will continue."
emailext body: "OBS Error for ${env.JOB_NAME} build ${env.BUILD_NUMBER}<br> More info at: ${env.BUILD_URL}",
subject: "OBS Error: ${env.JOB_NAME}",
mimeType: 'text/html', to: '$DEFAULT_RECIPIENTS'
}
}
}
}

 

[FSC]

@tim.calderwood thanks for sharing!

 

[hlynge]

Is this still working ?
I am having a really hard time just sending a command to e.g. start a recording:

OBSCommand.exe /server=127.0.0.1:4455 /password="" /startrecording

 

[hlynge]

Is this still working ?
I am having a really hard time just sending a command to e.g. start a recording:
View attachment 102784

Sorry - i found the error was the missing dependency on dotnet-runtime-3.1.32-win-x64.exe

 

[cptroger76]

Thank you so much for this! Saves me so much time and makes me work so efficiently. Just had to register to say this. For instance, using the same command as a button on the streamdeck and within VoiceAttack and in Streamer.Bot

Muchos Gracias!

 

[FSC]

Thank you so much for this! Saves me so much time and makes me work so efficiently. Just had to register to say this. For instance, using the same command as a button on the streamdeck and within VoiceAttack and in Streamer.Bot

Muchos Gracias!

Thanks for the feedback! You're welcome!

 

[cptroger76]

Is there a way to turn on / off a filter on a source? And if yes, could you provide a simple example?

 

[FSC]

You can try this (Sorry not verified, I use AI since a while as all the information is online and easy acccessible for AI's):

OBSCommand /command=SetSourceFilterEnabled,sourceName="Your Source",filterName="Your Filter",filterEnabled=true

OBSCommand /command=SetSourceFilterEnabled,sourceName="Your Source",filterName="Your Filter",filterEnabled=false

 

[cptroger76]

You can try this (Sorry not verified, I use AI since a while as all the information is online and easy acccessible for AI's):

OBSCommand /command=SetSourceFilterEnabled,sourceName="Your Source",filterName="Your Filter",filterEnabled=true

OBSCommand /command=SetSourceFilterEnabled,sourceName="Your Source",filterName="Your Filter",filterEnabled=false

I will test, thank you. I'll let you know / post it here

 

[cptroger76]

I got it!

Took me about an hour to figure it out.

Mistake was that I assumed you had to define the scene as well, like for example:
OBSCommand.exe /showsource="Videos/Nice001.mp4" /delay=4.000 /hidesource="Videos/Nice001.mp4"
Where you show the clip 'Nice001.mp4' on the scene 'Videos', wait 4 seconds, and then hide it again.

But with the filter you don't specify the scene (I guess because a sourcename must be unique).

So, here to turn on and off a filter:
OBSCommand.exe /command=SetSourceFilterEnabled,sourceName=Color,filterName=Mask,filterEnabled=true
OBSCommand.exe /command=SetSourceFilterEnabled,sourceName=Color,filterName=Mask,filterEnabled=false

Where you turn on the Advanced Mask filter (thanks Exeldro) and off again on the source 'Color' (which resides on the scene main, but that's irrelevant, now I know).

And here's an example with spaces in the name of the source and the filter:
OBSCommand.exe /command=SetSourceFilterEnabled,sourceName="Color 2",filterName="Advanced Mask",filterEnabled=true
OBSCommand.exe /command=SetSourceFilterEnabled,sourceName="Color 2",filterName="Advanced Mask",filterEnabled=false

And to make it in a sweet combined command (one-liner) where you turn on the filter, wait 5 seconds, and turn it off again:
OBSCommand.exe /command=SetSourceFilterEnabled,sourceName="Color 2",filterName="Advanced Mask",filterEnabled=true /delay=5.000 /command=SetSourceFilterEnabled,sourceName="Color 2",filterName="Advanced Mask",filterEnabled=false

Thanks FSC!

Now, I'll be thinking about the fun things I can do with this.

 

[cptroger76]

I got it!

Took me about an hour to figure it out.

Mistake was that I assumed you had to define the scene as well, like for example:
OBSCommand.exe /showsource="Videos/Nice001.mp4" /delay=4.000 /hidesource="Videos/Nice001.mp4"
Where you show the clip 'Nice001.mp4' on the scene 'Videos', wait 4 seconds, and then hide it again.

But with the filter you don't specify the scene (I guess because a sourcename must be unique).

So, here to turn on and off a filter:
OBSCommand.exe /command=SetSourceFilterEnabled,sourceName=Color,filterName=Mask,filterEnabled=true
OBSCommand.exe /command=SetSourceFilterEnabled,sourceName=Color,filterName=Mask,filterEnabled=false

Where you turn on the Advanced Mask filter (thanks Exeldro) and off again on the source 'Color' (which resides on the scene main, but that's irrelevant, now I know).

And here's an example with spaces in the name of the source and the filter:
OBSCommand.exe /command=SetSourceFilterEnabled,sourceName="Color 2",filterName="Advanced Mask",filterEnabled=true
OBSCommand.exe /command=SetSourceFilterEnabled,sourceName="Color 2",filterName="Advanced Mask",filterEnabled=false

And to make it in a sweet combined command (one-liner) where you turn on the filter, wait 5 seconds, and turn it off again:
OBSCommand.exe /command=SetSourceFilterEnabled,sourceName="Color 2",filterName="Advanced Mask",filterEnabled=true /delay=5.000 /command=SetSourceFilterEnabled,sourceName="Color 2",filterName="Advanced Mask",filterEnabled=false

Thanks FSC!

Now, I'll be thinking about the fun things I can do with this.

ow, and I used this as well as reference:

obs-websocket/docs/generated/protocol.md at master · obsproject/obs-websocket

Remote-control of OBS Studio through WebSocket. Contribute to obsproject/obs-websocket development by creating an account on GitHub.

github.com

 

[FSC]

Awesome! Glad you could make it work as intended. Thanks for sharing the details!