Releases: obsproject/obs-websocket
obs-websocket 4.2.0 (a.k.a "It's About Time")
obs-websocket 4.2.0 is out! As a lot of things have changed since the last official release, this one is marked as pre-release because things may break and may need a hotfix release.
Please test this as hard as you can, and report issues if they happen!
Changes since 4.0.0
Upgrade notice: if you have authentication enabled, please set your password again! Underlying authentication code has changed a bit since 4.0.
New features
- Many new commands and events: Studio Mode (contributions sponsored by Support Class), streaming settings, recording folder, replay buffer, sync offsets, ...
- Official releases for macOS (see details below) and Linux
- System tray notifications on every new client connection and disconnection
- Translations added: Portuguese
- Debug mode: log every request, response and event to OBS' logging output
- New request types:
- SetSceneItemCrop
- ResetSceneItem
- GetTransitionDuration
- StartStreaming
- StopStreaming
- StartRecording
- StopRecording
- GetStudioModeStatus
- EnableStudioMode
- DisableStudioMode
- ToggleStudioMode
- GetPreviewScene
- SetPreviewScene
- TransitionToProgram
- GetMute
- GetSpecialSources
- GetRecordingFolder
- SetRecordingFolder
- GetStreamSettings
- SetStreamSettings
- SaveStreamSettings
- GetTextGDIPlusProperties
- SetTextGDIPlusProperties
- GetBrowserSourceProperties
- SetBrowserSourceProperties
- SetRecordingFolder
- GetRecordingFolder
- StartStopReplayBuffer
- StartReplayBuffer
- StopReplayBuffer
- SaveReplayBuffer
- SetSyncOffset
- GetSyncOffset
- New event types:
- PreviewSceneChanged
- StudioModeSwitched
- ReplayStarting
- ReplayStarted
- ReplayStopping
- ReplayStopped
Changes
- Responses to requests of type GetStreamingStatus now sends streaming and recording timecodes (#63)
GetVersionrequest:api-versionremoved from responses (redundant with plugin version field)- Events of type SwitchScenes now have a full scene description object in their body
Bugs fixed
- A bug that prevented the plugin from being compiled on Ubuntu 14.04 LTS (#59)
- Several typos in the protocol specification
Install instructions
Windows
- Using the installer (recommended) : download it, launch it and follow the instructions.
- Using the obs-websocket-4.2.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.2.0-1_amd64.deb and install it on your system.
- PPA: not yet available
OS X/macOS
macOS releases are not yet available due a general issue with macOS builds on Travis. A macOS release will be available as soon as possible.
obs-websocket 4.1.0
Maintenance-only release. Builds provided here are not guaranteed to work.
obs-websocket 4.0.0
Minimum OBS Studio version required: 18.0.0
If you get an error message with obs_output_get_congestion in it, this means you'll have to update your OBS Studio installation to the latest version.
WARNING: This release will ignore your existing Websocket settings if created with an older release of obs-websocket, as the way settings are saved changes with obs-websocket 4.0.0.
Changes since 0.3.2
New features
- New version number scheme based on Semantic Versioning (removed useless "0." at the beginning)
- The server can be started/stopped during runtime from the "Websocket server settings" dialog
- The server's port can be changed during runtime from the "Websocket server settings" dialog
- German and Chinese (both Simplified and Traditional) translations
- New event types :
SwitchTransition,TransitionListChanged,SceneCollectionChanged,SceneCollectionListChanged,ProfileChanged,ProfileListChanged,TransitionDurationChanged,TransitionBegin,TransitionEnd,SourceOrderChanged,SceneItemAdded,SceneItemRemoved,SceneItemVisibilityChanged - New request types :
SetVolume,GetVolume,SetMute,ToggleMute,SetSceneItemPosition,SetSceneItemTransform,GetCurrentSceneCollection,SetCurrentSceneCollection,ListSceneCollections,GetCurrentProfile,SetCurrentProfile,ListProfiles,SetTransitionDuration
Changes
- Updated request type :
GetVersion,SetSourceRender,GetCurrentTransition, and all request types providing scene item info
Bugs fixed
- The plugin may have caused a crash when a Websocket client disconnects (#21)
- Client connect & disconnect log messages showed a garbled IP address (#21)
- Strings where not enforced to UTF-8 (#28)
- Item size was always equal to zero in an item's infos (#27)
- The internal connections list was not properly protected against concurrent accesses
- Some data structures of the request handling code may have caused a crash when destroyed
- The password was logged in the log file when changing it
Install instructions (Windows)
- Using the installer (recommended) : download it, launch it and follow the instructions.
- Using the .zip archive : copy the contents of the archive to the root of your OBS Studio installation folder.
Usage instructions
See README.md.
obs-websocket 0.3.2
Changes since 0.3.1
- Fixed a bug where the scene name is not reported correctly on scene change in Studio mode
Install instructions (Windows)
- Using the installer (recommended) : download it, launch it and follow the instructions.
- Using the .zip archive : copy the contents of the archive to the root of your OBS Studio installation folder.
Usage instructions
See README.md.
Known issues
obs-websocket 0.3.1
obs-websocket 0.3.1 is out ! This new version includes numerous bugfixes and can be considered as the first stable release of obs-websocket.
Some request types are still missing but are planned for future releases.
Install instructions (Windows)
- Using the installer (recommended) : download it, launch it and follow the instructions.
- Using the .zip archive : copy the contents of the archive to the root of your OBS Studio installation folder.
Install instructions (Ubuntu/Debian 64-bit)
Download the .deb package and install it :
wget https://github.com/Palakis/obs-websocket/releases/download/0.3.1/obs-websocket-0.3.1-1-amd64.deb
sudo dpkg -i obs-websocket-0.3.1-1-amd64.deb
The package has been built on Ubuntu 16.10 and should work on Ubuntu 16.04 and Debian Jessie.
Usage instructions
See README.md.
obs-websocket 0.3 (alpha)
Champagne ! Here comes the first ever binary release of the obs-websocket plugin !
This is an alpha release, so things might break (this plugin or your OBS). Please be careful and test it before further use !
Install instructions (Windows)
Copy the contents of the archive to the root of your OBS Studio installation folder.
Usage instructions
See README.md.
Known issues
- GetVersion : the OBS Studio version number isn't your OBS' version
- Not all OBSRemote request types are implemented