# @elgato/streamdeck 中文文档

规范地址：https://npmcn.com/package/%40elgato/streamdeck/

版本：3\.0\.4
npm 元数据更新时间：2026-10-29T14:39:24.024Z
中文译文更新时间：2026-11-13T12:24:43.641Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40elgato/streamdeck
原文对照：https://npmcn.com/package/%40elgato/streamdeck/?lang=original
项目主页：https://github.com/elgatosf/streamdeck#readme
源码仓库：https://github.com/elgatosf/streamdeck

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：201 kB，115 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=20\.5\.1
- 运行依赖：3 个
- 首次发布：2023-08-23T12:49:21.544Z
- 最新版本发布：2026-10-29T14:39:23.390Z
- 近 30 天下载量：71491（2026-10-14 至 2026-11-12，npm 官方下载统计）
- 已发布版本数：49（近 12 个月 19 个）

## 中文简介

用于创建 Stream Deck 插件的官方节点.js SDK.

## 安装

```sh
npm install @elgato/streamdeck
```

也可以使用：`pnpm add @elgato/streamdeck`、`yarn add @elgato/streamdeck`、`bun add @elgato/streamdeck`

## README

[![Stream Deck SDK banner](https://images.ctfassets.net/8j9xr8kwdre8/1ihLKCwNWEfPixs27dq0c0/130be66a5173f332e4caa892a3462893/banner.png)](https://docs.elgato.com/sdk)

# 流出地标 SDK

[![SDK documentation](https://img.shields.io/badge/Documentation-2ea043?labelColor=grey&logo=gitbook&logoColor=white)](https://docs.elgato.com/sdk) [![Elgato homepage](https://img.shields.io/badge/Elgato-3431cf?labelColor=grey&logo=elgato)](https://elgato.com/) [![Join the Marketplace Makers Discord](https://img.shields.io/badge/Marketplace%20Makers-5662f6?labelColor=grey&logo=discord&logoColor=white)](https://discord.gg/GehBUcu627) [![Stream Deck npm package](https://img.shields.io/npm/v/%40elgato/streamdeck?logo=npm&logoColor=white)](https://www.npmjs.com/package/@elgato/streamdeck) [![Build status](https://img.shields.io/github/actions/workflow/status/elgatosf/streamdeck/build.yml?branch=main&label=Build&logo=GitHub)](https://github.com/elgatosf/streamdeck/actions)

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

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

## QQ 快速启动

这个 [流出地标 CLI](https://github.com/elgatosf/cli) 为创建、测试和捆绑您的插件提供命令,并且是最容易为 Stream Deck 开始构建的方法。 你也可以这样 [学习更多开始](https://docs.elgato.com/streamdeck/sdk/introduction/getting-started) 我们的文件.

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

```bash
npm install -g @elgato/cli@latest
```

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

```bash
streamdeck create
```

![](https://npmcn.com/package/%40elgato/streamdeck/assets/cli-create.gif)

## 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` ,然后设置源动作的标题.

```typescript
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配置](https://docs.elgato.com/streamdeck/sdk/references/manifest#nodejs)。 。 。 .

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

在配置 `Debug` 清单中的财产:

-   `"enabled"` - 插件将随运行 [`--inspect`](https://nodejs.org/api/cli.html#--inspecthostport) 允许调试器连接 .
-   `"break"` - 插件将随 [`--inspect-brk`](https://nodejs.org/api/cli.html#--inspect-brkhostport) 等待一个调试者,然后运行.
-   `string` - 一组 [CLI 参数](https://nodejs.org/api/cli.html) 提供给插件.
-   `undefined` -调试被禁用.

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

## 进一步阅读

-   [第一次改变](https://docs.elgato.com/streamdeck/sdk/introduction/your-first-changes)。 。 。 .
-   学习 [键](https://docs.elgato.com/streamdeck/sdk/guides/keys) 财务报告和审定财务报表 [拨号](https://docs.elgato.com/streamdeck/sdk/guides/dials) 行动.
-   了解您插件中的元数据 [显示 JSON 文件](https://docs.elgato.com/streamdeck/sdk/references/manifest)
-   套装您的插件 [分配](https://docs.elgato.com/streamdeck/sdk/guides/distribution)。 。 。 .
-   探索 [流出 Deck 插件示例](https://npmcn.com/package/%40elgato/streamdeck/examples/README.md)。 。 。 .

## 常见问题

### @elgato/streamdeck 是什么？

用于创建 Stream Deck 插件的官方节点\.js SDK\.

### 如何安装 @elgato/streamdeck？

在项目目录运行 npm install @elgato/streamdeck，或使用 pnpm add / yarn add / bun add。

### @elgato/streamdeck 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @elgato/streamdeck 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @elgato/streamdeck 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=20\.5\.1。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @elgato/streamdeck 可以商用吗？

@elgato/streamdeck 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @elgato/streamdeck 的下载量有多少？

根据 npm 官方下载统计，@elgato/streamdeck 在 2026/10/14 – 2026/11/12 这 30 天内被下载 71,491 次，日均约 2,383 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @elgato/streamdeck 还在维护吗？

最新版本 3\.0\.4 发布于 2026/10/29（15 天前）；至今共发布 49 个版本，其中过去 12 个月发布了 19 个；首次发布于 2023/08/23。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。