@langchain/svelte 0.4.6 → 1.0.0

package/dist/use-audio-player.svelte.d.cts

@@ -0,0 +1,70 @@
+import { ValueOrGetter } from "./use-projection.svelte.cjs";
+import { AudioMedia } from "@langchain/langgraph-sdk/stream";
+
+//#region src/use-audio-player.svelte.d.ts
+/**
+ * Lifecycle state of an audio or video player returned by
+ * {@link useAudioPlayer} and `useVideoPlayer`.
+ */
+type PlayerStatus = "idle" | "buffering" | "playing" | "paused" | "finished" | "error";
+/** Options for {@link useAudioPlayer}. */
+interface UseAudioPlayerOptions {
+  /**
+   * Begin playback as soon as the first byte arrives (PCM strategy)
+   * or the blob settles (`element` strategy). Subject to browser
+   * autoplay policies — on sites without a prior user gesture the
+   * underlying `play()` may be rejected and the hook transitions to
+   * `"error"`.
+   */
+  autoPlay?: boolean;
+  /** Overrides for the PCM strategy. Ignored by `element` / WAV. */
+  pcm?: {
+    /** Sample rate in Hz. Defaults to `24000`. */sampleRate?: number; /** Channel count. Defaults to `1` (mono). */
+    channels?: number;
+  };
+  /** Additional mime prefixes treated as raw PCM16. */
+  pcmMimePrefixes?: readonly string[];
+  /** Force a specific playback strategy. Default `"auto"`. */
+  strategy?: "auto" | "pcm" | "element";
+}
+/**
+ * Player controls + live state returned by {@link useAudioPlayer}.
+ *
+ * Live state is exposed via getters on a stable object so templates
+ * can read `player.status` / `player.currentTime` without a `.value`
+ * hop. Imperative controls are plain functions.
+ */
+interface AudioPlayerHandle {
+  readonly status: PlayerStatus;
+  readonly strategy: "pcm" | "element";
+  play(): void;
+  pause(): void;
+  stop(): void;
+  toggle(): void;
+  reset(): void;
+  playToEnd(): Promise<void>;
+  readonly currentTime: number;
+  readonly duration: number | undefined;
+  seek(seconds: number): void;
+  /** RMS level of the last analysed frame, `[0, 1]`. */
+  readonly level: number;
+  getFrequencyData(): Uint8Array | undefined;
+  getTimeDomainData(): Uint8Array | undefined;
+  readonly error: Error | undefined;
+}
+/**
+ * Progressive audio playback for {@link AudioMedia} handles with a
+ * uniform surface across PCM (streamed) and container
+ * (`HTMLAudioElement`) strategies.
+ *
+ * The Svelte binding mirrors the React / Vue equivalents: reactive
+ * state is exposed as getters on the returned handle and templates
+ * read `player.status` / `player.currentTime` directly.
+ *
+ * @param media   - Audio handle from `useAudio` (plain value or getter).
+ * @param options - Strategy overrides and PCM format hints.
+ */
+declare function useAudioPlayer(media: ValueOrGetter<AudioMedia | undefined>, options?: UseAudioPlayerOptions): AudioPlayerHandle;
+//#endregion
+export { AudioPlayerHandle, PlayerStatus, UseAudioPlayerOptions, useAudioPlayer };
+//# sourceMappingURL=use-audio-player.svelte.d.cts.map

package/dist/use-audio-player.svelte.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-audio-player.svelte.d.cts","names":[],"sources":["../src/use-audio-player.svelte.ts"],"mappings":";;;;;;AAQA;;KAAY,YAAA;;UASK,qBAAA;EAAA;;;;;;;EAQf,QAAA;EASA;EAPA,GAAA;IASQ,8CAPN,UAAA,WAiBa;IAfb,QAAA;EAAA;EAgBe;EAbjB,eAAA;EA0BoB;EAxBpB,QAAA;AAAA;;;;;;;;UAUe,iBAAA;EAAA,SACN,MAAA,EAAQ,YAAA;EAAA,SACR,QAAA;EACT,IAAA;EACA,KAAA;EACA,IAAA;EACA,MAAA;EACA,KAAA;EACA,SAAA,IAAa,OAAA;EAAA,SACJ,WAAA;EAAA,SACA,QAAA;EACT,IAAA,CAAK,OAAA;EAIL;EAAA,SAFS,KAAA;EACT,gBAAA,IAAoB,UAAA;EACpB,iBAAA,IAAqB,UAAA;EAAA,SACZ,KAAA,EAAO,KAAA;AAAA;AA0PlB;;;;;;;;;;;;AAAA,iBAAgB,cAAA,CACd,KAAA,EAAO,aAAA,CAAc,UAAA,eACrB,OAAA,GAAU,qBAAA,GACT,iBAAA"}

