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文件中了解插件的元數據
• 捆綁您的插件以進行分發。
• 探索流甲板插件樣本