Enum MessageOut

pub enum MessageOut<G, S, M> {
    SetTitle {
        context: String,
        payload: TitlePayload,
    },
    SetImage {
        context: String,
        payload: ImagePayload,
    },
    ShowAlert {
        context: String,
    },
    ShowOk {
        context: String,
    },
    GetSettings {
        context: String,
    },
    SetSettings {
        context: String,
        payload: S,
    },
    SetState {
        context: String,
        payload: StatePayload,
    },
    SendToPropertyInspector {
        action: String,
        context: String,
        payload: M,
    },
    SwitchToProfile {
        context: String,
        device: String,
        payload: ProfilePayload,
    },
    OpenUrl {
        payload: UrlPayload,
    },
    GetGlobalSettings {
        context: String,
    },
    SetGlobalSettings {
        context: String,
        payload: G,
    },
    LogMessage {
        payload: LogMessagePayload,
    },
}

A message to be sent to the Stream Deck software.

• G represents the global settings that are persisted within the Stream Deck software.
• S represents the action settings that are persisted within the Stream Deck software.
• M represents the messages that are sent to the property inspector.

Official Documentation

Variants

SetTitle

Set the title of an action instance.

Official Documentation

Fields

context: String

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

payload: TitlePayload

The title to set.

SetImage

Set the image of an action instance.

Official Documentation

Fields

context: String

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

payload: ImagePayload

The image to set.

ShowAlert

Temporarily overlay the key image with an alert icon.

Official Documentation

Fields

context: String

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

ShowOk

Temporarily overlay the key image with a checkmark.

Official Documentation

Fields

context: String

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

GetSettings

Retrieve settings for an instance of an action via DidReceiveSettings.

Official Documentation

Fields

context: String

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

SetSettings

Store settings for an instance of an action.

Official Documentation

Fields

context: String

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

payload: S

The settings to save.

SetState

Set the state of an action.

Normally, Stream Deck changes the state of an action automatically when the key is pressed.

Official Documentation

Fields

context: String

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

payload: StatePayload

The desired state.

SendToPropertyInspector

Send data to the property inspector.

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

The message to send.

SwitchToProfile

Select a new profile.

Official Documentation

Fields

context: String

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

device: String

The device to change the profile of.

payload: ProfilePayload

The profile to activate.

OpenUrl

Open a URL in the default browser.

Official Documentation

Fields

payload: UrlPayload

The url to open.

GetGlobalSettings

Retrieve plugin settings for via DidReceiveGlobalSettings.

Official Documentation

Fields

context: String

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

SetGlobalSettings

Store plugin settings.

Official Documentation

Fields

context: String

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

payload: G

The settings to save.

LogMessage

Write to the log.

Official Documentation

Fields

payload: LogMessagePayload

The message to log.

Trait Implementations

impl<G: Debug, S: Debug, M: Debug> Debug for MessageOut<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 MessageOut<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 MessageOut<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.

impl<G, S, MI, MO> Sink<MessageOut<G, S, MO>> for StreamDeckSocket<G, S, MI, MO>

where G: Serialize, S: Serialize, MO: Serialize,

type Error = StreamDeckSocketError

The type of value produced by the sink when an error occurs.

fn poll_ready( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Result<(), Self::Error>>

Attempts to prepare the Sink to receive a value.

fn start_send( self: Pin<&mut Self>, item: MessageOut<G, S, MO>, ) -> Result<(), Self::Error>

Begin the process of sending a value to the sink. Each call to this function must be preceded by a successful call to poll_ready which returned Poll::Ready(Ok(())).

fn poll_flush( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Result<(), Self::Error>>

Flush any remaining output from this sink.

fn poll_close( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Result<(), Self::Error>>

Flush any remaining output and close this sink, if necessary.