Enum Message

pub enum Message<G, S, M> {
    KeyDown {
        action: String,
        context: String,
        device: String,
        payload: KeyPayload<S>,
    },
    KeyUp {
        action: String,
        context: String,
        device: String,
        payload: KeyPayload<S>,
    },
    WillAppear {
        action: String,
        context: String,
        device: Option<String>,
        payload: VisibilityPayload<S>,
    },
    WillDisappear {
        action: String,
        context: String,
        device: Option<String>,
        payload: VisibilityPayload<S>,
    },
    TitleParametersDidChange {
        action: String,
        context: String,
        device: Option<String>,
        payload: TitleParametersPayload<S>,
    },
    DeviceDidConnect {
        device: String,
        device_info: DeviceInfo,
    },
    DeviceDidDisconnect {
        device: String,
    },
    ApplicationDidLaunch {
        payload: ApplicationPayload,
    },
    ApplicationDidTerminate {
        payload: ApplicationPayload,
    },
    SendToPlugin {
        action: String,
        context: String,
        payload: M,
    },
    DidReceiveSettings {
        action: String,
        context: String,
        device: String,
        payload: KeyPayload<S>,
    },
    PropertyInspectorDidAppear {
        action: String,
        context: String,
        device: String,
    },
    PropertyInspectorDidDisappear {
        action: String,
        context: String,
        device: String,
    },
    DidReceiveGlobalSettings {
        payload: GlobalSettingsPayload<G>,
    },
    SystemDidWakeUp,
    Unknown,
}

A message received from the Stream Deck software.

• G represents the global settings that are persisted within the Stream Deck software.
• S represents the settings that are persisted within the Stream Deck software.
• M represents the messages that are received from the property inspector.

Official Documentation

Variants

KeyDown

A key has been pressed.

Official Documentation

Fields

action: String

The uuid of the action.

context: String

The instance of the action (key or part of a multiaction).

device: String

The device where the key was pressed.

payload: KeyPayload<S>

Additional information about the key press.

KeyUp

A key has been released.

Official Documentation

Fields

action: String

The uuid of the action.

context: String

The instance of the action (key or part of a multiaction).

device: String

The device where the key was pressed.

payload: KeyPayload<S>

Additional information about the key press.

WillAppear

An instance of the action has been added to the display.

Official Documentation

Fields

action: String

The uuid of the action.

context: String

The instance of the action (key or part of a multiaction).

device: Option<String>

The device where the action will appear, or None if it does not appear on a device.

payload: VisibilityPayload<S>

Additional information about the action’s appearance.

WillDisappear

An instance of the action has been removed from the display.

Official Documentation

Fields

action: String

The uuid of the action.

context: String

The instance of the action (key or part of a multiaction).

device: Option<String>

The device where the action was visible, or None if it was not on a device.

payload: VisibilityPayload<S>

Additional information about the action’s appearance.

TitleParametersDidChange

The title has changed for an instance of an action.

Official Documentation

Fields

action: String

The uuid of the action.

context: String

The instance of the action (key or part of a multiaction).

device: Option<String>

The device where the action is visible, or None if it is not on a device.

payload: TitleParametersPayload<S>

Additional information about the new title.

DeviceDidConnect

A device has connected.

Official Documentation

Fields

device: String

The ID of the device that has connected.

device_info: DeviceInfo

Information about the device.

DeviceDidDisconnect

A device has disconnected.

Official Documentation

Fields

device: String

The ID of the device that has disconnected.

ApplicationDidLaunch

An application monitored by the manifest file has launched.

Official Documentation

Fields

payload: ApplicationPayload

Information about the launched application.

ApplicationDidTerminate

An application monitored by the manifest file has terminated.

Official Documentation

Fields

payload: ApplicationPayload

Information about the terminated application.

SendToPlugin

The property inspector has sent data.

Official Documentation

Fields

action: String

The uuid of the action.

context: String

The instance of the action (key or part of a multiaction).

payload: M

Information sent from the property inspector.

DidReceiveSettings

The application has sent settings for an action.

This message is sent in response to GetSettings, but also after the property inspector changes the settings.

Official Documentation

Fields

action: String

The uuid of the action.

context: String

The instance of the action (key or part of a multiaction).

device: String

The device where the action exists.

payload: KeyPayload<S>

The current settings for the action.

PropertyInspectorDidAppear

The property inspector for an action has become visible.

Official Documentation

Fields

action: String

The uuid of the action.

context: String

The instance of the action (key or part of a multiaction).

device: String

The device where the action exists.

PropertyInspectorDidDisappear

The property inspector for an action is no longer visible.

Official Documentation

Fields

action: String

The uuid of the action.

context: String

The instance of the action (key or part of a multiaction).

device: String

The device where the action exists.

DidReceiveGlobalSettings

The application has sent settings for an action.

This message is sent in response to GetGlobalSettings, but also after the property inspector changes the settings.

Official Documentation

Fields

payload: GlobalSettingsPayload<G>

The current settings for the action.

SystemDidWakeUp

The computer has resumed from sleep.

Added in Stream Deck software version 4.3.

Official Documentation

Unknown

An event from an unsupported version of the Stream Deck software.

This occurs when the Stream Deck software sends an event that is not understood. Usually this will be because the Stream Deck software is newer than the plugin, and it should be safe to ignore these.

Trait Implementations

impl<G: Debug, S: Debug, M: Debug> Debug for Message<G, S, M>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de, G, S, M> Deserialize<'de> for Message<G, S, M>

where G: Deserialize<'de>, S: Deserialize<'de>, M: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<G, S, M> Serialize for Message<G, S, M>

where G: Serialize, S: Serialize, M: Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.