Only use this release with OBS Studio 26.1 or above!
Changes since 4.8.0
New Features
-
Added Events:
- New
Media
category with lots of events SourceAudioActivated
SourceAudioDeactivated
- New
-
Added Requests:
- New
Media Control
category with lots of requests ExecuteBatch
CreateSource
CreateScene
GetSourceDefaultSettings
RefreshBrowserSource
AddSceneItem
GetSceneItemList
GetAudioActive
TriggerHotkeyByName
TriggerHotkeyBySequence
GetRecordingStatus
GetReplayBufferStatus
GetTransitionSettings
SetTransitionSettings
GetTransitionPosition
ReleaseTBar
SetTBarPosition
- New
Enhancements
- Made password authentication enabled by default and added a new popup asking to set a new password on first startup (#657)
- Added the ability to lock obs-websocket to only using an IPv4 address to bind to (#559)
- Added
recordingFilename
field to the response ofGetRecordingStatus
and the various Recording events (#621) - Added scene item ID support to
SetSceneItemRender
(#628) - Changed the
position
datatype inGetSceneItemProperties
to a double instead of an integer (#533) TakeSourceScreenshot
now defaults to the current scene if no source name is provided (#557)SetCurrentSceneCollection
andSetCurrentProfile
now check if the provided sc/profile name is valid (#560)- More detailed state information for various events. More details in PR description (#619)
- Added more translations provided through Crowdin (#636)
Fixes
- Fixed a crash that can happen when OBS exits with existing websocket clients (#644)
- Fixed a crash that can happen when notifications are enabled in obs-websocket (#571)
- Fixed
useDecibel
parameter ofGetVolume
when the volume is-INFINITY
(#529) - Fixed
missing request parameters
response when performingGetOutputInfo
,StartOutput
,StopOutput
(#618) - Fixed the file permissions of the Ubuntu deb release file. (Previously were 777) (#627)
- Reenabled captions requests for MacOS (#546)
SetVolume
now allows mul values higher than1.0
and dB values higher than0.0
(#629)
Notes
- The README has been updated with some new libraries and web clients that can be used to interface with obs-websocket
- Added a new guide for enabling SSL access with ngrok: SSL-TUNNELlING.md
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.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
orC:\Program Files (x86)\obs-studio
).
Debian / Ubuntu (64-bit)
Download obs-websocket_4.9.0-1_amd64.deb (provided below) and install it on your system.
macOS
Download and run obs-websocket-4.9.0-macOS.pkg
(provided below).