OBS Studio Node.js SDK 教程

柯茵沙

于 2024-08-22 08:12:06 发布

阅读量847

点赞数 12

本文链接：https://blog.youkuaiyun.com/gitblog_00236/article/details/141408051

版权

OBS Studio Node.js SDK 教程

项目地址:https://gitcode.com/gh_mirrors/ob/obs-studio-node

项目介绍

OBS Studio Node.js SDK 是一个专为Node.js开发者设计的库，旨在简化与OBS Studio交互的过程。它允许开发者通过JavaScript控制OBS Studio的各个方面，包括场景切换、源管理等，无需依赖复杂的脚本或直接操作OBS内部配置。这个开源项目基于GitHub上的仓库 stream-labs/obs-studio-node，为直播流媒体、自动化制作和其他交互式视频内容开发提供强大支持。

项目快速启动

安装SDK

首先，确保你的开发环境已经安装了Node.js。然后，可以通过npm来安装OBS Studio Node.js SDK：

npm install obs-websocket-js

注意，虽然仓库名提到的是obs-studio-node, 实际上应使用的包名为obs-websocket-js，因为这是该项目最新维护的版本并且遵循OBS Studio的WebSocket协议。

连接OBS Studio

接下来，初始化一个连接到本地运行的OBS实例：

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

async function connectToOBS() {
    const obs = new OBSWS("ws://localhost:4444", "password"); // 确保在OBS中设置了正确的密码
    await obs.connect();
    
    console.log("Connected to OBS Studio.");
    
    // 一些基本的操作示例
    obs.send("SetCurrentScene", { "scene-name": "Main Scene" }, (err, res) => {
        if (err) {
            console.error(err);
        } else {
            console.log("Scene changed successfully.");
        }
    });
    
    // 在适当的位置处理断开连接和错误事件
    obs.on(OBSWS.Events.Error, err => console.error(err));
    obs.on(OBSWS.Events.Disconnect, () => console.log("Disconnected from OBS."));
}

connectToOBS();

请记得在OBS Studio设置里启用WebSocket插件并设置密码。