@actioneer/ads 0.3.1 → 0.5.0

package/components/ai-elements/voice.d.ts

@@ -1,41 +1,51 @@
 import * as React from "react";
 /**
- * Voice — the approved ADS voice visualizers and controls.
+ * Voice — the ADS voice orb and its session controls.
  *
- * `Voice` renders three volume-reactive WebGL visuals: the original ADS orb,
- * plus LiveKit Agents UI's Aura and Wave shaders. All are driven by props, so
- * consumers keep a transport-neutral integration surface.
+ * `Voice` renders one volume-reactive WebGL orb, driven entirely by props so
+ * consumers keep a transport-neutral integration surface. Its colourway is set
+ * by `palette`; every palette is chromatic — the orb never renders greyscale —
+ * and an optional `seed` gives each agent/voice a distinct hue through the
+ * `identity` palette, so a list of voices reads as distinct rather than repeated.
  *
  * The controls (VoiceControl + friends) are standalone and props-driven — no
  * assistant-ui runtime — so they compose with any transport.
  *
- * Reduced motion: honored through `<MotionConfig reducedMotion="user">` for the
- * personas and a `reduced` freeze for every shader.
+ * Reduced motion: the shader freezes its noise field and drops volume
+ * reactivity, keeping the static coloured orb.
  */
 export type VoiceState = "idle" | "connecting" | "listening" | "thinking" | "speaking" | "muted" | "asleep";
-export type VoiceVariant = "orb" | "aura" | "wave";
-export declare const VOICE_PALETTES: readonly ["default", "identity", "mono", "blue", "violet", "emerald", "sunset"];
+/** The orb is the sole visual; `variant` is retained for API stability. */
+export type VoiceVariant = "orb";
+export declare const VOICE_PALETTES: readonly ["default", "identity", "blue", "violet", "emerald", "sunset"];
 export type VoicePalette = (typeof VOICE_PALETTES)[number];
 /** Backwards-compatible name for the palette type originally used by Orb. */
 export type VoiceOrbPalette = VoicePalette;
-export declare const VOICE_VARIANTS: readonly ["orb", "aura", "wave"];
+export declare const VOICE_VARIANTS: readonly ["orb"];
 export declare const VOICE_STATES: readonly ["idle", "connecting", "listening", "thinking", "speaking", "muted", "asleep"];
 export interface VoiceProps extends React.HTMLAttributes<HTMLDivElement> {
     /** Reactive animation state. */
     state?: VoiceState;
-    /** Visualizer style. */
+    /** Visualizer style. The orb is the only visual. */
     variant?: VoiceVariant;
     className?: string;
-    /** Normalized audio energy 0–1, shared by every visualizer. Default 0. */
+    /** Normalized audio energy 0–1. Default 0. */
     volume?: number;
-    /** Shared shader colorway. Default "default". */
+    /** Shader colorway. Every palette is chromatic. Default "default". */
     palette?: VoiceOrbPalette;
     /**
-     * Optional identity. Two orbs given different seeds render distinguishable
-     * patterns, so a list of agents/voices reads as distinct rather than
+     * Optional identity. With `palette="identity"`, the seed becomes a distinct
+     * hue per subject, so a list of agents/voices reads as distinct rather than
      * repeated. Omit for the generic orb.
      */
     seed?: string | number;
+    /**
+     * Fill the box. By default the orb disc occupies ~42% of its box (a legacy
+     * proportion left from when a glow halo filled the surround); at avatar sizes
+     * that leaves the disc tiny inside empty padding. Set `fill` so the disc
+     * fills its box — the correct choice for any small/avatar-sized orb.
+     */
+    fill?: boolean;
     /** Fired once on mount (API parity with the old Persona `onReady`). */
     onReady?: () => void;
     "aria-label"?: string;