package/dist/use-audio-player.svelte.d.ts

@@ -0,0 +1,70 @@
+import { ValueOrGetter } from "./use-projection.svelte.js";
+import { AudioMedia } from "@langchain/langgraph-sdk/stream";
+
+//#region src/use-audio-player.svelte.d.ts
+/**
+ * Lifecycle state of an audio or video player returned by
+ * {@link useAudioPlayer} and `useVideoPlayer`.
+ */
+type PlayerStatus = "idle" | "buffering" | "playing" | "paused" | "finished" | "error";
+/** Options for {@link useAudioPlayer}. */
+interface UseAudioPlayerOptions {
+  /**
+   * Begin playback as soon as the first byte arrives (PCM strategy)
+   * or the blob settles (`element` strategy). Subject to browser
+   * autoplay policies — on sites without a prior user gesture the
+   * underlying `play()` may be rejected and the hook transitions to
+   * `"error"`.
+   */
+  autoPlay?: boolean;
+  /** Overrides for the PCM strategy. Ignored by `element` / WAV. */
+  pcm?: {
+    /** Sample rate in Hz. Defaults to `24000`. */sampleRate?: number; /** Channel count. Defaults to `1` (mono). */
+    channels?: number;
+  };
+  /** Additional mime prefixes treated as raw PCM16. */
+  pcmMimePrefixes?: readonly string[];
+  /** Force a specific playback strategy. Default `"auto"`. */
+  strategy?: "auto" | "pcm" | "element";
+}
+/**
+ * Player controls + live state returned by {@link useAudioPlayer}.
+ *
+ * Live state is exposed via getters on a stable object so templates
+ * can read `player.status` / `player.currentTime` without a `.value`
+ * hop. Imperative controls are plain functions.
+ */
+interface AudioPlayerHandle {
+  readonly status: PlayerStatus;
+  readonly strategy: "pcm" | "element";
+  play(): void;
+  pause(): void;
+  stop(): void;
+  toggle(): void;
+  reset(): void;
+  playToEnd(): Promise<void>;
+  readonly currentTime: number;
+  readonly duration: number | undefined;
+  seek(seconds: number): void;
+  /** RMS level of the last analysed frame, `[0, 1]`. */
+  readonly level: number;
+  getFrequencyData(): Uint8Array | undefined;
+  getTimeDomainData(): Uint8Array | undefined;
+  readonly error: Error | undefined;
+}
+/**
+ * Progressive audio playback for {@link AudioMedia} handles with a
+ * uniform surface across PCM (streamed) and container
+ * (`HTMLAudioElement`) strategies.
+ *
+ * The Svelte binding mirrors the React / Vue equivalents: reactive
+ * state is exposed as getters on the returned handle and templates
+ * read `player.status` / `player.currentTime` directly.
+ *
+ * @param media   - Audio handle from `useAudio` (plain value or getter).
+ * @param options - Strategy overrides and PCM format hints.
+ */
+declare function useAudioPlayer(media: ValueOrGetter<AudioMedia | undefined>, options?: UseAudioPlayerOptions): AudioPlayerHandle;
+//#endregion
+export { AudioPlayerHandle, PlayerStatus, UseAudioPlayerOptions, useAudioPlayer };
+//# sourceMappingURL=use-audio-player.svelte.d.ts.map

package/dist/use-audio-player.svelte.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-audio-player.svelte.d.ts","names":[],"sources":["../src/use-audio-player.svelte.ts"],"mappings":";;;;;;AAQA;;KAAY,YAAA;;UASK,qBAAA;EAAA;;;;;;;EAQf,QAAA;EASA;EAPA,GAAA;IASQ,8CAPN,UAAA,WAiBa;IAfb,QAAA;EAAA;EAgBe;EAbjB,eAAA;EA0BoB;EAxBpB,QAAA;AAAA;;;;;;;;UAUe,iBAAA;EAAA,SACN,MAAA,EAAQ,YAAA;EAAA,SACR,QAAA;EACT,IAAA;EACA,KAAA;EACA,IAAA;EACA,MAAA;EACA,KAAA;EACA,SAAA,IAAa,OAAA;EAAA,SACJ,WAAA;EAAA,SACA,QAAA;EACT,IAAA,CAAK,OAAA;EAIL;EAAA,SAFS,KAAA;EACT,gBAAA,IAAoB,UAAA;EACpB,iBAAA,IAAqB,UAAA;EAAA,SACZ,KAAA,EAAO,KAAA;AAAA;AA0PlB;;;;;;;;;;;;AAAA,iBAAgB,cAAA,CACd,KAAA,EAAO,aAAA,CAAc,UAAA,eACrB,OAAA,GAAU,qBAAA,GACT,iBAAA"}