obsproject/obs-websocket 4.2.0

obs-websocket 4.2.0 (a.k.a "It's About Time")

on GitHub

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.