Skip to content

Releases: obsproject/obs-websocket

obs-websocket 4.7.0

12 Nov 09:57
@Palakis Palakis
4.7.0
9a8f248
Compare
Choose a tag to compare
obs-websocket 4.7.0

Only use this release with OBS 23 or above!

Changes since 4.6.1

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.7.0-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)

  • Manual install: Download obs-websocket_4.7.0-1_amd64.deb and install it on your system.

macOS

Download and run obs-websocket-4.7.0-macOS.pkg.
Note: the installer package is now digitally signed, so macOS shouldn't complain. However, if it is the case and a security alert pops up when trying to launch the installer, go to the "Security & Privacy" panel under macOS Settings and click "Open Anyway".

Assets 6
Loading

obs-websocket 4.6.1

20 May 22:15
@Palakis Palakis
4.6.1
585f845
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Learn about vigilant mode.
Compare
Choose a tag to compare
obs-websocket 4.6.1

Only use this release with OBS 23 or above!

4.6.1 Hotfix Changes

  • Bugfix: TransitionBegin event not triggering at all

4.6.0 Changes

  • Revamped WebSockets server: the WebSockets server backend was completely rewritten. Instead of Qt's WebSockets library, starting with 4.6 obs-websocket now uses websocketpp by zaphoyd. Other benefits include:
    • Requests are received and processed in a separate dedicated threads. The old server processed everything in the UI/main window thread.
    • Everything (main plugin + server dependencies) is now in a single binary file.
  • Server settings are now per-profile settings instead of global settings: the server is automatically started, stopped or restarted when switching profiles. New profiles inherit settings from the previously selected profile.
  • New request types:
    • TakeSourceScreenshot: take an image snapshot of a source (either an input or a scene) and save it straight to a file and/or receive it in the response as base64-encoded Data URI
    • SendCaptions (Windows/macOS only): send closed captions text to the streaming output. For instance, Twitch's player supports closed captions sent through SendCaptions
    • GetStats: provides most of the metrics found in OBS' Stats window.
    • GetVideoInfo: Fetch information about OBS' video output settings: base/canvas size and output size, pixel format, YUV settings, ...
  • New event types:
  • Feature: StreamStatus and Heartbeat events now include data from OBS' stats and a replay-buffer-active property (for StreamStatus)
  • Feature: GetSceneItemProperties and SetSceneItemProperties now have support for a locked property that allows users to lock or unlock a scene item and get its current lock state
  • Feature: the response from GetSceneItemProperties now includes width and height values computed from the item's base dimensions and current scaling settings.
  • Source and Scene Item events enhancements:
    • Source and Scene Item events will also be triggered for the current preview scene (in Studio Mode) and scenes not currently visible on program or preview
    • All scene item events now include an item-id property
    • SourceOrderChanged now includes a list of the reordered scene items
  • Fixed incompatibilites with Groups:
    • Scene Item requests can now target items nested in groups
    • Scene item data now includes two new properties:
      • parentGroupName on scene items that belong to a group
      • children on groups
  • Bugfix: crash on startup when the "port already in use" message shows up
  • Bugfix: error with SetSceneItemProperties when trying to set the bounds type of a scene item
  • Bugfix: plugin not loading on Ubuntu when installing through the .deb file (wrong plugin path)
  • Bugfix (docs): GetSourcesTypesList is supposed to be GetSourceTypesList
  • Docs: the Protocol Specification now includes type definitions that can be shared among several request types. These encourage reusing existing response formats, and allows obs-websocket-js to provide type definitions in their TypeScript bindings.

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.6.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)

  • Manual install: Download obs-websocket_4.6.1-1_amd64.deb and install it on your system.

macOS

Download and run obs-websocket-4.6.1.pkg.
Note: the installer package is now digitally signed, so macOS shouldn't complain. However, if it is the case and a security alert pops up when trying to launch the installer, go to the "Security & Privacy" panel under macOS Settings and click "Open Anyway".

Assets 6
Loading

obs-websocket 4.6.0

20 May 19:20
@Palakis Palakis
4.6.0
aed0234
Compare
Choose a tag to compare
obs-websocket 4.6.0

