@streamoji/aitwin 0.6.0 → 0.6.2

package/README.md

@@ -96,8 +96,8 @@ Provide **`id`** (cloud twin), **`avatarId`/`faceId`** (R2 custom face), or **`a
 | `faceId` | Alias for `avatarId` (same CDN path) |
 | `assets` | `{ twinBase, binBase, encrypted }` — skip getAiTwin (lab / custom CDN) |
 | `authToken` | Bearer for TTS + encrypted assets; omitted → dev `getAuthToken` |
-| `ttsEngineId` | TTS engine when using `assets` (default Cartesia) |
-| `voiceId` | Override TTS voice |
+| `ttsEngineId` | TTS engine (default Cartesia). Optional if `voiceId` is packed as `engine:voice` |
+| `voiceId` | Voice id, or packed `ttsEngineId:voiceId` (e.g. `visemetts:eve`) |
 | `speakingRate` | Default `0.85` |
 | `idleHandoffHoldMs` | Milliseconds to hold still sil after speech before resuming the idle video loop (default `200`) |
 | `showErrorOverlay` | Canvas error overlay (default `true`) |
@@ -156,7 +156,7 @@ Applies to both `speakText()` and voice `connect()` playback.
 | `disconnect()` | End voice session |
 | `isConnected()` | Whether voice WebSocket is active |
 | `stop()` | Stop playback and return toward idle |
-| `setTtsEngineId(engineId)` | Switch Google / Inworld / Cartesia |
+| `setTtsEngineId(engineId)` | Switch Google / Inworld / Cartesia / visemetts |
 | `renderViseme(to, options?)` | Manual viseme transition (lab) |
 | `isReady()` | Whether face assets are loaded |
 | `getStatus()` | Current lipsync status |
@@ -220,7 +220,8 @@ WebSocket URL: `wss://<api-host>/ws/voice?<query>`. The SDK builds it from `conn
 |-------------|----------|--------|
 | `authToken` | Yes | Same JWT as SSE `Authorization: Bearer` (`client_…` from `getAuthToken`) |
 | `tenant` | Yes | Always `aiTwin` |
-| `voiceId` | No | Cartesia UUID override (from getAiTwin or `connect({ voiceId })`) |
+| `voiceId` | No | Cartesia UUID, visemetts name (`eve`), or packed `engine:voice` |
+| `ttsEngineId` | No | `visemetts` or Cartesia id; also parsed from packed `voiceId` |
 | `personaId` | No | getAiTwin `knowledgeContextId` when present |
 | `speaking_rate` | No | `0.5`–`1.5`, default `0.85` |
 | `tts_stream` | No | Default `true` (server TTS + `avatar_audio_chunk`) |