@elizaos/plugin-streaming 2.0.0-beta.1

package/dist/index.js

@@ -0,0 +1,147 @@
+import {
+  getHeadlessCaptureConfig,
+  parseDestinationQuery,
+  readOverlayLayout,
+  readStreamSettings,
+  safeDestId,
+  seedOverlayDefaults,
+  validateStreamSettings,
+  writeOverlayLayout,
+  writeStreamSettings
+} from "./api/stream-persistence.js";
+import {
+  detectCaptureMode,
+  ensureXvfb,
+  getActiveDestination,
+  handleStreamRoute
+} from "./api/stream-routes.js";
+import {
+  mergeStreamingText,
+  resolveStreamingUpdate
+} from "./api/streaming-text.js";
+import { handleTtsRoutes } from "./api/tts-routes.js";
+export * from "./core.js";
+import {
+  streamManager
+} from "./services/stream-manager.js";
+import {
+  buildPresetLayout,
+  buildStreamOpAction,
+  createStreamingPlugin,
+  streamStatusProvider
+} from "./core.js";
+const TWITCH_CFG = {
+  platformId: "twitch",
+  platformName: "Twitch",
+  streamKeyEnvVar: "TWITCH_STREAM_KEY",
+  defaultRtmpUrl: "rtmp://live.twitch.tv/app",
+  cloudRelay: true,
+  defaultOverlayLayout: buildPresetLayout("Twitch", [
+    "viewer-count",
+    "action-ticker",
+    "branding"
+  ])
+};
+const YOUTUBE_CFG = {
+  platformId: "youtube",
+  platformName: "YouTube",
+  pluginName: "youtube",
+  streamKeyEnvVar: "YOUTUBE_STREAM_KEY",
+  defaultRtmpUrl: "rtmp://a.rtmp.youtube.com/live2",
+  rtmpUrlEnvVar: "YOUTUBE_RTMP_URL",
+  cloudRelay: true,
+  defaultOverlayLayout: buildPresetLayout("YouTube", [
+    "viewer-count",
+    "thought-bubble",
+    "branding"
+  ])
+};
+const X_CFG = {
+  platformId: "x",
+  platformName: "X (Twitter)",
+  streamKeyEnvVar: "X_STREAM_KEY",
+  defaultRtmpUrl: "",
+  rtmpUrlEnvVar: "X_RTMP_URL",
+  cloudRelay: true,
+  defaultOverlayLayout: buildPresetLayout("X", [
+    "thought-bubble",
+    "action-ticker",
+    "branding"
+  ])
+};
+const PUMPFUN_CFG = {
+  platformId: "pumpfun",
+  platformName: "pump.fun",
+  streamKeyEnvVar: "PUMPFUN_STREAM_KEY",
+  defaultRtmpUrl: "",
+  rtmpUrlEnvVar: "PUMPFUN_RTMP_URL",
+  cloudRelay: true,
+  defaultOverlayLayout: buildPresetLayout("pump.fun", [
+    "viewer-count",
+    "action-ticker",
+    "branding"
+  ])
+};
+const twitchBundle = createStreamingPlugin(TWITCH_CFG);
+const youtubeBundle = createStreamingPlugin(YOUTUBE_CFG);
+const xBundle = createStreamingPlugin(X_CFG);
+const pumpfunBundle = createStreamingPlugin(PUMPFUN_CFG);
+function createTwitchDestination(runtime, config) {
+  return twitchBundle.createDestination(runtime, config);
+}
+function createYoutubeDestination(runtime, config) {
+  return youtubeBundle.createDestination(runtime, config);
+}
+function createXStreamDestination(runtime, config) {
+  return xBundle.createDestination(runtime, config);
+}
+function createPumpfunDestination(runtime, config) {
+  return pumpfunBundle.createDestination(runtime, config);
+}
+const streamingPlugin = {
+  name: "streaming",
+  description: "RTMP live streaming: Twitch, YouTube, X (Twitter), pump.fun, custom ingest URLs, and named RTMP sources.",
+  get config() {
+    const out = {};
+    for (const cfg of [TWITCH_CFG, YOUTUBE_CFG, X_CFG, PUMPFUN_CFG]) {
+      out[cfg.streamKeyEnvVar] = process.env[cfg.streamKeyEnvVar] ?? null;
+      if (cfg.rtmpUrlEnvVar) {
+        out[cfg.rtmpUrlEnvVar] = process.env[cfg.rtmpUrlEnvVar] ?? null;
+      }
+    }
+    out.CUSTOM_RTMP_URL = process.env.CUSTOM_RTMP_URL ?? null;
+    out.CUSTOM_RTMP_KEY = process.env.CUSTOM_RTMP_KEY ?? null;
+    return out;
+  },
+  actions: [buildStreamOpAction()],
+  providers: [streamStatusProvider],
+  async init() {
+  }
+};
+var index_default = streamingPlugin;
+export {
+  createPumpfunDestination,
+  createTwitchDestination,
+  createXStreamDestination,
+  createYoutubeDestination,
+  index_default as default,
+  detectCaptureMode,
+  ensureXvfb,
+  getActiveDestination,
+  getHeadlessCaptureConfig,
+  handleStreamRoute,
+  handleTtsRoutes,
+  mergeStreamingText,
+  parseDestinationQuery,
+  readOverlayLayout,
+  readStreamSettings,
+  resolveStreamingUpdate,
+  safeDestId,
+  seedOverlayDefaults,
+  streamManager,
+  streamingPlugin,
+  validateStreamSettings,
+  writeOverlayLayout,
+  writeStreamSettings
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["/**\n * @elizaos/plugin-streaming — RTMP destinations (Twitch, YouTube, X, pump.fun, custom/named ingest).\n */\n\nexport {\n  getHeadlessCaptureConfig,\n  parseDestinationQuery,\n  readOverlayLayout,\n  readStreamSettings,\n  type StreamVisualSettings,\n  type StreamVoiceSettings,\n  safeDestId,\n  seedOverlayDefaults,\n  validateStreamSettings,\n  writeOverlayLayout,\n  writeStreamSettings,\n} from \"./api/stream-persistence.js\";\nexport type { StreamRouteState } from \"./api/stream-route-state.js\";\nexport {\n  detectCaptureMode,\n  ensureXvfb,\n  getActiveDestination,\n  handleStreamRoute,\n} from \"./api/stream-routes.js\";\nexport {\n  mergeStreamingText,\n  resolveStreamingUpdate,\n  type StreamingUpdate,\n  type StreamingUpdateKind,\n} from \"./api/streaming-text.js\";\nexport { handleTtsRoutes, type TtsRouteContext } from \"./api/tts-routes.js\";\nexport * from \"./core.js\";\nexport {\n  type AudioSource,\n  type StreamConfig,\n  streamManager,\n} from \"./services/stream-manager.js\";\n\nimport type { IAgentRuntime, Plugin } from \"@elizaos/core\";\nimport {\n  buildPresetLayout,\n  buildStreamOpAction,\n  createStreamingPlugin,\n  type StreamingDestination,\n  type StreamingPluginConfig,\n  streamStatusProvider,\n} from \"./core.js\";\n\nconst TWITCH_CFG: StreamingPluginConfig = {\n  platformId: \"twitch\",\n  platformName: \"Twitch\",\n  streamKeyEnvVar: \"TWITCH_STREAM_KEY\",\n  defaultRtmpUrl: \"rtmp://live.twitch.tv/app\",\n  cloudRelay: true,\n  defaultOverlayLayout: buildPresetLayout(\"Twitch\", [\n    \"viewer-count\",\n    \"action-ticker\",\n    \"branding\",\n  ]),\n};\n\nconst YOUTUBE_CFG: StreamingPluginConfig = {\n  platformId: \"youtube\",\n  platformName: \"YouTube\",\n  pluginName: \"youtube\",\n  streamKeyEnvVar: \"YOUTUBE_STREAM_KEY\",\n  defaultRtmpUrl: \"rtmp://a.rtmp.youtube.com/live2\",\n  rtmpUrlEnvVar: \"YOUTUBE_RTMP_URL\",\n  cloudRelay: true,\n  defaultOverlayLayout: buildPresetLayout(\"YouTube\", [\n    \"viewer-count\",\n    \"thought-bubble\",\n    \"branding\",\n  ]),\n};\n\nconst X_CFG: StreamingPluginConfig = {\n  platformId: \"x\",\n  platformName: \"X (Twitter)\",\n  streamKeyEnvVar: \"X_STREAM_KEY\",\n  defaultRtmpUrl: \"\",\n  rtmpUrlEnvVar: \"X_RTMP_URL\",\n  cloudRelay: true,\n  defaultOverlayLayout: buildPresetLayout(\"X\", [\n    \"thought-bubble\",\n    \"action-ticker\",\n    \"branding\",\n  ]),\n};\n\nconst PUMPFUN_CFG: StreamingPluginConfig = {\n  platformId: \"pumpfun\",\n  platformName: \"pump.fun\",\n  streamKeyEnvVar: \"PUMPFUN_STREAM_KEY\",\n  defaultRtmpUrl: \"\",\n  rtmpUrlEnvVar: \"PUMPFUN_RTMP_URL\",\n  cloudRelay: true,\n  defaultOverlayLayout: buildPresetLayout(\"pump.fun\", [\n    \"viewer-count\",\n    \"action-ticker\",\n    \"branding\",\n  ]),\n};\n\nconst twitchBundle = createStreamingPlugin(TWITCH_CFG);\nconst youtubeBundle = createStreamingPlugin(YOUTUBE_CFG);\nconst xBundle = createStreamingPlugin(X_CFG);\nconst pumpfunBundle = createStreamingPlugin(PUMPFUN_CFG);\n\nexport function createTwitchDestination(\n  runtime?: IAgentRuntime,\n  config?: { streamKey?: string },\n): StreamingDestination {\n  return twitchBundle.createDestination(runtime, config);\n}\n\nexport function createYoutubeDestination(\n  runtime?: IAgentRuntime,\n  config?: { streamKey?: string; rtmpUrl?: string },\n): StreamingDestination {\n  return youtubeBundle.createDestination(runtime, config);\n}\n\nexport function createXStreamDestination(\n  runtime?: IAgentRuntime,\n  config?: { streamKey?: string; rtmpUrl?: string },\n): StreamingDestination {\n  return xBundle.createDestination(runtime, config);\n}\n\nexport function createPumpfunDestination(\n  runtime?: IAgentRuntime,\n  config?: { streamKey?: string; rtmpUrl?: string },\n): StreamingDestination {\n  return pumpfunBundle.createDestination(runtime, config);\n}\n\nexport const streamingPlugin: Plugin = {\n  name: \"streaming\",\n  description:\n    \"RTMP live streaming: Twitch, YouTube, X (Twitter), pump.fun, custom ingest URLs, and named RTMP sources.\",\n\n  get config() {\n    const out: Record<string, string | null> = {};\n    for (const cfg of [TWITCH_CFG, YOUTUBE_CFG, X_CFG, PUMPFUN_CFG]) {\n      out[cfg.streamKeyEnvVar] = process.env[cfg.streamKeyEnvVar] ?? null;\n      if (cfg.rtmpUrlEnvVar) {\n        out[cfg.rtmpUrlEnvVar] = process.env[cfg.rtmpUrlEnvVar] ?? null;\n      }\n    }\n    out.CUSTOM_RTMP_URL = process.env.CUSTOM_RTMP_URL ?? null;\n    out.CUSTOM_RTMP_KEY = process.env.CUSTOM_RTMP_KEY ?? null;\n    return out;\n  },\n\n  actions: [buildStreamOpAction()],\n  providers: [streamStatusProvider],\n\n  async init() {},\n};\n\nexport default streamingPlugin;\n"],"mappings":"AAIA;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EAGA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACK;AAEP;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACK;AACP;AAAA,EACE;AAAA,EACA;AAAA,OAGK;AACP,SAAS,uBAA6C;AACtD,cAAc;AACd;AAAA,EAGE;AAAA,OACK;AAGP;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EAGA;AAAA,OACK;AAEP,MAAM,aAAoC;AAAA,EACxC,YAAY;AAAA,EACZ,cAAc;AAAA,EACd,iBAAiB;AAAA,EACjB,gBAAgB;AAAA,EAChB,YAAY;AAAA,EACZ,sBAAsB,kBAAkB,UAAU;AAAA,IAChD;AAAA,IACA;AAAA,IACA;AAAA,EACF,CAAC;AACH;AAEA,MAAM,cAAqC;AAAA,EACzC,YAAY;AAAA,EACZ,cAAc;AAAA,EACd,YAAY;AAAA,EACZ,iBAAiB;AAAA,EACjB,gBAAgB;AAAA,EAChB,eAAe;AAAA,EACf,YAAY;AAAA,EACZ,sBAAsB,kBAAkB,WAAW;AAAA,IACjD;AAAA,IACA;AAAA,IACA;AAAA,EACF,CAAC;AACH;AAEA,MAAM,QAA+B;AAAA,EACnC,YAAY;AAAA,EACZ,cAAc;AAAA,EACd,iBAAiB;AAAA,EACjB,gBAAgB;AAAA,EAChB,eAAe;AAAA,EACf,YAAY;AAAA,EACZ,sBAAsB,kBAAkB,KAAK;AAAA,IAC3C;AAAA,IACA;AAAA,IACA;AAAA,EACF,CAAC;AACH;AAEA,MAAM,cAAqC;AAAA,EACzC,YAAY;AAAA,EACZ,cAAc;AAAA,EACd,iBAAiB;AAAA,EACjB,gBAAgB;AAAA,EAChB,eAAe;AAAA,EACf,YAAY;AAAA,EACZ,sBAAsB,kBAAkB,YAAY;AAAA,IAClD;AAAA,IACA;AAAA,IACA;AAAA,EACF,CAAC;AACH;AAEA,MAAM,eAAe,sBAAsB,UAAU;AACrD,MAAM,gBAAgB,sBAAsB,WAAW;AACvD,MAAM,UAAU,sBAAsB,KAAK;AAC3C,MAAM,gBAAgB,sBAAsB,WAAW;AAEhD,SAAS,wBACd,SACA,QACsB;AACtB,SAAO,aAAa,kBAAkB,SAAS,MAAM;AACvD;AAEO,SAAS,yBACd,SACA,QACsB;AACtB,SAAO,cAAc,kBAAkB,SAAS,MAAM;AACxD;AAEO,SAAS,yBACd,SACA,QACsB;AACtB,SAAO,QAAQ,kBAAkB,SAAS,MAAM;AAClD;AAEO,SAAS,yBACd,SACA,QACsB;AACtB,SAAO,cAAc,kBAAkB,SAAS,MAAM;AACxD;AAEO,MAAM,kBAA0B;AAAA,EACrC,MAAM;AAAA,EACN,aACE;AAAA,EAEF,IAAI,SAAS;AACX,UAAM,MAAqC,CAAC;AAC5C,eAAW,OAAO,CAAC,YAAY,aAAa,OAAO,WAAW,GAAG;AAC/D,UAAI,IAAI,eAAe,IAAI,QAAQ,IAAI,IAAI,eAAe,KAAK;AAC/D,UAAI,IAAI,eAAe;AACrB,YAAI,IAAI,aAAa,IAAI,QAAQ,IAAI,IAAI,aAAa,KAAK;AAAA,MAC7D;AAAA,IACF;AACA,QAAI,kBAAkB,QAAQ,IAAI,mBAAmB;AACrD,QAAI,kBAAkB,QAAQ,IAAI,mBAAmB;AACrD,WAAO;AAAA,EACT;AAAA,EAEA,SAAS,CAAC,oBAAoB,CAAC;AAAA,EAC/B,WAAW,CAAC,oBAAoB;AAAA,EAEhC,MAAM,OAAO;AAAA,EAAC;AAChB;AAEA,IAAO,gBAAQ;","names":[]}