Changes since 4.5.1

  • Revamped WebSockets server: the WebSockets server backend was completely rewritten. Instead of Qt's WebSockets library, starting with 4.6 obs-websocket now uses websocketpp by zaphoyd. Other benefits include:
    • Requests are received and processed in a separate dedicated threads. The old server processed everything in the UI/main window thread.
    • Everything (main plugin + server dependencies) is now in a single binary file.
  • Server settings are now per-profile settings instead of global settings: the server is automatically started, stopped or restarted when switching profiles. New profiles inherit settings from the previously selected profile.
  • New request types:
    • TakeSourceScreenshot: take an image snapshot of a source (either an input or a scene) and save it straight to a file and/or receive it in the response as base64-encoded Data URI
    • SendCaptions (Windows/macOS only): send closed captions text to the streaming output. For instance, Twitch's player supports closed captions sent through SendCaptions
    • GetStats: provides most of the metrics found in OBS' Stats window.
    • GetVideoInfo: Fetch information about OBS' video output settings: base/canvas size and output size, pixel format, YUV settings, ...
  • New event types:
  • Feature: StreamStatus and Heartbeat events now include data from OBS' stats and a replay-buffer-active property (for StreamStatus)
  • Feature: GetSceneItemProperties and SetSceneItemProperties now have support for a locked property that allows users to lock or unlock a scene item and get its current lock state
  • Feature: the response from GetSceneItemProperties now includes width and height values computed from the item's base dimensions and current scaling settings.
  • Source and Scene Item events enhancements:
    • Source and Scene Item events will also be triggered for the current preview scene (in Studio Mode) and scenes not currently visible on program or preview
    • All scene item events now include an item-id property
    • SourceOrderChanged now includes a list of the reordered scene items
  • Fixed incompatibilites with Groups:
    • Scene Item requests can now target items nested in groups
    • Scene item data now includes two new properties:
      • parentGroupName on scene items that belong to a group
      • children on groups
  • Bugfix: crash on startup when the "port already in use" message shows up
  • Bugfix: error with SetSceneItemProperties when trying to set the bounds type of a scene item
  • Bugfix: plugin not loading on Ubuntu when installing through the .deb file (wrong plugin path)
  • Bugfix (docs): GetSourcesTypesList is supposed to be GetSourceTypesList
  • Docs: the Protocol Specification now includes type definitions that can be shared among several request types. These encourage reusing existing response formats, and allows obs-websocket-js to provide type definitions in their TypeScript bindings.

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.6.0-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)

  • Manual install: Download obs-websocket_4.6.0-1_amd64.deb and install it on your system.

macOS

Download and run obs-websocket-4.6.0.pkg.
Note: the installer package is now digitally signed, so macOS shouldn't complain. However, if it is the case and a security alert pops up when trying to launch the installer, go to the "Security & Privacy" panel under macOS Settings and click "Open Anyway".

Assets 6
Loading

obs-websocket 4.5.1

30 Mar 14:37
@Palakis Palakis
4.5.1
ef5480d
Compare
Choose a tag to compare
obs-websocket 4.5.1

Only use this release with OBS 22 or above!

4.5.1 bugfix release

  • Bugfix: plugin not loading on Ubuntu (misplaced binary)
  • Bugfix: improper control flow in filter management requests (missing return statements)

4.5.0 changes

  • New request types:
    • Filter management:
      • GetSourceFilters
      • AddFilterToSource
      • RemoveFilterFromSource
      • ReorderSourceFilter
      • MoveSourceFilter
      • SetSourceFilterSettings
    • Scene Items:
      • DeleteSceneItem
      • DuplicateSceneItem
      • ReorderSceneItems
    • Source settings:
      • GetTextFreetype2Properties
      • SetTextFreetype2Properties
  • Updated request types:
    • Breaking changes in GetTextGDIPlusProperties, SetTextGDIPlusProperties, GetBrowserSourceProperties and SetBrowserSourceProperties:
      • Removed the scene-name parameter: deemed useless on sources, which are independent from scenes
      • Removed the render request parameter and response property
    • GetVolume: fix typo in protocol specification (:negative_squared_cross_mark: mute ; ✔️ muted)
  • Refactored authentication code:
    • If you have authentication enabled and your current password doesn't work anymore, try setting it again.
  • macOS Bugfix: Qt version mismatch
  • Fixed various typos in the protocol specification

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.5.1-Windows.zip archive : copy the contents of the archive to the root of your OBS Studio installation folder.

