Profiles

Fresh

Source

Elgato Stream Deck SDK - Profiles

Overview

Profiles are shareable layouts specific to a Stream Deck device that include pre-defined actions, icons, and settings.

SOP: Bundle a Profile

Step 1: Create the Profile

1. Open the Stream Deck app
2. Drag plugin actions onto the canvas and configure them
3. Export the profile via Preferences as a .streamDeckProfile file

Step 2: Add to Plugin

Place the exported .streamDeckProfile file in your *.sdPlugin directory.

Step 3: Register in Manifest

{
  "Profiles": [
    {
      "Name": "profiles/my-profile",
      "DeviceType": 0,
      "Readonly": false,
      "DontAutoSwitchWhenInstalled": false,
      "AutoInstall": true
    }
  ]
}

Property	Description
Name	File path without extension
DeviceType	Target device type ID
Readonly	Whether users can modify
DontAutoSwitchWhenInstalled	Prevent auto-switch on install
AutoInstall	Prompt user on first install (default: true)

Profile Switching

Programmatically switch to bundled profiles:

await streamDeck.profiles.switchToProfile(deviceId, "profiles/my-profile");

Limitation

Plugins can only switch to profiles distributed with the plugin. User-defined profiles are not accessible.