@elgato/streamdeck/dist/plugin/events/ui-message-event.d.ts

The official Node.js SDK for creating Stream Deck plugins.

import type { JsonObject, JsonValue } from "@elgato/utils";
import type { DidReceivePropertyInspectorMessage } from "../../api/index.js";
import type { DialAction } from "../actions/dial.js";
import type { KeyAction } from "../actions/key.js";
import { Event } from "./event.js";
/**
 * Provides information for an event triggered by a message being sent to the plugin, from the property inspector.
 */
export declare class SendToPluginEvent<TPayload extends JsonValue, TSettings extends JsonObject> extends Event<DidReceivePropertyInspectorMessage<TPayload>> {
    readonly action: DialAction<TSettings> | KeyAction<TSettings>;
    /**
     * Payload sent from the property inspector.
     */
    payload: TPayload;
    /**
     * Initializes a new instance of the {@link SendToPluginEvent} class.
     * @param action Action that raised the event.
     * @param source Source of the event, i.e. the original message from Stream Deck.
     */
    constructor(action: DialAction<TSettings> | KeyAction<TSettings>, source: DidReceivePropertyInspectorMessage<TPayload>);
}