[−][src]Enum streamdeck_rs::Message
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.
Variants
KeyDown
A key has been pressed.
Fields of KeyDown
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.
Fields of KeyUp
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.
Fields of WillAppear
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.
Fields of WillDisappear
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.
Fields of TitleParametersDidChange
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.
Fields of DeviceDidConnect
device: String
The ID of the device that has connected.
device_info: DeviceInfo
Information about the device.
DeviceDidDisconnect
A device has disconnected.
Fields of DeviceDidDisconnect
device: String
The ID of the device that has disconnected.
ApplicationDidLaunch
An application monitored by the manifest file has launched.
Fields of ApplicationDidLaunch
payload: ApplicationPayload
Information about the launched application.
ApplicationDidTerminate
An application monitored by the manifest file has terminated.
Fields of ApplicationDidTerminate
payload: ApplicationPayload
Information about the terminated application.
SendToPlugin
The property inspector has sent data.
Fields of SendToPlugin
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.
Fields of DidReceiveSettings
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.
Fields of PropertyInspectorDidAppear
PropertyInspectorDidDisappear
The property inspector for an action is no longer visible.
Fields of PropertyInspectorDidDisappear
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.
Fields of DidReceiveGlobalSettings
payload: GlobalSettingsPayload<G>
The current settings for the action.
SystemDidWakeUp
The computer has resumed from sleep.
Added in Stream Deck software version 4.3.
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>
[src]
impl<'de, G, S, M> Deserialize<'de> for Message<G, S, M> where
G: Deserialize<'de>,
S: Deserialize<'de>,
M: Deserialize<'de>,
[src]
G: Deserialize<'de>,
S: Deserialize<'de>,
M: Deserialize<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
[src]
__D: Deserializer<'de>,
Auto Trait Implementations
impl<G, S, M> Send for Message<G, S, M> where
G: Send,
M: Send,
S: Send,
G: Send,
M: Send,
S: Send,
impl<G, S, M> Sync for Message<G, S, M> where
G: Sync,
M: Sync,
S: Sync,
G: Sync,
M: Sync,
S: Sync,
Blanket Implementations
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> From<T> for T
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> DeserializeOwned for T where
T: Deserialize<'de>,
[src]
T: Deserialize<'de>,
impl<T> Erased for T
impl<T> Same<T> for T
type Output = T
Should always be Self
impl<T> SendSyncUnwindSafe for T where
T: Send + Sync + UnwindSafe + ?Sized,
[src]
T: Send + Sync + UnwindSafe + ?Sized,