streamdeck library
Classes
- ApplicationDidLaunchEvent
- Event received when a monitored application is launched.
- ApplicationDidTerminateEvent
- Event received when a monitored application is terminated.
- ApplicationPayload
- CommonReceivedEvent
- CommonReceivedPayload
- CommonSentEvent
- ContextPayload
- Coordinates
- Coordinates of the button on the device where this action was triggered.
- DeviceDidConnectEvent
- Event received when a Stream Deck device is connected.
- DeviceDidDisconnectEvent
- Event received when a Stream Deck device is disconnected.
- DeviceInfo
- Information about a Stream Deck device.
- DeviceSize
- The size (in columns and rows) of a Stream Deck device.
- DialPressEvent
- Event received when the user presses or releases the encoder (StreamDeck+ only).
- DialPressPayload
- DialRotateEvent
- Event received when the user rotates the encoder (StreamDeck+ only).
- DialRotatePayload
- DidReceiveGlobalSettingsEvent
-
Event received after calling the
getGlobalSettingsAPI to retrieve the persistent data stored for the action. - DidReceiveGlobalSettingsPayload
- DidReceiveSettingsEvent
-
Event received after calling the
getSettingsAPI to retrieve the persistent data stored for the action. - Event
- GetGlobalSettingsEvent
- An event sent to request that global settings are sent (via a DidReceiveGlobalSettingsEvent).
- GetSettingsEvent
- An event sent to request that settings are sent (via a DidReceiveSettingsEvent).
- KeyDownEvent
- Event received when a key on a Stream Deck is pressed down.
- KeyPayload
- KeyUpEvent
- Event received when a key on a Stream Deck is pressed released.
- LogMessageEvent
- Event sent to log a message to the plugins log file.
- LogMessagePayload
- OpenUrlEvent
- An event sent to tell the Stream Deck application to open a URL in the default browser.
- OpenUrlPayload
- Payload
- PropertyInspectorDidAppearEvent
- Event received when the Property Inspector appears in the Stream Deck user interface, for example when selecting a new instance.
- PropertyInspectorDidDisappearEvent
- Event received when the Property Inspector is removed from the Stream Deck user interface, for example when selecting a different instance.
- SendToPluginEvent
- An event sent by the Property Inspector to the plugin.
- SendToPropertyInspectorEvent
- An event sent by the plugin to the Property Inspector.
- ServiceInfo
- Information about the Stream Deck application and connected Stream Decks provided when the plugin process is started.
- SetFeedbackEvent
- Event sent to dynamically change the properties of items on the touch display (StreamDeck+ only).
- SetFeedbackLayoutEvent
- Event sent to dynamically change the touch display layout (StreamDeck+ only).
- SetFeedbackLayoutPayload
- SetGlobalSettingsEvent
- An event sent to persistent data globally.
- SetImageEvent
- Event sent to dynamically change the image displayed by an instance of an action.
- SetImagePayload
- SetSettingsEvent
- An event sent to persistent data for an actions instance.
- SetStateEvent
- Event sent to change the active state of an action supporting multiple states.
- SetStatePayload
- Event send to dynamically change the state of an action supporting multiple states.
- SetTitleEvent
- Event sent to dynamically change the title displayed by an instance of an action.
- SetTitlePayload
- ShowAlertEvent
- Event sent to temporarily show an alert icon on the image displayed by an instance of an action.
- ShowOkEvent
- Event sent to temporarily show an OK checkmark icon on the image displayed by an instance of an action.
- StreamDeckPlugin
- The base class for a Stream Deck plugin that connects to the Stream Deck.
-
StreamDeckPluginAction<
T extends StreamDeckPlugin> - SwitchToProfileEvent
- Event sent to switch the Stream Deck to a read-only profile preconfigured by the plugin.
- SwitchToProfilePayload
- SystemDidWakeUpEvent
- Event received when the computer wakes up.
- TitleParameters
- Parameters that control how a title is displayed.
- TitleParametersDidChangeEvent
- Event received when the user changes the title or title parameters.
- TitleParametersDidChangePayload
- TouchTapEvent
- Event received when the user touches the display (StreamDeck+ only).
- TouchTapPayload
- WillAppearEvent
- Event received when an instance of an action is about to be displayed on the Stream Deck.
- WillDisappearEvent
- Event received when an instance of an action is about to be removed from display on the Stream Deck.
Enums
- Target
- The target for a setTitle/setImage request indicating where the title/image should be updated.
- TitleAlignment
- Alignment for a title.
Mixins
- LongPressDetection
- Adds shortPress and longPress methods to allow an action to easily react to longer presses.
Typedefs
-
ActionConstructor
= StreamDeckPluginAction<
StreamDeckPlugin> Function(StreamDeckPlugin plugin, String context) -
PluginConstructor<
T extends StreamDeckPlugin> = T Function({required ServiceInfo info, IOSink? logSink, required String pluginUuid, required String registerEvent, required WebSocket socket}) -
SetFeedbackPayload
= Map<
String, String>