OBS WebSocket 技术文档

OBS WebSocket 技术文档

obs-websocket 项目地址: https://gitcode.com/gh_mirrors/obs/obs-websocket

OBS WebSocket 是一个为 OBS Studio 提供的WebSocket接口，允许远程控制OBS Studio软件。从版本28.0.0开始，它已作为OBS Studio的一部分默认包含。对于那些使用较旧版本的OBS Studio，本文档将指导您完成安装、配置及使用过程。

安装指南

对于OBS Studio 28.0.0以上版本

无需单独下载，OBS WebSocket已经内置。直接更新或安装最新版OBS Studio即可。

对于OBS Studio 28.0.0以下版本

1. 访问Release页面，根据您的操作系统选择对应的Windows、MacOS或Linux版本进行下载。
2. 解压下载的文件，并将其放置在合适的位置。
3. 启动OBS Studio后，通过“工具”菜单中的“插件管理器”，确保安装了“OBS WebSocket”插件。

项目的使用说明

首次加载OBS WebSocket时，会自动生成密码以保护插件免受未经授权的控制。要修改设置，执行以下步骤：

• 打开OBS Studio的“工具”菜单，点击“OBS WebSocket 设置”。
• 在这里，您可以启用或禁用认证，并设定密码。强烈建议始终使用密码保护。

另外，启动时可以通过命令行参数覆盖设置，如指定WebSocket端口(--websocket_port=value)、设置密码(--websocket_password=value)、开启调试模式(--websocket_debug)以及限制到IPv4 (--websocket_ipv4_only)。

实践示例

• 远程控制: 使用手机或平板电脑通过局域网控制直播场景切换。
• 自动化场景切换: 根据特定事件自动调整场景，比如游戏状态改变。
• 集成第三方应用: 如脚本、宏系统或其他自动化工具来增强直播体验。

项目API使用文档

OBS WebSocket使用了一套详尽的协议，具体文档位于项目下的docs/generated/protocol.md。该文档列出了所有可用的命令、请求和响应格式，是开发者集成OBS WebSocket的关键资源。

主要API功能概览

• 场景操作: 切换场景、添加或删除场景元素。
• 源控制: 控制文本来源的内容、视频源的播放状态等。
• 录制与流: 开始/停止录制，切换流的状态。
• 配置获取与设置: 读取或修改OBS的设置项。

客户端库与应用

为了便于开发者和使用者，社区提供了多种编程语言的客户端库，例如Python、Rust、JavaScript等（详细列表参见原始Readme）。这些库简化了与OBS WebSocket服务器交互的过程，适合不同背景的开发者快速集成。

利用这些资源，您可以构建定制化的控制界面、实现自动化直播流程或创建复杂的交互逻辑。加入 Discord 社区(#project-showoff频道)分享您的创意和技术实现吧！

---

本技术文档旨在提供清晰、简洁的指引，帮助您充分利用OBS WebSocket进行高效直播控制和自动化。记得，在开发过程中参考官方文档以获得最准确的信息和最新的变更。

obs-websocket 项目地址: https://gitcode.com/gh_mirrors/obs/obs-websocket