Devices

The Stream Deck SDK provides a list of available Stream Deck devices.

Array of available devices

import streamDeck from "@elgato/streamdeck";

streamDeck.devices.forEach((device) => {
	const { id, isConnected, name, size, type } = device;

	streamDeck.logger.info(name); // Stream Deck Neo, Stream Deck +
});

Connecting

Your plugin can monitor when a Stream Deck device is connected using the onDeviceDidConnect event.

Device connected callback

import streamDeck, { DeviceDidConnectEvent } from "@elgato/streamdeck";

streamDeck.devices.onDeviceDidConnect((ev: DeviceDidConnectEvent) => {
	const { id, isConnected, name, size, type } = ev.device;

	streamDeck.logger.info(name);
});

Changing

Your plugin can monitor when a Stream Deck device changes, for example its name or size, using the onDeviceDidChange event.

Device change callback

import streamDeck, { type DeviceDidChangeEvent } from "@elgato/streamdeck";

streamDeck.devices.onDeviceDidChange((ev: DeviceDidChangeEvent) => {
	const { id, isConnected, name, size, type } = ev.device;

	streamDeck.logger.info(name);
});

Availability

Monitoring device changes is available from Stream Deck 7.0

Disconnecting

Your plugin can monitor when a Stream Deck device disconnects using the onDeviceDidDisconnect event.

Device disconnected callback

import streamDeck, { DeviceDidDisconnectEvent } from "@elgato/streamdeck";

streamDeck.devices.onDeviceDidDisconnect((ev: DeviceDidDisconnectEvent) => {
	const { id, isConnected, name, size, type } = ev.device;

	streamDeck.logger.info(name);
});

Disconnected Device Visibility

While you can use these events to optimize resource utilization, the keys/encoders can still be visible in the Stream Deck app while the hardware is disconnected.

Hardware

Stream Deck hardware comes in many form factors.

Stream Deck Neo

Great workflows made easy. Meet Stream Deck Neo, an eight-key controller that makes everyday tasks fast and fun. So you can focus on bigger things.

• 8 customizable LCD keys.
• 2 capacitive touch buttons for paging.

Stream Deck

Stream Deck features 15 customizable LCD keys to control apps and platforms. Hit the store for app plugins, icons, tracks plus effects, and keep your setup fresh with interchangeable faceplates.

• 15 customizable LCD keys.

Stream Deck Scissor Keys

Same Stream Deck power, now with a sharper snap. Smooth, fast, and precise, each key press enables you to control apps, platforms, and devices like never before.

• 15 customizable LCD keys.

Stream Deck +

Iconic Stream Deck tech with customizable LCD keys, dials, and touch strip. Stream Deck + is your audio mixer, studio controller, production console – anything you want it to be.

• 8 customizable LCD keys.
• 4 dials with rotation and press, with touch strip.

Stream Deck XL

Boasting 32 customizable LCD keys poised to launch unlimited actions with a tap, Stream Deck XL takes production control to a whole new level.

• 32 customizable LCD keys.

Stream Deck Mini

With Stream Deck Mini, take full control of your content and focus on what matters most: your audience.

• 6 customizable LCD keys.

Stream Deck Pedal

Sturdy, customizable and discreet, Stream Deck Pedal gives you instant hands-free control of your apps and tools.

• 3 customizable pedals.

Stream Deck Studio

Iconic Elgato hardware powered by custom Bitfocus software. Meet Stream Deck Studio, a hyper-customizable control surface for pro broadcast systems. Built to simplify complex workflows.

• 32 customizable LCD keys.
• 2 dials with rotation and press.

Stream Deck Mobile

Stream Deck Mobile brings professional stream control, powerful integrations, and the iconic Stream Deck workflow to your iPhone or Android phone.

• Up to 64 customizable LCD keys.

SCUF Controller

Designed specifically for PC gaming, Envision has more inputs than your standard controller allowing you endless customization and the performance you need.

• 5 customizable macro buttons.

Corsair G-Keys

• 6 customizable macro keys.

Corsair Voyager

The Corsair Voyager combines cutting-edge gaming performance with the best of Corsair, powered by the latest AMD Ryzen™ processors and AMD Radeon™ graphics.

• Up to 10 customizable capacitive keys