欢迎使用 Stream Deck SDK —— 设计是为了让 Stream Deck 容易创建插件, Stream Deck SDK 提供您需要的一切与 Stream Deck app 连接和通信,让你专注于有趣的东西.

创建带有节点.js的流德克插件需要节点.js 24或更高,和流德克 7.1或更高. 在安装Node.js时,我们建议使用一个版本管理器,例如 数字 (macOS) 或 (中文(简体) ) nvm 窗口 (温道.

QQ 快速启动

这个 流出地标 CLI 为创建、测试和捆绑您的插件提供命令,并且是最容易为 Stream Deck 开始构建的方法。 你也可以这样 学习更多开始 我们的文件.

1. 随着Node.js的安装,安装了CLI.

npm install -g @elgato/cli@latest

2. 一旦安装,运行 create 命令以初始化创建向导.

streamdeck create

QQ 文件结构

在创建插件后 streamdeck create 您将获得一个本地环境来构建插件 .

/
├── *.sdPlugin/
│   ├── bin/
│   ├── imgs/
│   ├── logs/
│   ├── ui/
│   │   └── increment-counter.html
│   └── manifest.json
├── src/
│   ├── actions/
│   │   └── increment-counter.ts
│   └── plugin.ts
├── package.json
├── rollup.config.mjs
└── tsconfig.json

这个 package.json 为构建插件提供两个脚本.

• npm run build - 构建插件.
• npm run watch - 持续监视修改,并在构建后热重装插件.

行动

动作是显示的明星, 并允许用户与您的插件交互 。 动作作为继承 SingletonAction,使您的插件能够接收 Stream Deck 的事件,例如密钥下移、拨号等.

下面是一例行动,它倾听 keyDown ,然后设置源动作的标题.

import { action, KeyDownEvent, SingletonAction } from "@elgato/streamdeck";

@action({ UUID: "com.elgato.hello-world.say-hello" })
export class SayHelloAction extends SingletonAction {
    /**
     * Listen for the key down event that occurs when a user presses
     * a Stream Deck button, and change the title of the action.
     */
    async onKeyDown(ev: KeyDownEvent) {
        await ev.action.setTitle("Hello world");
    }
}

调试

插件可以使用任何节点.js调试器来调试,例如Visual Studio代码,Chrome等,默认情况下,在使用 Stream Deck CLI 创建时会启用调试 streamdeck create 命令.

您可以在其中配置调试 显示为节点.js配置。 。 。 .

{
    // ...
    "Nodejs": {
        "Version": "24",
        "Debug": "enabled",
    },
}

在配置 Debug 清单中的财产:

• "enabled" - 插件将随运行 --inspect 允许调试器连接 .
• "break" - 插件将随 --inspect-brk 等待一个调试者,然后运行.
• string - 一组 CLI 参数 提供给插件.
• undefined -调试被禁用.

在调试模式下运行插件时 "enabled" 或者说 "break",每次启动插件时都会向调试听器分配一个随机可用的端口。 如果你想在某个特定端口听 Debug 值可以设置为字符串的 CLI 参数, 例如在端口上听 12345,则 Debug 数值将是 --inspect=127.0.0.1:12345。 。 。 .

进一步阅读

• 第一次改变。 。 。 .
• 学习 键 财务报告和审定财务报表 拨号 行动.
• 了解您插件中的元数据 显示 JSON 文件
• 套装您的插件 分配。 。 。 .
• 探索 流出 Deck 插件示例。 。 。 .