OBS Studio的WebSocket API。
下载
obs-websocket现在默认包含在OBS Studio 28.0.0及以上版本中。因此,如果你有OBS Studio > 28.0.0,应该不需要下载obs-websocket。
在Windows、MacOS和Linux上的OBS Studio < 28.0.0的二进制文件可以在发布部分找到。
使用 obs-websocket
强烈建议用密码保护obs-websocket,以防止未经授权的控制。当你第一次加载它时,obs-websocket会自动为你生成一个密码。要改变这一点,在OBS的 "工具 "菜单下打开 "obs-websocket设置 "对话框。在设置对话框中,你可以启用或禁用认证,并为它设置一个密码。
(Psst. 你可以在命令行中使用--websocket_port(value),--websocket_password(value),--websocket_debug(flag) 和--websocket_ipv4_only(flag)来覆盖配置的值。)
可能的使用情况
- 从同一本地网络上的手机或平板电脑远程控制OBS
- 根据当前场景改变你的流叠加/图形
- 用第三方程序自动切换场景(例如:自动驾驶、脚踏板...)。
客户端软件
- (目前没有已知的支持5.0.0的客户端。如果你有的话,请在讨论区与我们联系!)
客户端库(供开发人员使用)
以下是obs-websocket的可用语言API列表。
- Python 3.7+ (Asyncio):simpleobswsby IRLToolkit
- Rust:obwsby dnaka91
- Godot 3.4.x:obs-websocket-gdby you-win
- Javascript(Node和web):OBS Websocket社区的obs-ebsocket-js
5.x服务器是一个典型的WebSocket服务器,默认运行在4455端口(端口号可在Tools 下的设置对话框中更改)。我们使用的协议在PROTOCOL.md中有所记载。
我们想知道你用obs-websocket构建的是什么!如果你用这种方式做了什么,请随时在discord服务器上的#project-showoff 留言!
