@spatius/avatarkit 1.3.1-beta.6 → 1.3.1

package/dist/{pwa-cache-manager-CwXaM3xR.js → pwa-cache-manager-C7NbU52Q.js}

@@ -1,5 +1,5 @@
 import { n as __exportAll } from "./rolldown-runtime-B-1-B7_t.js";
-import { t as logger } from "./logger-fAU8oahT.js";
+import { t as logger } from "./logger-BOpQ7u0w.js";
 //#region utils/pwa-cache-manager.ts
 /**
 * PWA Cache Manager

package/dist/types/index.d.ts

@@ -5,7 +5,29 @@ export declare enum DrivingServiceMode {
     /** Driven by SDK directly */
     direct = "direct",
     /** Driven by host application */
-    backend = "backend"
+    backend = "backend",
+    /**
+     * Use this **only** when driving the avatar through the companion RTC SDK,
+     * `@spatius/avatarkit-rtc`. If you are not using that package, stay on
+     * `direct` / `backend` — do not switch to this because it looks newer.
+     *
+     * **Telemetry dimension only — it gates no behaviour.** Every session reports
+     * `dsm`; without a value of its own, RTC traffic would be indistinguishable
+     * from plain `backend` traffic on the dashboards.
+     *
+     * It deliberately does not unlock any API. RTC drives the avatar frame by
+     * frame through `AvatarView.renderFrame` / `renderFromProtobuf`, which put the
+     * view into pure-rendering mode on their own — it never calls the host-driven
+     * feeding path (`yieldAudioData` / `yieldFramesData`) that `backend` exists
+     * for. So the `=== backend` checks guarding those methods are left untouched:
+     * loosening them for `rtc` would widen the reachable API surface without
+     * enabling anything RTC actually uses.
+     *
+     * Note the two concepts sit at different levels and are not interchangeable:
+     * pure-rendering mode is a per-frame runtime state of the render loop, while
+     * this is a session-wide value declared once at `initialize`.
+     */
+    rtc = "rtc"
 }
 /**
  * Strategy for handling animation-frame starvation (animation frames can't keep up
@@ -46,13 +68,17 @@ export interface AudioFormat {
      * the uplink is raw PCM unless you opt in.
      *
      * Opus cuts the upload to roughly an eighth, at the cost of encoding on the
-     * client. Off by default so bandwidth is traded for CPU only where that is
-     * wanted — low-end devices (e.g. learning tablets) should not be asked to
-     * encode audio they cannot afford to.
+     * client. **On by default** — the uplink drops to roughly 1/8 the bytes, which
+     * matters most on the mobile networks where playback stalls actually happen.
+     * Set it to `false` to keep the raw PCM uplink (e.g. on low-end devices where
+     * the encode cost is not worth the bandwidth saved).
      *
      * Only effective in direct mode: host mode has no uplink, and Opus input is
      * already Opus so there is nothing to encode. Independent of
      * `inputAudioFormat`, which describes what the host feeds in.
+     *
+     * Falls back to a raw PCM uplink (with a warning) when `sampleRate` is not one
+     * of Opus's supported rates — see `AvatarSDK.initialize`.
      */
     readonly opusUplinkEnabled?: boolean;
     /**

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@spatius/avatarkit",
   "type": "module",
-  "version": "1.3.1-beta.6",
+  "version": "1.3.1",
   "packageManager": "pnpm@10.18.2",
   "description": "AvatarKit — real-time, audio-driven avatar rendering SDK for Web.",
   "homepage": "https://spatius.ai/",