Debian (64-bit)

  • Manual install: Download obs-websocket_4.5.1-1_amd64.deb and install it on your system.

macOS

Download and run obs-websocket-4.5.1.pkg.
Note: the installer package is now digitally signed, so macOS shouldn't complain. However, if it is the case and a security alert pops up when trying to launch the installer, go to the "Security & Privacy" panel under macOS Settings and click "Open Anyway".

Assets 6
Loading

obs-websocket 4.5.0 Release Candidate

30 Dec 20:30
@Palakis Palakis
4.5.0
974d6b4
Compare
Choose a tag to compare
obs-websocket 4.5.0 Release Candidate Pre-release
Pre-release

Only use this release with OBS 22 or above!

Foreword

This is a Release Candidate for obs-websocket 4.5.0. Some things may be broken, so please test it before using it in production.
Minor non-backwards-compatible changes are in 4.5.0, detailed below in the changelog. Check if your code is affected by one of the changes, and update your code accordingly.
If you're using a ready-made tool/software that uses obs-websocket, test it and report any issue to the developer/publisher of the aforementioned software.

Changes since 4.4.0

  • New request types:
    • Filter management:
      • GetSourceFilters
      • AddFilterToSource
      • RemoveFilterFromSource
      • ReorderSourceFilter
      • MoveSourceFilter
      • SetSourceFilterSettings
    • Scene Items:
      • DeleteSceneItem
      • DuplicateSceneItem
      • ReorderSceneItems
    • Source settings:
      • GetTextFreetype2Properties
      • SetTextFreetype2Properties
  • Updated request types:
    • Breaking changes in GetTextGDIPlusProperties, SetTextGDIPlusProperties, GetBrowserSourceProperties and SetBrowserSourceProperties:
      • Removed the scene-name parameter: deemed useless on sources, which are independent from scenes
      • Removed the render request parameter and response property
    • GetVolume: fix typo in protocol specification (:negative_squared_cross_mark: mute ; ✔️ muted)
  • Refactored authentication code:
    • If you have authentication enabled and your current password doesn't work anymore, try setting it again.
  • macOS Bugfix: Qt version mismatch
  • Fixed various typos in the protocol specification

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.5.0-Windows.zip archive : copy the contents of the archive to the root of your OBS Studio installation folder.

Debian (64-bit)

  • Manual install: Download obs-websocket_4.5.0-1_amd64.deb and install it on your system.

macOS

Download and run obs-websocket-4.5.0.pkg.
Note: OS X may show you a security alert when launching the installer, preventing your from installing obs-websocket. If this happens, go to the "Security & Privacy" panel in OS X Settings and click "Open Anyway".

Assets 6
Loading

obs-websocket 4.4.0

20 Aug 22:26
@Palakis Palakis
4.4.0
4e6d4ac
Compare
Choose a tag to compare
obs-websocket 4.4.0

Only use this release with OBS 22 or above!

Changes since 4.3.3

  • TransitionBegin event: new from-scene and to-scene fields to provide source and destination scene names for the currently running transition
  • Bugfix: TransitionBegin event not triggering when using Transition Overrides
  • Improvement: better handling of "preview scene changed" events provided by libobs

Install instructions

Windows

  • Using the installer (recommended) : download it, launch it and follow the instructions.
  • Using the obs-websocket-4.4.0-Windows.zip archive : copy the contents of the archive to the root of your OBS Studio installation folder.

Ubuntu/Debian

  • Manual install (64-bit only): Download obs-websocket_4.4.0-1_amd64.deb and install it on your system.
  • PPA: not yet available

macOS

Download and run obs-websocket-4.4.0.pkg.
Note: OS X may show you a security alert when launching the installer, preventing your from installing obs-ndi. If this happens, go to the "Security & Privacy" panel in OS X Settings and click "Open Anyway".

Assets 6
Loading

obs-websocket 4.3.3 - Windows Hotfix (OBS 21.1 and above)

19 Mar 01:21
@Palakis Palakis
4.3.3
6eb4993
Compare
Choose a tag to compare
obs-websocket 4.3.3 - Windows Hotfix (OBS 21.1 and above)

CAUTION: ONLY use this release with OBS 21.1 or above!

