Skip to content

@Palakis Palakis released this Mar 30, 2019 · 114 commits to 4.x-current since this release

Only use this release with OBS 22 or above!

4.5.1 bugfix release

  • Bugfix: plugin not loading on Ubuntu (misplaced binary)
  • Bugfix: improper control flow in filter management requests (missing return statements)

4.5.0 changes

  • New request types:
    • Filter management:
      • GetSourceFilters
      • AddFilterToSource
      • RemoveFilterFromSource
      • ReorderSourceFilter
      • MoveSourceFilter
      • SetSourceFilterSettings
    • Scene Items:
      • DeleteSceneItem
      • DuplicateSceneItem
      • ReorderSceneItems
    • Source settings:
      • GetTextFreetype2Properties
      • SetTextFreetype2Properties
  • 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
    • GetVolume: fix typo in protocol specification ( mute ; ✔️ muted)
  • 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.1-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.1-1_amd64.deb and install it on your system.

macOS

Download and run obs-websocket-4.5.1.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".

Assets 6
Pre-release

@Palakis Palakis released this Dec 30, 2018 · 114 commits to 4.x-current since this release

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
  • 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
    • GetVolume: fix typo in protocol specification ( mute ; ✔️ muted)
  • 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".

Assets 6

@Palakis Palakis released this Aug 20, 2018

Only use this release with OBS 22 or above!

Changes since 4.3.3

  • TransitionBegin event: new from-scene and to-scene fields to provide source and destination scene names for the currently running transition
  • Bugfix: TransitionBegin event not triggering when using Transition Overrides
  • Improvement: better handling of "preview scene changed" events provided by libobs

Install instructions

Windows

  • Using the installer (recommended) : download it, launch it and follow the instructions.
  • Using the obs-websocket-4.4.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.4.0-1_amd64.deb and install it on your system.
  • PPA: not yet available

macOS

Download and run obs-websocket-4.4.0.pkg.
Note: OS X may show you a security alert when launching the installer, preventing your from installing obs-ndi. If this happens, go to the "Security & Privacy" panel in OS X Settings and click "Open Anyway".

Assets 6

CAUTION: ONLY use this release with OBS 21.1 or above!

Changes since 4.3.2

  • [Windows only] Compatibility fixes for OBS Studio 21.1:
    • Compiler upgraded to Visual Studio 2015
    • Qt upgraded to 5.10.1

Install instructions

Windows

  • Using the installer (recommended) : download it, launch it and follow the instructions.
  • Using the obs-websocket-4.3.3-Windows.zip archive : copy the contents of the archive to the root of your OBS Studio installation folder.
Assets 4

CAUTION: ONLY use this release with OBS 21.0.3 or below!

Changes since 4.3.1

  • Bugfixes:
    • Crash on systray notifications when no systray is available (is the case on some minimal Linux desktops)
    • Passwords not saved properly (caused by bad string handling)

Install instructions

Windows

  • Using the installer (recommended) : download it, launch it and follow the instructions.
  • Using the obs-websocket-4.3.2-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.3.2-1_amd64.deb and install it on your system.
  • PPA: not yet available

macOS

Download and run obs-websocket-4.3.2.pkg.
Note: OS X may show you a security alert when launching the installer, preventing your from installing obs-ndi. If this happens, go to the "Security & Privacy" panel in OS X Settings and click "Open Anyway".

Assets 6

@Palakis Palakis released this Jan 22, 2018

Changes since 4.3

  • Bugfix: crash when switching between scene collections

Install instructions

Windows

  • Using the installer (recommended) : download it, launch it and follow the instructions.
  • Using the obs-websocket-4.3.1-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.3.1-1_amd64.deb and install it on your system.
  • PPA: not yet available

macOS

Download and run obs-websocket-4.3.1.pkg.
Note: OS X may show you a security alert when launching the installer, preventing your from installing obs-ndi. If this happens, go to the "Security & Privacy" panel in OS X Settings and click "Open Anyway".

Assets 6

@Palakis Palakis released this Jan 15, 2018

Changes since 4.2

New features

  • Option to enable/disable tray notifications (connect/disconnect alerts)
  • Heartbeat feature (alternative to StreamStatus):
    • 1 event: Heartbeat
    • 1 request type: SetHeartbeat
  • New request types for scene item management:
    • GetSceneItemProperties
    • SetSceneItemProperties
  • New request types for source management:
    • GetSourceSettings
    • SetSourceSettings
    • GetSourcesList
    • GetSourceTypesList
  • New request types for Recordings filename formatting:
    • GetFilenameFormatting
    • SetFilenameFormatting

Changes

  • Replay buffer requests updated to support Advanced Output mode.
  • Stream settings passed to StartStreaming are not persisted.
  • Browser Source settings requests now support local file URLs.
  • SetRecordingFolder creates the specified folder if it doesn't exist.
  • Warning message shown if the configured server port is already in use.

Bugs fixed

  • Documentation: SetStreamingSettings corrected to SetStreamSettings

Install instructions

Windows

  • Using the installer (recommended) : download it, launch it and follow the instructions.
  • Using the obs-websocket-4.3.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.3.0-1_amd64.deb and install it on your system.
  • PPA: not yet available

OS X/macOS

Download and run obs-websocket-latest-4.3.0.pkg.
Note: OS X may show you a security alert when launching the installer, preventing your from installing obs-ndi. If this happens, go to the "Security & Privacy" panel in OS X Settings and click "Open Anyway".

Assets 6

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)
  • GetVersion request: api-version removed 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.

Assets 5
Pre-release
Pre-release

@Palakis Palakis released this Aug 19, 2017

Maintenance-only release. Builds provided here are not guaranteed to work.

Assets 5

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

Changes

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.

Assets 4
You can’t perform that action at this time.