@elgato/streamdeck/types/ui/index.d.ts

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

import { type ActionInfo, type RegistrationInfo } from "../api";
import type { IDisposable } from "../common/disposable";
import type { JsonObject } from "../common/json";
import * as settings from "./settings";
import * as system from "./system";
export { DeviceType, type ActionInfo, type ConnectElgatoStreamDeckSocketFn, type Controller, type RegistrationInfo, } from "../api";
export { Enumerable } from "../common/enumerable";
export { EventEmitter } from "../common/event-emitter";
export { type JsonObject, type JsonPrimitive, type JsonValue } from "../common/json";
export { LogLevel, type Logger } from "../common/logging";
export { type MessageRequestOptions, type MessageResponder, type MessageResponse, type RouteConfiguration, type StatusCode, } from "../common/messaging";
export type * from "./events";
export { type MessageHandler, type MessageRequest } from "./plugin";
declare const streamDeck: {
    /**
     * Internalization provider, responsible for managing localizations and translating resources.
     */
    i18n: import("../common/i18n").I18nProvider;
    /**
     * Logger responsible for capturing log messages.
     */
    logger: import(".").Logger;
    /**
     * Provides interaction with the plugin.
     */
    plugin: import("./plugin").PluginController;
    /**
     * Provides management of settings associated with the Stream Deck plugin.
     */
    settings: typeof settings;
    /**
     * Provides events and methods for interacting with the system.
     */
    system: typeof system;
    /**
     * Occurs before the UI has established a connection with Stream Deck.
     * @param listener Event handler function.
     * @returns A disposable that removes the listener when disposed.
     */
    onConnecting: <TSettings extends JsonObject = JsonObject>(listener: (info: RegistrationInfo, actionInfo: ActionInfo<TSettings>) => void) => IDisposable;
    /**
     * Occurs when the UI has established a connection with Stream Deck.
     * @param listener Event handler function.
     * @returns A disposable that removes the listener when disposed.
     */
    onConnected: <TSettings extends JsonObject = JsonObject>(listener: (info: RegistrationInfo, actionInfo: ActionInfo<TSettings>) => void) => IDisposable;
};
export default streamDeck;