v5.0.0

[t2t2]

v5 is made for obs-websocket versions 5.x that uses a completely new protocol and isn't backwards compatible with 4.x. If you're planning to build something for 4.x, consider upgrading (as all releases for future obs versions will be based on v5) or use the latest/last v4 version.

Breaking changes

• Obviously, only 5.x of obs-websocket is supported. In case an older version of the server is detected, the connection is automatically closed and the connect promise is rejected
• Distribution files target a more modern environment allowing for smaller builds for modern browsers and runtimes. Should you still want to target older browsers, make sure to configure your bundler to transpile dependencies.
• async connect(args = {}) has been changed to async connect(address = 'ws://localhost:4444', password?: string, options?: IdentifyMessageFields)
• send(type, data) has been replaced with call(type, data), aligning with simpleobsws
  • Due to changes between obs-websocket 4.x and 5.x, you'll likely need to check all send calls anyway to match the new request names
• sendCallback has been removed, use the promise chain if you want to keep callback syntax (.send(...).then((res) => { ... }, (error) => { ... }))

---

This discussion was created from the release v5.0.0.