obsproject/obs-websocket 4.9.1

obs-websocket 4.9.1

on GitHub

Only use this release with OBS Studio 27.0.0 or above!

Changes since 4.9.0

New Features

• Added Events:

  • 2 new Virtualcam-related events.

• Added Requests:

  • 4 new Virtualcam-related requests.
  • Sleep - Pause execution of a batch request for the given duration of time.
  • GetSourceActive - Whether the specified source is active on program (the output feed).

Enhancements

• Added scale.filter field to the SceneItemTransform typedef.
• The playPause parameter of the PlayPauseMedia request is now optional.
• The volumeDb parameter has been added to the SourceVolumeChanged event.
• Added support for obs-websocket to be built inline with OBS-Studio. (Versus out of tree)

Fixes

• Fixed an issue where not all image file formats were supported in 4.9.0.
• Fixed multiple scenarios where OBS could crash during shutdown with obs-websocket installed.
• Fixed an issue causing the Ubuntu deb package to have an incorrect version.
• Fixed an issue where creating a scene with CreateScene then deleting it would require an OBS restart in order to use the name again.
• The Windows and MacOS binaries are now built against Qt 5.15.2, just like OBS. This helps fix a number of issues.
• Fixed some memory leaks in SetSceneTransitionOverride, SetTBarPosition, and ReleaseTBar.

Important Notice!

This is the last planned release of obs-websocket v4.x.x. All future releases (5.x.x) will not be backwards-compatible with 4.x.x!

Over the years, obs-websocket has gone from a simple way for techies to quickly automate things to an advanced software suite with a plethora of applications that rely on it, and over 100,000 users. To say the least, there have been some growing pains in the process. Without going into too much technical detail, the plugin was originally based OBSRemote protocol which was created in early 2013. As time has progressed, more and more functionality has been built on that original design, and it was only a matter of time before it needed a complete redo.

What this means for normal users:

This means that when 5.0.0 comes out, your client software (Touch Portal, LioranBoard, etc) will also need to be updated when using them with the upcoming 5.0.0. 5.0.0 will be an exciting release, with lots of new features and performance improvements. If you're interested in seeing the kind of things in store, check out our dev updates discussion here. Here is a list of applications that plan to support v5.0.0 when it comes out:

• Touch Portal
• LioranBoard
• Streamer.bot
• StreamControl (Android App)
• obs-web (Website)
• obs-tablet-remote (Website)
• WebCaptioner (Website)
• obs-websocket-http (HTTP Server)
• simpleobsws (Python Client Library)
• obws (Rust Client Library)
• obs-java-client (Java Client Library)
• websocket-obs-java (Java Client Library)
• obs-websocket-js (JS Client Library)
  (If you are a developer planning to release an update to your software along with 5.0.0, shoot me a message on the Discord to be added here.)

What this means for developers

Ah yes, there's no better feeling than updating your software in order to not break because one of your main dependencies decided to do a full rewrite (/s). We understand that there are developers out there who make heavy usage of obs-websocket to build incredible productions, and that updating this software can be difficult. That is why I highly encourage developers to join our Discord where we are more than happy to answer your questions as you update your software to support 5.x. We also post dev preview builds there any time there has been a notable update. Here are some helpful links for 5.x that may help you:

• New protocol documentation (very different from 4.x protocol)
• Planned Requests
• Planned Events
• Example Protocol Implementation

A final note

While Palakis and I absolutely love working on obs-websocket, it's a big piece of software that requires constant upkeep and attention. We've dedicated countless hours of our time to making sure that obs-websocket keeps working reliably so that people can continue to use it to make stunning content. However, we both also have other life obligations, meaning limited amounts of time to work on obs-websocket. If you appreciate obs-websocket and would like to contribute financially in order to help keep the project going, I encourage you to visit to our OpenCollective page. Contributing helps go towards the time we put into maintaining the plugin, along with the occasional expense which would normally be paid for out-of-pocket by one of us. I would also like to thank our code contributors as well for giving us a hand with furthering development.

Install instructions

Windows

• Using the installer (recommended, works only with combined 32/64-bit installations) : download it, launch it and follow the instructions.
• Using the obs-websocket-4.9.1-Windows.zip archive : copy the contents of the archive to the root of your OBS Studio installation folder (either C:\Program Files\obs-studio or C:\Program Files (x86)\obs-studio).

Debian / Ubuntu (64-bit)

Download obs-websocket_4.9.1-1_amd64.deb (provided below) and install it on your system.

macOS

Download and run obs-websocket-4.9.1-macOS.pkg (provided below).