package/dist/services/stream-manager.d.ts

@@ -0,0 +1,124 @@
+import { ITtsStreamBridge } from './tts-stream-bridge.js';
+import 'node:stream';
+
+/**
+ * Stream Manager — cross-platform RTMP streaming via FFmpeg.
+ *
+ * Supports multiple input modes:
+ * - "pipe": Receives JPEG frames via writeFrame() → FFmpeg stdin (image2pipe).
+ *   Used for streaming desktop window contents captured by the host bridge.
+ * - "avfoundation" / "screen": macOS native screen capture.
+ * - "x11grab": Linux virtual display capture (Xvfb). Used for GPU-backed game streams.
+ * - "file": Reads a continuously-updated JPEG file (browser-capture).
+ * - "testsrc": Solid color test pattern (default fallback).
+ *
+ * Audio support:
+ * - "silent": Synthetic silent audio (anullsrc) — default.
+ * - "system": System/desktop audio capture.
+ * - "microphone": Microphone input.
+ * - File path: Play an audio file as stream audio.
+ *
+ * Volume control:
+ * - setVolume(0-100), mute(), unmute() — restarts FFmpeg to apply.
+ *
+ * Usage:
+ *   import { streamManager } from "./services/stream-manager";
+ *   await streamManager.start({ rtmpUrl, rtmpKey, inputMode: "pipe" });
+ *   streamManager.writeFrame(jpegBuffer); // called from frame capture
+ *   streamManager.setVolume(50);          // adjust volume mid-stream
+ *   await streamManager.stop();
+ *
+ * @module services/stream-manager
+ */
+
+type AudioSource = "silent" | "system" | "microphone" | "tts";
+interface StreamConfig {
+    rtmpUrl: string;
+    rtmpKey: string;
+    /** FFmpeg video input source. Defaults to "testsrc" (test pattern). */
+    inputMode?: "testsrc" | "avfoundation" | "screen" | "pipe" | "file" | "x11grab";
+    /** avfoundation video device index (default "3" = Capture screen 0 on macOS) */
+    videoDevice?: string;
+    /** Path to JPEG frame file (for "file" input mode) */
+    frameFile?: string;
+    /** Resolution (default "1280x720") */
+    resolution?: string;
+    /** Video bitrate (default "2500k") */
+    bitrate?: string;
+    /** Frame rate (default 15) */
+    framerate?: number;
+    /** X11 display for x11grab mode (e.g., ":99"). Default ":99". */
+    display?: string;
+    /** Audio source. Default "silent" (anullsrc). Can also be an absolute file path. */
+    audioSource?: AudioSource | string;
+    /** Audio device identifier (platform-specific). For macOS avfoundation: device index. For Linux: pulse/alsa device name. */
+    audioDevice?: string;
+    /** Volume level 0–100. Default 80. Applied as FFmpeg audio filter. */
+    volume?: number;
+    /** Whether audio is muted. Default false. Overrides volume to 0 when true. */
+    muted?: boolean;
+}
+declare class StreamManager {
+    private ffmpeg;
+    private _running;
+    private startedAt;
+    private _frameCount;
+    /** Current stream config — stored for restart on volume/audio changes. */
+    private _config;
+    /** Current volume level (0–100). */
+    private _volume;
+    /** Whether audio is muted. */
+    private _muted;
+    /** Auto-restart state. */
+    private _restartAttempts;
+    private _maxRestartAttempts;
+    private _restartDecayTimer;
+    private _intentionalStop;
+    /** Pending auto-restart timer — cleared in stop() to prevent races. */
+    private _restartTimer;
+    /** Guard: prevents concurrent start() calls from orphaning FFmpeg. */
+    private _starting;
+    isRunning(): boolean;
+    getUptime(): number;
+    getHealth(): {
+        running: boolean;
+        ffmpegAlive: boolean;
+        uptime: number;
+        frameCount: number;
+        volume: number;
+        muted: boolean;
+        audioSource: string;
+        inputMode: "pipe" | "testsrc" | "avfoundation" | "screen" | "file" | "x11grab" | null;
+    };
+    getVolume(): number;
+    isMuted(): boolean;
+    /**
+     * Set volume (0–100). Restarts FFmpeg if currently streaming to apply the change.
+     */
+    setVolume(level: number): Promise<void>;
+    /** Mute audio. Restarts FFmpeg if currently streaming. */
+    mute(): Promise<void>;
+    /** Unmute audio. Restarts FFmpeg if currently streaming. */
+    unmute(): Promise<void>;
+    /** Restart the stream with updated config (preserves uptime tracking). */
+    private restart;
+    /**
+     * Write a JPEG frame to FFmpeg's stdin (only works in "pipe" mode).
+     * Returns true if the frame was accepted.
+     */
+    writeFrame(jpegData: Buffer): boolean;
+    start(config: StreamConfig): Promise<void>;
+    private _startInner;
+    stop(): Promise<{
+        uptime: number;
+    }>;
+    /** Attempt to restart FFmpeg after unexpected exit with exponential backoff. */
+    private autoRestart;
+    private buildVideoInputArgs;
+    private buildAudioInputArgs;
+    /** Get the TTS stream bridge for external speak triggers. */
+    getTtsBridge(): ITtsStreamBridge;
+}
+declare const streamManager: StreamManager;
+
+export { type AudioSource, type StreamConfig, streamManager };