WebSocket API Changes
Learn more about changes related to building Stream Deck plugins using the Web Socket API.
Stream Deck
v7.0.0
-
Added
deviceDidChange
event.- Occurs when a devices' metadata or size changes.
- Learn more about listening to device changes.
- Added support for passive deep-link messages using the
?streamdeck=hidden
query parameter.- Passive deep-links messages will not bring Stream Deck to the foreground.
- Learn more about active vs passive deep-link message.
- Added
SupportedInKeyLogicActions
property to actions within the manifest.- When
false
, the action will not be usable within Key Logic actions. - Optional property; default is
true
.
- When
- Added device type for Virtual Stream Deck (11).
- Updated device
size
to reflect the visual size of the device.- Previously always 8 x 8 for Stream Deck Mobile and Virtual Stream Deck.
- Fixed an issue whereby linked plugins would not run on first launch after installing Stream Deck.
v6.9.0
- Added
SupportURL
option to the manifest:- When specified, users will see a help button above the property inspector of the selected action.
- Specifying a
SupportURL
at the root level (plugin) will apply to all actions. - Specifying a
SupportURL
at the action level will override the pluginSupportURL
. SupportURL
values are optional, but recommended.
- Added device type for Stream Deck Studio.
- Improved parsing of URLs when receiving deep-link messages, to support empty segments.
- Resolved an issue whereby updating a layout item's
zOrder
to the same value would result in an error. - Updated Node.js runtime to v20.19.0.
- Updated Chromium to v122.0.6261.171.
Property inspector event changes
As part of the upgrade to Chromium 122, the beforeunload
event is no longer emitted within the property inspector when the property inspector disappears.
Quality of life improvement
Stream Deck now will appear in the Dock on macOS when the main configuration window is active.
v6.7.0
- Added
isInMultiAction
to property inspector action information. - Updated Node.js runtime to v20.15.0
- Updated Chromium to v118.0.5993.220.
v6.6.0
- Added support for Stream Deck Neo, and SCUF controllers.
- Added support for OS-specific actions via
Actions[].OS
within the manifest. - Added the ability to disable automatically installing pre-defined profiles, when a plugin is installed, via
Profiles[].AutoInstall
within the manifest.
v6.5.0
warning
Please note, from Stream Deck 6.5 onwards, dialPress
will not be emitted by the API. Plugins should use dialDown
and dialUp
to receive events relating to dial presses.
- Added support for receiving deep-link messages.
- Added support for switching to a specific profile page when calling
switchToProfile
. - Added
controller
information toWillAppear
andWillDisappear
events for multi-actions. - Added support for Node.js plugins with the
.cjs
or.mjs
file extensions. - Removed
dialPress
event in favour ofdialDown
anddialUp
. - Updated Node.js runtime to v20.8.1.
v6.4.0
- Added support for Node.js plugins (beta).
- Added
DisableAutomaticStates
option to manifest. - Added
setTriggerDescription
command for Stream Deck + encoders. - Added
range
to BAR layout item. - Added
range
to GBAR layout item. - Added
text-overflow
to TEXT layout item. - Deprecated support for installing plugins using the
streamdeck://
scheme.
v6.1.0
- Add
dialDown
event for Stream Deck + encoders. - Add
dialUp
event for Stream Deck + encoders. - Deprecated
dialPress
event for Stream Deck + encoders.
v6.0.0
- Add support for Stream Deck +.
- Add
UserTitleEnabled
property to the manifest. - Add
Encoder
to the manifest for Stream Deck + devices. - Add
TriggerDescription
to the manifest for Stream Deck + devices. - Add
Layouts
for Stream Deck + displays. - Add
setFeedback
event for Stream Deck + displays. - Add
setFeedbackLayout
event for Stream Deck + displays. - Add
touchTap
event for Stream Deck + displays. - Add
dialPress
event for Stream Deck + encoders. - Add
dialRotate
event for Stream Deck + encoders. - Update
willAppear
andwillDisappear
events to include thecontroller
property.
Archive
Stream Deck v5
v5.3.0
- Add support for Corsair Voyager.
v5.2.0
- Add support for Stream Deck Pedal.
v5.0.0
- Add support for SVG icons.
- Update property inspector to receive
didReceiveGlobalSettings
whensetGlobalSettings
is called from the plugin. - Update information parameter to include operating system information.
Stream Deck v4
v4.8.0
- You can now specify in the
setImage
event on which state the image should be set. This change only applies to actions with two states. If no state is specified, the image is set to both states. - You can now specify in the
setTitle
event on which state the title should be set. This change only applies to actions with two states. If no state is specified, the title is set to both states.
v4.7.0
- Add support for Corsair G Keys.
v4.6.0
- Update
switchToProfile
command to work with editable pre-configured profile.
v4.5.1
- Update
setImage
command to accept SVG images.
v4.3.3
- Add
DontAutoSwitchWhenInstalled
option in themanifest.json
; whentrue
, Stream Deck will not automatically switch to the pre-configured profile that was installed.
v4.3.0
- Add support for Stream Deck XL.
- Add support for Stream Deck Mobile.
- Add
systemDidWakeUp
event when computer wakes from sleep. - Update image rendering to always prefer user defined images.
- Update
deviceDidConnect
event to include device name.
v4.2.0
- Update
willAppear
andwillDisappear
events to be sent inside Multi-Actions. - Update
switchToProfile
command to temporarily disable Smart Profile switching. - Update
switchToProfile
command to prompt the user to install the profile, if it is not installed. - Update Smart Profile switching so that it is disabled whilst Stream Deck is open.
- Update information parameter to include plugin version.