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
- Filter management:
- 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
- Removed the
GetVolume
: fix typo in protocol specification (❎mute
; ✔️muted
)
- Breaking changes in GetTextGDIPlusProperties, SetTextGDIPlusProperties, GetBrowserSourceProperties and SetBrowserSourceProperties:
- 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".