obs-websocket 项目使用教程

目录结构及介绍

obs-websocket 项目的目录结构如下：

obs-websocket/
├── CMakeLists.txt
├── LICENSE
├── README.md
├── src/
│   ├── CMakeLists.txt
│   ├── obs-websocket.cpp
│   ├── obs-websocket.h
│   ├── ...
├── debian/
│   ├── changelog
│   ├── control
│   ├── ...
├── windows/
│   ├── obs-websocket.rc
│   ├── ...
├── macos/
│   ├── Info.plist
│   ├── ...

主要目录和文件介绍：

• CMakeLists.txt: 项目的主构建文件，用于配置和构建项目。
• LICENSE: 项目的许可证文件，本项目采用 GPL-2.0 许可证。
• README.md: 项目的说明文档，包含项目的基本信息和使用指南。
• src/: 包含项目的源代码文件。
  • obs-websocket.cpp 和 obs-websocket.h: 项目的主要源代码文件。
• debian/: 包含用于构建 Debian 包的配置文件。
• windows/ 和 macos/: 分别包含用于 Windows 和 macOS 平台的特定配置文件。

项目的启动文件介绍

项目的启动文件主要是 src/obs-websocket.cpp。这个文件包含了 obs-websocket 插件的主要逻辑和初始化代码。在启动 OBS Studio 时，如果插件已正确安装和配置，obs-websocket.cpp 中的代码将被执行，从而启动 WebSocket 服务。

项目的配置文件介绍

obs-websocket 的配置文件主要通过 OBS Studio 的界面进行设置。在 OBS Studio 中，可以通过以下步骤进行配置：

1. 打开 OBS Studio。
2. 点击菜单栏中的 工具，然后选择 obs-websocket 设置。
3. 在弹出的设置对话框中，可以进行以下配置：
   • 启用或禁用身份验证。
   • 设置 WebSocket 服务的密码。
   • 配置 WebSocket 服务的端口。

此外，还可以通过命令行参数进行配置，例如：

--websocket_port(value) --websocket_password(value) --websocket_debug(flag) --websocket_ipv4_only(flag)

这些参数可以覆盖配置文件中的默认设置。

---

以上是 obs-websocket 项目的基本使用教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望这些信息能帮助你更好地理解和使用 obs-websocket 插件。