OBS WebSocket JS 使用指南

最新推荐文章于 2024-10-18 11:31:20 发布

汤璞亚Heath

最新推荐文章于 2024-10-18 11:31:20 发布

阅读量533

点赞数 3

本文链接：https://blog.csdn.net/gitblog_00903/article/details/141842953

版权

OBS WebSocket JS 使用指南

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

1. 项目介绍

OBS WebSocket JS 是一个由 OBS WebSocket 社区维护的JavaScript库，它使得基于JavaScript的应用程序能够通过WebSocket连接到Open Broadcaster Software (OBS) Studio。这个库允许开发者发送命令和接收事件，实现对OBS直播软件的远程控制。支持的功能包括场景切换、源操作、获取版本信息等，是开发OBS集成应用的强大工具。采用MIT许可证发布，社区活跃，便于在Node.js环境或前端项目中集成。

2. 快速启动

要快速开始使用OBS WebSocket JS，首先确保你的OBS Studio已安装并配置了WebSocket插件。接下来，通过npm或yarn安装库：

npm install obs-websocket-js
# 或者
yarn add obs-websocket-js

然后，在你的项目中引入并创建客户端实例：

const OBSWebSocket = require('obs-websocket-js');

// 创建OBS WebSocket客户端
const obs = new OBSWebSocket({
    address: 'localhost:4455', // 默认端口，根据实际情况调整
    password: 'your-password', // 设置的WebSocket密码
});

async function initConnection() {
    try {
        await obs.connect({ retryAttempts: 3 }); // 尝试连接三次
        console.log("Connected to OBS WebSocket");
        
        // 示例：获取OBS的版本信息
        const obsVersion = (await obs.call('GetVersion')).responseData.version;
        console.log(`OBS Version: ${obsVersion}`);
        
        // 监听事件，如场景变化
        obs.on('SceneChanged', data => {
            console.log(`Scene Changed: New Scene - ${data.sceneName}`);
        });
        
    } catch (error) {
        console.error("Error connecting to OBS:", error);
    }
}

initConnection();

记得替换 'your-password' 为实际设置的密码，并且确保OBS Studio已运行且WebSocket插件配置正确。