Changes since 4.3.2

  • [Windows only] Compatibility fixes for OBS Studio 21.1:
    • Compiler upgraded to Visual Studio 2015
    • Qt upgraded to 5.10.1

Install instructions

Windows

  • Using the installer (recommended) : download it, launch it and follow the instructions.
  • Using the obs-websocket-4.3.3-Windows.zip archive : copy the contents of the archive to the root of your OBS Studio installation folder.
Assets 4
Loading

obs-websocket 4.3.2 (OBS 21.0.3 and below)

19 Mar 01:21
@Palakis Palakis
4.3.2
2e19c5f
Compare
Choose a tag to compare
obs-websocket 4.3.2 (OBS 21.0.3 and below)

CAUTION: ONLY use this release with OBS 21.0.3 or below!

Changes since 4.3.1

  • Bugfixes:
    • Crash on systray notifications when no systray is available (is the case on some minimal Linux desktops)
    • Passwords not saved properly (caused by bad string handling)

Install instructions

Windows

  • Using the installer (recommended) : download it, launch it and follow the instructions.
  • Using the obs-websocket-4.3.2-Windows.zip archive : copy the contents of the archive to the root of your OBS Studio installation folder.

Ubuntu/Debian

  • Manual install (64-bit only): Download obs-websocket_4.3.2-1_amd64.deb and install it on your system.
  • PPA: not yet available

macOS

Download and run obs-websocket-4.3.2.pkg.
Note: OS X may show you a security alert when launching the installer, preventing your from installing obs-ndi. If this happens, go to the "Security & Privacy" panel in OS X Settings and click "Open Anyway".

Assets 6
Loading

obs-websocket 4.3.1

22 Jan 22:40
@Palakis Palakis
4.3.1
beadb56
Compare
Choose a tag to compare
obs-websocket 4.3.1

Changes since 4.3

  • Bugfix: crash when switching between scene collections

Install instructions

Windows

  • Using the installer (recommended) : download it, launch it and follow the instructions.
  • Using the obs-websocket-4.3.1-Windows.zip archive : copy the contents of the archive to the root of your OBS Studio installation folder.

Ubuntu/Debian

  • Manual install (64-bit only): Download obs-websocket_4.3.1-1_amd64.deb and install it on your system.
  • PPA: not yet available

macOS

Download and run obs-websocket-4.3.1.pkg.
Note: OS X may show you a security alert when launching the installer, preventing your from installing obs-ndi. If this happens, go to the "Security & Privacy" panel in OS X Settings and click "Open Anyway".

Assets 6
Loading

obs-websocket 4.3

15 Jan 08:04
@Palakis Palakis
4.3.0
73f00ca
Compare
Choose a tag to compare
obs-websocket 4.3

Changes since 4.2

New features

  • Option to enable/disable tray notifications (connect/disconnect alerts)
  • Heartbeat feature (alternative to StreamStatus):
    • 1 event: Heartbeat
    • 1 request type: SetHeartbeat
  • New request types for scene item management:
    • GetSceneItemProperties
    • SetSceneItemProperties
  • New request types for source management:
    • GetSourceSettings
    • SetSourceSettings
    • GetSourcesList
    • GetSourceTypesList
  • New request types for Recordings filename formatting:
    • GetFilenameFormatting
    • SetFilenameFormatting

Changes

  • Replay buffer requests updated to support Advanced Output mode.
  • Stream settings passed to StartStreaming are not persisted.
  • Browser Source settings requests now support local file URLs.
  • SetRecordingFolder creates the specified folder if it doesn't exist.
  • Warning message shown if the configured server port is already in use.

Bugs fixed

  • Documentation: SetStreamingSettings corrected to SetStreamSettings

Install instructions

Windows

  • Using the installer (recommended) : download it, launch it and follow the instructions.
  • Using the obs-websocket-4.3.0-Windows.zip archive : copy the contents of the archive to the root of your OBS Studio installation folder.

Ubuntu/Debian

  • Manual install (64-bit only): Download obs-websocket_4.3.0-1_amd64.deb and install it on your system.
  • PPA: not yet available

OS X/macOS

Download and run obs-websocket-latest-4.3.0.pkg.
Note: OS X may show you a security alert when launching the installer, preventing your from installing obs-ndi. If this happens, go to the "Security & Privacy" panel in OS X Settings and click "Open Anyway".

Assets 6
Loading