Stream Deck

Stream Deck 是 Elgato 的快捷控制器应用。Protocol Launcher 可以生成 Stream Deck URL scheme 链接。

使用方式

这个库有两种使用方式：

• On-Demand 从子路径导入，支持 tree-shaking，能让产物更小。
• Full Import 从根包导入，适合快速脚本或演示，但会包含全部 app 模块。

生产构建建议选择 On-Demand；快速脚本或 demo 可以选择 Full Import。

选择安装方式

按需加载

推荐使用。生产环境优化。

全量导入

使用便捷。适合快速脚本。

URL Scheme

Elgato 官方 Stream Deck SDK 文档定义的插件 deep-link message 格式为：streamdeck://plugins/message/<PLUGIN_UUID>[path]["?" query]["#" fragment]。

Stream Deck 7.0 及之后版本也支持 passive deep-link，方式是添加官方文档中的 streamdeck=hidden query string 参数。

同一篇官方文档还记录了 OAuth2 redirect proxy URL 格式：https://oauth2-redirect.elgato.com/streamdeck/plugins/message/<PLUGIN_UUID>。除非授权服务商不接受 custom URL scheme，否则应优先使用插件 deep-link URL 作为 callback URL。

Plugin Message

向 Stream Deck 插件发送 deep-link message。

On-Demand

import { pluginMessage } from 'protocol-launcher/stream-deck'

const url = pluginMessage({
  pluginUuid: 'com.elgato.hello-world',
  path: '/hello',
  query: { name: 'Elgato' },
  fragment: 'waving',
})

在 Stream Deck 中打开

Passive Plugin Message

通过设置官方文档中的 streamdeck=hidden query 参数发送 passive deep-link message。

On-Demand

import { pluginMessage } from 'protocol-launcher/stream-deck'

const url = pluginMessage({
  pluginUuid: 'com.elgato.hello-world',
  path: '/hello',
  query: { streamdeck: 'hidden' },
})

打开 Passive Link

OAuth2 Redirect Proxy

生成官方文档中的 OAuth2 redirect proxy URL。

On-Demand

import { oauth2RedirectProxy } from 'protocol-launcher/stream-deck'

const url = oauth2RedirectProxy({
  pluginUuid: 'com.elgato.hello-world',
  path: '/auth',
})

打开 Redirect Proxy

Encoded OAuth2 Redirect Proxy

生成官方 URL Builder 展示的 encoded OAuth2 redirect proxy URL。

On-Demand

import { encodedOauth2RedirectProxy } from 'protocol-launcher/stream-deck'

const url = encodedOauth2RedirectProxy({
  pluginUuid: 'com.elgato.hello-world',
  path: '/auth',
})

生成的 URL

pluginMessage({
  pluginUuid: 'com.elgato.hello-world',
  path: '/hello',
  query: { name: 'Elgato' },
  fragment: 'waving',
})
// => 'streamdeck://plugins/message/com.elgato.hello-world/hello?name=Elgato#waving'

pluginMessage({
  pluginUuid: 'com.elgato.hello-world',
  path: '/hello',
  query: { streamdeck: 'hidden' },
})
// => 'streamdeck://plugins/message/com.elgato.hello-world/hello?streamdeck=hidden'

oauth2RedirectProxy({
  pluginUuid: 'com.elgato.hello-world',
  path: '/auth',
})
// => 'https://oauth2-redirect.elgato.com/streamdeck/plugins/message/com.elgato.hello-world/auth'

encodedOauth2RedirectProxy({
  pluginUuid: 'com.elgato.hello-world',
  path: '/auth',
})
// => 'https%3A%2F%2Foauth2-redirect.elgato.com%2Fstreamdeck%2Fplugins%2Fmessage%2Fcom.elgato.hello-world%2Fauth'

官方文档

• Stream Deck SDK Deep-Linking