OBS WebSocket 安装和配置指南

OBS WebSocket 安装和配置指南

obs-websocket Remote-control of OBS Studio through WebSocket 项目地址: https://gitcode.com/gh_mirrors/ob/obs-websocket

1. 项目基础介绍和主要编程语言

项目基础介绍

OBS WebSocket 是一个用于远程控制 OBS Studio 的插件，通过 WebSocket 协议实现与 OBS Studio 的通信。它允许用户通过网络远程控制 OBS Studio 的各种功能，如切换场景、启动和停止录制、调整音量等。

主要编程语言

该项目主要使用 C++ 和 C 语言进行开发。

2. 项目使用的关键技术和框架

关键技术

• WebSocket 协议：用于实现与 OBS Studio 的实时通信。
• OBS Studio API：通过 OBS Studio 提供的 API 实现对 OBS Studio 的控制。

框架

• CMake：用于项目的构建和编译。

3. 项目安装和配置的准备工作和详细安装步骤

准备工作

1. 安装 OBS Studio：确保你已经安装了 OBS Studio。你可以从 OBS Studio 官方网站 下载并安装。
2. 安装 Git：用于从 GitHub 克隆项目代码。你可以从 Git 官方网站 下载并安装。
3. 安装 CMake：用于构建项目。你可以从 CMake 官方网站 下载并安装。
4. 安装编译工具：根据你的操作系统，安装相应的编译工具链（如 Visual Studio、GCC 等）。

详细安装步骤

步骤 1：克隆项目代码

打开终端或命令提示符，运行以下命令克隆项目代码：

git clone https://github.com/obsproject/obs-websocket.git

步骤 2：进入项目目录

进入克隆下来的项目目录：

cd obs-websocket

步骤 3：生成构建文件

使用 CMake 生成构建文件：

cmake -S . -B build

步骤 4：编译项目

进入构建目录并编译项目：

cd build
cmake --build .

步骤 5：安装插件

编译完成后，将生成的插件文件（通常位于 build/rundir/RelWithDebInfo/bin/64bit/ 目录下）复制到 OBS Studio 的插件目录中。插件目录通常位于：

• Windows：C:\Program Files\obs-studio\obs-plugins\64bit\
• macOS：/Applications/OBS.app/Contents/PlugIns/
• Linux：/usr/lib/obs-plugins/

步骤 6：配置 OBS WebSocket

启动 OBS Studio，打开“工具”菜单，选择“obs-websocket 设置”。在设置对话框中，你可以启用或禁用身份验证，并设置密码。

步骤 7：验证安装

确保 OBS WebSocket 插件已成功加载。你可以在 OBS Studio 的“工具”菜单中看到“obs-websocket 设置”选项，表示插件已成功安装并启用。

注意事项

• 如果你使用的是 OBS Studio 28.0.0 及以上版本，obs-websocket 插件已经默认包含在内，无需单独安装。
• 为了安全起见，建议启用身份验证并设置密码，以防止未经授权的访问。

通过以上步骤，你已经成功安装并配置了 OBS WebSocket 插件，可以开始远程控制 OBS Studio 了。

obs-websocket Remote-control of OBS Studio through WebSocket 项目地址: https://gitcode.com/gh_mirrors/ob/obs-websocket