Stream Kit Docs
API ReferenceStream Deck

Will Disappear

Stream Deck trigger: stream-deck:stream-deck:will-disappear

Will Disappear

Trigger IDstream-deck:stream-deck:will-disappear
PluginStream Deck
CategoryStream Deck

Variables

Copy variables into handler fields using {variableName} syntax.

{type}{context}{device}{action}{alias}{coordinates}{settings}{isInMultiAction}{ticks}{pressed}{lastEventAt}{payload}
NameTypeDescription
{type}
object

Stream Deck event type (`keyDown`, `keyUp`, `dialRotate`, …).

{context}
string

Stream Deck action instance context id.

Example: test-context

{device}
string

Stream Deck device identifier.

Example: test-device

{action}
string

Stream Deck action UUID that fired the event.

Example: app.stream-kit.streamdeck.run-action

{alias}
string

Optional button alias configured in Stream Kit.

Example: test-button

{coordinates}
object

Button coordinates on the Stream Deck (`column`, `row`).

{settings}
string

Action settings object from the Stream Deck button.

{isInMultiAction}
boolean

Whether the button is part of a multi-action.

Example: false

{ticks}
number

Dial rotation ticks (dial events only).

{pressed}
boolean

Whether the dial was pressed while rotating.

{lastEventAt}
string

ISO timestamp of the latest Stream Deck event.

{payload}
string

Extra event payload object (overlay events, Stream Deck settings extras, etc.).

On this page