`obs-websocket-py` 是一个用于与 OBS Studio 的 `obs-websocket` 插件进行交互的 Python 客户端库。它允许开发者通过 WebSocket 协议连接到运行中的 OBS 实例，并执行诸如控制场景切换、调整音量、启动/停止录制等操作。该库广泛用于自动化直播流程、开发 OBS 插件前端界面或构建远程控制工具。 ### 安装 可以通过 `pip` 安装 `obs-websocket-py`： ```bash pip install obs-websocket-py ``` ### 基本使用指南 要使用该库，首先需要确保已在 OBS 中安装并启用了 `obs-websocket` 插件，并配置了 WebSocket 服务器的端口和密码（如果启用）[^1]。 以下是一个简单的连接和获取 OBS 状态的示例： ```python from obswebsocket import obsws, requests host = "localhost" port = 4444 password = "your_password" # 如果未设置密码，可省略 ws = obsws(host, port, password) ws.connect() # 获取当前场景名称 current_scene = ws.call(requests.GetCurrentScene()) print("当前场景名称：", current_scene.getName()) # 获取所有场景列表 scenes = ws.call(requests.GetSceneList()) for scene in scenes.getScenes(): print("场景名称：", scene['name']) ws.disconnect() ``` ### 常用功能示例 #### 切换场景 ```python ws.call(requests.SetCurrentScene("场景名称")) ``` #### 开始/停止录制 ```python ws.call(requests.StartRecording()) # ... ws.call(requests.StopRecording()) ``` #### 获取录制状态 ```python record_status = ws.call(requests.GetRecordingStatus()) print("是否正在录制：", record_status.isRecording()) ``` #### 获取和设置音量 ```python volume_info = ws.call(requests.GetVolume("麦克风")) print("当前音量：", volume_info.getVolume()) ws.call(requests.SetVolume("麦克风", 0.75)) # 设置为 75% ``` ### 异步支持 `obs-websocket-py` 也支持异步操作，适用于需要非阻塞通信的场景。以下是一个使用 `asyncio` 的示例： ```python import asyncio from obswebsocket.async_ import obsws as async_obsws from obswebsocket import requests as obs_requests async def main(): ws = async_obsws("localhost", 4444, "your_password") await ws.connect() scenes = await ws.call(obs_requests.GetSceneList()) for scene in scenes.getScenes(): print("异步获取场景名称：", scene['name']) await ws.disconnect() asyncio.run(main()) ``` ### 开发文档与资源 官方文档和 API 参考可以在 GitHub 项目页面找到： - GitHub 仓库：[https://github.com/IRLToolkit/obs-websocket-py](https://github.com/IRLToolkit/obs-websocket-py) - `obs-websocket` 插件文档：[https://github.com/obsproject/obs-websocket](https://github.com/obsproject/obs-websocket) 在开发过程中，建议查阅 `requests.py` 模块以了解所有可用的请求类型和参数。 ### 常见问题与注意事项 - **连接失败**：请确保 OBS 正在运行，且 `obs-websocket` 插件已正确配置。 - **权限问题**：如果启用了密码保护，必须在连接时提供正确的密码。 - **版本兼容性**：不同版本的 `obs-websocket` 插件可能提供不同的 API 接口，请注意版本匹配。 ---