@solidrt/flux-types 0.0.23 → 0.0.24

package/README.md

@@ -47,7 +47,7 @@ rely on must be named.
 - `Flux` global (`version`, `capabilities`).
 - `flux:*` modules: `flux:http`, `flux:fs`, `flux:sqlite`, `flux:subprocess`,
   `flux:p2p`, `flux:process`, `flux:path`, and (on a gui-enabled runtime)
-  `flux:camera`, `flux:microphone`, `flux:gpu`.
+  `flux:camera`, `flux:microphone`, `flux:audio`, `flux:gpu`.
 - Web-standard globals: `console`, `fetch` + `Headers`/`Request`/`Response`,
   `setTimeout`/`setInterval`/`queueMicrotask`, `performance`, `WebSocket`,
   `TextEncoder`/`TextDecoder`. These are deliberate subsets matching exactly what

package/gui/audio.d.ts

@@ -0,0 +1,27 @@
+// Sound playback (gui-enabled runtime only). The imperative primitive; `play`
+// decodes an encoded clip (Ogg/Vorbis or WAV) and returns a handle whose
+// `stop()` halts just that sound, so the raw track id never leaves the runtime.
+
+declare module "flux:audio" {
+  /** Options for {@link play}. */
+  type PlayOptions = {
+    /** Repeat the clip until stopped. Defaults to false. */
+    loop?: boolean
+    /** Volume scale, 1.0 leaves the clip unchanged. Defaults to 1.0. */
+    gain?: number
+  }
+
+  /** A playing sound with controls bound to it. */
+  type SoundHandle = {
+    /** Stop this sound. A no-op if it already finished. */
+    stop(): void
+  }
+
+  /**
+   * Decode and start an encoded audio clip (Ogg/Vorbis or WAV). Returns
+   * immediately; the sound plays on the mixer's own thread.
+   */
+  export function play(bytes: Uint8Array, options?: PlayOptions): SoundHandle
+  /** Stop every playing sound. */
+  export function stopAll(): void
+}

package/index.d.ts

@@ -25,6 +25,7 @@
 /// <reference path="./gui/rendertree.d.ts" />
 /// <reference path="./gui/camera.d.ts" />
 /// <reference path="./gui/microphone.d.ts" />
+/// <reference path="./gui/audio.d.ts" />
 /// <reference path="./gui/gpu.d.ts" />
 /// <reference path="./gui/raf.d.ts" />
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@solidrt/flux-types",
-  "version": "0.0.23",
+  "version": "0.0.24",
   "license": "MIT",
   "author": "Antoine van Wel",
   "types": "index.d.ts",