@spatialwalk/avatarkit 1.0.0-beta.96 → 1.0.0-beta.98

package/CHANGELOG.md

@@ -5,6 +5,34 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.0.0-beta.98]
+
+### 🐛 Bugfixes
+
+- **Build artifact fix** — beta.97 npm package contained stale build artifacts. This release contains the correct build with all beta.97 changes.
+
+### ⚡ Breaking Changes
+
+- **`setVolume()` / `getVolume()` replaced by `volume` property** — `controller.setVolume(0.5)` is now `controller.volume = 0.5`. Aligned with Android and iOS SDKs.
+
+## [1.0.0-beta.97]
+
+### ⚡ Breaking Changes
+
+- **`transform` renamed to `avatarTransform`** — `avatarView.transform` is now `avatarView.avatarTransform`. Aligned naming across Web, Android, and iOS SDKs.
+
+### ✨ Features
+
+- **Avatar transform from character settings** — Avatar automatically applies position and scale from character settings. User-set `avatarTransform` stacks on top of the base values.
+
+### 🐛 Bugfixes
+
+- **Rendering quality improvement** — Improved color accuracy for avatar rendering.
+
+### 📝 Documentation
+
+- **send() byte alignment** — Documented PCM S16LE byte alignment requirement for `send()`.
+
 ## [1.0.0-beta.96]
 
 ### 🐛 Bugfixes
@@ -175,7 +203,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### 🔧 Improvements
 - **API Documentation** - All public API comments are now in English with JSDoc support for better IDE IntelliSense
-- **Type Safety** - Removed internal types from public API exports, using `KeyframeData` instead of `Flame`
+- **Type Safety** - Removed internal types from public API exports
 - **Build Configuration** - JSDoc comments are now preserved in generated `.d.ts` files
 
 ### 📚 Documentation
@@ -264,7 +292,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### 🔧 Improvements
 - **Transition API Enhancement** - Updated `generateTransitionFromIdle()` to support both start and end transitions
-  - Added `transitionType` parameter: `'start'` for Idle -> Flame, `'end'` for Flame -> Idle
+  - Added `transitionType` parameter: `'start'` for idle-to-speaking, `'end'` for speaking-to-idle
   - Removed deprecated linear interpolation code and unused easing functions
 
 ## [1.0.0-beta.61] - 2026-01-14
@@ -290,7 +318,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [1.0.0-beta.58] - 2026-01-14
 
 ### ✨ New Features
-- **Pure Rendering Mode APIs** - Added `renderFlame()` and `generateTransitionFromIdle()` methods to `AvatarView` for external-controlled rendering without audio synchronization
+- **Pure Rendering Mode APIs** - Added `renderFrame()` and `generateTransitionFromIdle()` methods to `AvatarView` for external-controlled rendering without audio synchronization
 
 ## [1.0.0-beta.57] - 2026-01-09
 

package/README.md

@@ -282,7 +282,9 @@ button.addEventListener('click', async () => {
   })
 
   // 7. Send audio data (SDK mode, must be mono PCM16 format matching configured sample rate)
-  // audioData: ArrayBuffer or Uint8Array containing PCM16 audio samples
+  // audioData: ArrayBuffer or Uint8Array containing PCM16 (S16LE) audio samples
+  // ⚠️ Byte length MUST be even (2 bytes per sample). Odd-length data will cause server-side
+  //    validation error and WebSocket disconnect.
   // - PCM files: Can be directly read as ArrayBuffer
   // - WAV files: Extract PCM data from WAV format (may require resampling)
   // - MP3 files: Decode first (e.g., using AudioContext.decodeAudioData()), then convert to PCM16
@@ -590,10 +592,10 @@ avatarView.onFirstRendering = () => {
 
 // Get or set avatar transform (position and scale)
 // Get current transform
-const currentTransform = avatarView.transform // { x: number, y: number, scale: number }
+const currentTransform = avatarView.avatarTransform // { x: number, y: number, scale: number }
 
 // Set transform
-avatarView.transform = { x, y, scale }
+avatarView.avatarTransform = { x, y, scale }
 // - x: Horizontal offset in normalized coordinates (-1 to 1, where -1 = left edge, 0 = center, 1 = right edge)
 // - y: Vertical offset in normalized coordinates (-1 to 1, where -1 = bottom edge, 0 = center, 1 = top edge)
 // - scale: Scale factor (1.0 = original size, 2.0 = double size, 0.5 = half size)
@@ -714,8 +716,8 @@ const conversationId = avatarView.controller.getCurrentConversationId()
 // Returns: Current conversationId for the active audio session, or null if no active session
 
 // Volume control (affects only avatar audio player, not system volume)
-avatarView.controller.setVolume(0.5)  // Set volume to 50% (0.0 to 1.0)
-const currentVolume = avatarView.controller.getVolume()  // Get current volume (0.0 to 1.0)
+avatarView.controller.volume = 0.5  // Set volume to 50% (0.0 to 1.0)
+const currentVolume = avatarView.controller.volume  // Get current volume (0.0 to 1.0)
 
 // Set event callbacks
 avatarView.controller.onConnectionState = (state: ConnectionState) => {} // SDK mode only
@@ -728,22 +730,22 @@ avatarView.controller.onError = (error: AvatarError) => {} // Includes error.cod
 ```typescript
 // Get or set avatar transform (position and scale in canvas)
 // Get current transform
-const currentTransform = avatarView.transform // { x: number, y: number, scale: number }
+const currentTransform = avatarView.avatarTransform // { x: number, y: number, scale: number }
 
 // Set transform
-avatarView.transform = { x, y, scale }
+avatarView.avatarTransform = { x, y, scale }
 // - x: Horizontal offset in normalized coordinates (-1 to 1, where -1 = left edge, 0 = center, 1 = right edge)
 // - y: Vertical offset in normalized coordinates (-1 to 1, where -1 = bottom edge, 0 = center, 1 = top edge)
 // - scale: Scale factor (1.0 = original size, 2.0 = double size, 0.5 = half size)
 // Example:
-avatarView.transform = { x: 0, y: 0, scale: 1.0 }  // Center, original size
-avatarView.transform = { x: 0.5, y: 0, scale: 2.0 } // Right half, double size
+avatarView.avatarTransform = { x: 0, y: 0, scale: 1.0 }  // Center, original size
+avatarView.avatarTransform = { x: 0.5, y: 0, scale: 2.0 } // Right half, double size
 ```
 
 **Important Notes:**
 - `start()` and `close()` are only available in SDK mode
 - `yieldAudioData()` and `yieldFramesData()` are only available in Host mode
-- `pause()`, `resume()`, `interrupt()`, `clear()`, `getCurrentConversationId()`, `setVolume()`, and `getVolume()` are available in both modes
+- `pause()`, `resume()`, `interrupt()`, `clear()`, `getCurrentConversationId()`, and `volume` property are available in both modes
 - The playback mode is determined when creating `AvatarView` and cannot be changed
 
 ## 🔧 Configuration

package/dist/{StreamingAudioPlayer-DgV2nt4w.js → StreamingAudioPlayer-DEELveJ_.js}

@@ -1,7 +1,7 @@
 var __defProp = Object.defineProperty;
 var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
 var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
-import { A as APP_CONFIG, l as logger, e as errorToMessage, a as logEvent } from "./index-DtnIjVSC.js";
+import { A as APP_CONFIG, l as logger, e as errorToMessage, a as logEvent } from "./index-DfE9mnfH.js";
 class StreamingAudioPlayer {
   // Mark if AudioContext is being resumed, avoid concurrent resume requests
   constructor(options) {