streamdeck

Stream Deck SDK

欢迎来到Stream Deck SDK - 旨在使流台甲板的创建插件变得容易，Stream Deck SDK提供了与Stream Deck应用程序连接和通信所需的一切，使您专注于有趣的东西。

使用node.js创建流甲板插件需要node.js v20。安装node.js时，我们建议使用版本管理器，例如NVM（MACOS）或NVM-Windows（Windows）。

快速开始

Stream Deck CLI提供了用于创建，测试和捆绑插件的命令，并且是开始为流甲板构建的最简单方法。您还可以了解有关入门文档的更多信息。

1. 安装Node.js，安装CLI。

npm install -g @elgato/cli@latest

2. 安装后，运行create命令以初始化创建向导。

streamdeck create

文件结构

使用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安继承的类，使您的插件能够从流甲板接收事件，例如键向下，拨号旋转等。

以下是聆听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" ) ;
    }
} 

？调试

可以使用任何node.js调试器进行调试，例如Visual Studio Code，Chrome等，默认情况下，使用流式甲板Cli cli streamdeck create命令创建时将启用调试。

您可以在清单的Node.js配置中配置调试。

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

在清单中配置Debug属性时，有四个可用的选项：

• "enabled" - 插件将运行--inspect允许调试者连接。
• "break" - 插件将与--inspect-brk启动，并将在运行前等待附加的调试器。
• string - 提供给插件的CLI参数集合。
• undefined - 调试被禁用。

在调试模式"enabled"或“断路”以“启用”或"break"运行插件时，每次插件启动时，都会将随机可用端口分配给调试侦听器。如果您想在特定端口上聆听，则可以将Debug值设置为CLI参数的字符串，例如在端口12345上侦听， Debug值将为--inspect=127.0.0.1:12345 。

进一步阅读

• 进行第一个更改。
• 了解密钥和拨号操作。
• 在清单JSON文件中了解插件的元数据
• 捆绑您的插件以进行分发。
• 探索流甲板插件样本