obs-websocket 4.7.0
Only use this release with OBS 23 or above!
Changes since 4.6.1
- Support for Recording Pause (#371):
- New request types:
PauseRecording
andResumeRecording
- New event types:
RecordingPaused
andRecordingResumed
- Add a
recording-paused
field in the response/event fields ofGetStreamingStatus
,Heartbeat
andStreamStatus
- The recording timecode field now takes pauses into account
- New request types:
- Ability to broadcast custom events to all connected clients of the server (#354)
- Calling the
BroadcastCustomMessage
request type will send aBroadcastCustomMessage
event to all connected clients
- Calling the
- Ability to control the visibility state of a source filter with
SetSourceFilterVisibility
(#388)- Source filter info responses and events now have a
filterEnabled
boolean field - New event type for filter visibility:
SourceFilterVisibilityChanged
- Source filter info responses and events now have a
- Generic outputs control API (#343)
- Adds request types
ListOutputs
,GetOutputInfo
,StartOutput
andStopOutput
- Adds request types
- Other request type additions:
- Improvement: the WebSockets server now only starts after OBS has finished loading completely (#367)
- Improvement: the
TransitionBegin
event now reports a duration of 0 if the reported transition is a Cut transition (#364) - Documentation fix: make it clear that
TakeSourceScreenshot
can take scene screenshots as well (#384) - Bugfix: crash when calling
ToggleStudioMode
orTransitionToProgram
(#320) - Bugfix: incorrect recording path (#366)
- Bugfix:
ReorderSceneItems
now works without crashing (#365) - Bugfix: crash when the server fails to send a message to a disconnecting client (#369)
- Bugfix: add Linux Browser Source support to
GetBrowserSourceProperties
andSetBrowserSourceProperties
(#360) - macOS: fixes for compatibility with OBS Studio 24.0.3 and macOS Catalina (#385)
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
orC:\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".