@streamoji/aitwin 0.6.1 → 0.6.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -96,8 +96,8 @@ Provide **`id`** (cloud twin), **`avatarId`/`faceId`** (R2 custom face), or **`a
96
96
  | `faceId` | Alias for `avatarId` (same CDN path) |
97
97
  | `assets` | `{ twinBase, binBase, encrypted }` — skip getAiTwin (lab / custom CDN) |
98
98
  | `authToken` | Bearer for TTS + encrypted assets; omitted → dev `getAuthToken` |
99
- | `ttsEngineId` | TTS engine when using `assets` (default Cartesia) |
100
- | `voiceId` | Override TTS voice |
99
+ | `ttsEngineId` | TTS engine (default Cartesia). Optional if `voiceId` is packed as `engine:voice` |
100
+ | `voiceId` | Voice id, or packed `ttsEngineId:voiceId` (e.g. `visemetts:eve`) |
101
101
  | `speakingRate` | Default `0.85` |
102
102
  | `idleHandoffHoldMs` | Milliseconds to hold still sil after speech before resuming the idle video loop (default `200`) |
103
103
  | `showErrorOverlay` | Canvas error overlay (default `true`) |
@@ -220,7 +220,8 @@ WebSocket URL: `wss://<api-host>/ws/voice?<query>`. The SDK builds it from `conn
220
220
  |-------------|----------|--------|
221
221
  | `authToken` | Yes | Same JWT as SSE `Authorization: Bearer` (`client_…` from `getAuthToken`) |
222
222
  | `tenant` | Yes | Always `aiTwin` |
223
- | `voiceId` | No | Cartesia UUID override (from getAiTwin or `connect({ voiceId })`) |
223
+ | `voiceId` | No | Cartesia UUID, visemetts name (`eve`), or packed `engine:voice` |
224
+ | `ttsEngineId` | No | `visemetts` or Cartesia id; also parsed from packed `voiceId` |
224
225
  | `personaId` | No | getAiTwin `knowledgeContextId` when present |
225
226
  | `speaking_rate` | No | `0.5`–`1.5`, default `0.85` |
226
227
  | `tts_stream` | No | Default `true` (server TTS + `avatar_audio_chunk`) |