obsproject/obs-websocket 5.0.0-alpha2

obs-websocket 5.0.0-alpha2

on GitHub

THIS IS A PRE-RELEASE. UNLESS YOU KNOW EXACTLY WHAT YOU ARE DOING, DOWNLOAD 4.9.1

Important Notes

• Only use this release with OBS Studio 27.1.0 or above.
• All plugin components have been finished, however there are some events and requests which have not yet been implemented. See the event and request sheets to find out what has been implemented.

Resources

• The protocol specification is available here
• Breaking changes to the protocol specification performed during the development process are available here
• The planned requests sheet is available here
• The planned events sheet is available here
• To aid developers, I've updated simpleobsws (a client library I maintain) for the latest 5.0.0 protocol spec. This should help with testing and as an implementation example. See the branch here

Changes since 5.0.0-alpha1

• obs-websocket now reports the extended plugin version in the log and around the plugin (5.0.0-alpha2 instead of just 5.0.0)
• The QR code format has been updated from obswebsocket|[host]:[port]|[password] to obsws://[host]:[port]/[password]. obswss:// is to be used for WSS connections.
• Fixed the global data realm functionality for persistent data requests.
• eventIntent is now a key in event payload data.
• The header for specifying JSON vs MsgPack has been changed from Content-Type to the Sec-WebSocket-Protocol standard. obswebsocket.json and obswebsocket.msgpack are the currently supported subprotocols.
• The RequestStatus enum has been refactored and heavily simplified. For example, InputNotFound and SceneNotFound are now just ResourceNotFound.
• (minor) RemoveScene now makes sure you are not removing the last scene.
• Added these requests:
  • GetInputAudioMonitorType
  • SetInputAudioMonitorType
  • GetInputPropertiesListPropertyItems (this one is really dope)
  • PressInputPropertiesButton
  • ToggleStream
  • GetSceneItemList
  • GetGroupSceneItemList
  • CreateSceneItem
  • RemoveSceneItem

About groups...

I've gotten many questions about whether groups will officially be supported in OBS. Today I spent a bunch of time looking into what will be possible for interacting with groups in obs-websocket. Unfortunately, we are very restricted due to how groups work in OBS. However, I can say that what is and is not possible will be clearly defined in 5.x.

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-5.0.0-alpha2-Windows.zip archive : copy the contents of the archive to the root of your OBS Studio installation folder (C:\Program Files\obs-studio).

Debian / Ubuntu (64-bit)

Download obs-websocket-5.0.0-alpha2-Ubuntu64.deb (provided below) and install it on your system.

macOS

Sorry, but no binaries are available for macOS right now.