msikma / obsws-4to5

Migration guide for obs-websocket v4 to v5

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

obs-websocket v4 to v5 migration reference

This is a quick reference I put together to help people migrate their code from obs-websocket protocol v4 to v5.

At this time of writing, there unfortunately is no official migration guide, although one is apparently in the works. This means the only way to update your code right now is to go through both protocol documents and guess which old calls correspond to which new calls.

I am not involved in the development of obs-websocket or OBS itself, so I'm not the best person for writing a migration guide, but I thought it would be useful to at least share my work with others. This document primarily aims to connect all v4 requests and events to their v5 equivalents, so that if you're migrating you can Ctrl+F your old v4 calls and instantly find out what the new call should be.

While most information here is client-agnostic, some examples are written with obs-websocket-js in mind, just for the same of having practical examples. If you use a different client, you can skip over to the list of calls. If you'd like to help improve this guide by adding information specific to other clients, or anything else that might help, feel free to open an issue or send in a PR.

Migration document

For ease of reading, the actual reference guide is its own separate document.

Read the obs-websocket v4 to v5 migration reference on Github.

External links

About

Migration guide for obs-websocket v4 to v5