Stream Deck SDK

Appearance

System ​

Fresh

Source

Elgato Stream Deck SDK - System

Opening URLs ​

Direct users to websites using the system API:

typescript
import streamDeck from "@elgato/streamdeck";

streamDeck.actions.onKeyDown(() => {
  streamDeck.system.openUrl("https://elgato.com");
});

streamDeck.connect();

WARNING

All URLs open in the user's default browser. Custom URL schemes (e.g., my-app://) are not yet supported by the SDK.

System Wake ​

When the system wakes from sleep, plugins receive:

  1. onWillAppear events for all visible actions
  2. A one-time onSystemDidWakeUp event

Use this to restore connections (WebSockets, IPC, etc.):

typescript
import streamDeck from "@elgato/streamdeck";

streamDeck.system.onSystemDidWakeUp((ev) => {
  // Reconnect WebSocket, restore IPC, etc.
});

streamDeck.connect();

INFO

onSystemDidWakeUp is only available in the plugin context, not in the Property Inspector.