Structures

The following structures are available globally.

  • Manages a plugins lifecycle and handling launch from the Stream Deck application.

    See more

    Declaration

    Swift

    public struct PluginCommand : ParsableCommand

Received

  • The root object to decode a received event.

    See more

    Declaration

    Swift

    public struct ReceivableEvent : Decodable

  • Events sent by the server in response to actions.

    See more

    Declaration

    Swift

    public struct ActionEvent<Payload> : Decodable where Payload : Decodable

  • Events sent by the server that do not have an associated action instance.

    See more

    Declaration

    Swift

    public struct Event<Payload> : Decodable where Payload : Decodable

  • Device connection events sent by the server.

    See more

    Declaration

    Swift

    public struct DeviceConnectionEvent : Decodable

Settings Events

  • Action instance settings received after calling getSettings().

    See more

    Declaration

    Swift

    public struct SettingsEvent<S> : Decodable where S : Decodable

  • Global settings received after calling getGlobalSettings().

    See more

    Declaration

    Swift

    public struct GlobalSettingsEvent<S> : Decodable where S : Decodable

Appear Events

  • Information received about a willAppear or willDisappear event.

    See more

    Declaration

    Swift

    public struct InstanceAppearEvent : Decodable, Hashable, Locatable

  • Information received about a willAppear or willDisappear event.

    See more

    Declaration

    Swift

    public struct AppearEvent<S> : Decodable, Hashable, Locatable where S : Decodable, S : Hashable

Controller Events

  • Information received about a keyUp or keyDown event.

    See more

    Declaration

    Swift

    public struct KeyEvent<S> : Decodable, Hashable, Locatable where S : Decodable, S : Hashable

  • Information received about a rotary encoder event.

    See more

    Declaration

    Swift

    public struct EncoderEvent<S> : Decodable, Hashable, Locatable where S : Decodable, S : Hashable

  • Information received about a rotary encoder event.

    See more

    Declaration

    Swift

    public struct EncoderPressEvent<S> : Decodable, Hashable, Locatable where S : Decodable, S : Hashable

  • Information received about a keyUp or keyDown event.

    See more

    Declaration

    Swift

    public struct TouchTapEvent<S> : Decodable, Hashable, Locatable where S : Decodable, S : Hashable
  • See more

    Declaration

    Swift

    public struct SendToPluginEvent : Decodable

Application Events

  • Basic type for application events.

    • applicationDidLaunch
    • applicationDidTerminate
    See more

    Declaration

    Swift

    public struct ApplicationEvent : Decodable

Property Inspector Events

  • The basic type for decoding property inspector events.

    • propertyInspectorDidAppear
    • propertyInspectorDidDisappear
    • sendToPlugin
    • sendToPropertyInspector
    See more

    Declaration

    Swift

    public struct PropertyInspectorEvent : Decodable

  • A struct that indicates an action has no settings.

    Declaration

    Swift

    public struct NoSettings : Codable, Hashable

  • The coordinates of the action triggered.

    See more

    Declaration

    Swift

    public struct Coordinates : Decodable, Hashable

  • Keys marked as exported are expected to be set by an action before it finishes.

    ImportedContext checks whether a key has been registered by a previous ExportedContext.

    See more

    Declaration

    Swift

    @propertyWrapper
public struct Environment<K> : CustomReflectable where K : EnvironmentKey

  • The central registry of EnvironmentKey and their values.

    See more

    Declaration

    Swift

    public struct EnvironmentValues

  • Information about the title of an action.

    See more

    Declaration

    Swift

    public struct TitleInfo<S> : Decodable, Locatable where S : Decodable

  • Information received about the Stream Deck device.

    See more

    Declaration

    Swift

    public struct DeviceInfo : Decodable

  • The size of a device.

    See more

    Declaration

    Swift

    public struct Size : Decodable

  • The registration information sent by the Stream Deck application when launching the plugin.

    See more

    Declaration

    Swift

    public struct PluginRegistrationInfo : Decodable, CustomStringConvertible

  • Information about the Stream Deck application.

    See more

    Declaration

    Swift

    public struct StreamDeckApp : Decodable, CustomStringConvertible

  • Information about the plugin.

    See more

    Declaration

    Swift

    public struct PluginInfo : Decodable, CustomStringConvertible

  • The states an action can show.

    See more

    Declaration

    Swift

    public struct PluginActionState : Codable

  • Supported operating systems of a plugin.

    See the OS section for more information

    See more

    Declaration

    Swift

    public struct PluginOS : Codable

  • The minimum version of the Stream Deck application supported.

    See more

    Declaration

    Swift

    public struct PluginSoftware : Codable

  • A plugin can request to be notified when some applications are launched or terminated.

    In order to do so, the ApplicationsToMonitor object should contain for each platform an array specifying the list of application identifiers to monitor.

    Note

    On macOS the application bundle identifier is used while the exe filename is used on Windows.
    See more

    Declaration

    Swift

    public struct ApplicationsToMonitor : Codable

  • Preconfigured plugin profiles.

    See more

    Declaration

    Swift

    public struct PluginProfile : Codable

  • Layouts describe how information is shown on the Stream Deck + touch display.

    There are built-in pre-defined layouts or create a custom layout JSON file. The layout name or path to the custom layout json file is defined in the manifest.

    The layout can also be dynamically changed using the setFeedbackLayout event.

    See more

    Declaration

    Swift

    public struct LayoutName : Codable, ExpressibleByStringLiteral, Identifiable, Hashable

  • The Encoder property is used to describe and configure the dial and display segment on StreamDeck+.

    See more

    Declaration

    Swift

    public struct RotaryEncoder : Codable
  • See more

    Declaration

    Swift

    public struct TriggerDescription : Codable