obs-websocket 4.8

Only use this release with OBS Studio 25 or above!

Changes since 4.7.0

New Features

• Added Events:

  • SceneItemLockedChanged
  • TransitionEnd
  • TransitionVideoEnd

• Added Requests:

  • OpenProjector
  • GetTransitionPosition
  • GetAudioMonitorType
  • SetAudioMonitorType
  • SetSourceName
  • SetSceneTransitionOverride
  • RemoveSceneTransitionOverride
  • GetSceneTransitionOverride

Enhancements

• In GetSceneItemProperties, SetSceneItemProperties and ResetSceneItem, you can now target scene items either by their source name or by their ID (#449)
• Added itemId response property to the GetSceneItemProperties request
• Added alignment response property to the GetSceneItemProperties request
• Added type response property to the TransitionBegin event
• Added muted property to SceneItem typedef
• Added supported-image-export-formats response property to the GetVersion request
• Added useDecibel request property to SetVolume and GetVolume requests. See docs for more info
• Added compressionQuality and fileFormat request properties to TakeSourceScreenshot
• Added sourceType response property to SourceRenamed event
• SendCaptions now uses obs_output_output_caption_text2 internally
• The macOS binary and installer now have proper digital signatures and are notarized by Apple

Fixes

• Fixed crashes when calling EnableStudioMode, DisableStudioMode or ToggleStudioMode
• Fixed an issue where SetStreamSettings wouldn't apply if switching service type
• Any event that returns transition duration now returns -1 if the transition is fixed (Eg. Cut, Stinger)
• SetSyncOffset now allows negative offsets
• Removed from-scene from TransitionEnd since it isnt actually available
• Fixed JPEG support in TakeSourceScreenshot on Windows
• Fixed a crash when sending an event on OBS exit
• Fixed source recognition on GDI+ and Freetype 2 sources
• Fixed the OBS log getting spammed with unnecessary messages on Linux (regardless of whether debug logging was enabled)
• Fixed an issue where the plugin failed to load on MacOS
• Fixed a bunch of memory leaks in GetCurrentProfile, GetCurrentSceneCollection and the Heartbeat event

Important Notes

• SetBrowserSourceProperties and GetBrowserSourceProperties are now deprecated in favor of SetSourceSettings and GetSourceSettings
• The build instructions for linux have changed. See the build doc for more info
• Unfortunately, T-Bar control did not make it into this release, as the libobs API doesn't yet provide all the necessary functions to achieve this functionality

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

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

macOS

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