@liforma/client 0.2.1 → 0.3.0

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @liforma/client changelog
 
+## 0.3.0 — 2026-08-06
+
+### Added
+
+- `Experience.speech` controller: `speak`, `play`, `createUtterance`, `interrupt`
+- `speech.play` audio sources: PCM, encoded bytes/Blob, CORS URL, and host `MediaStreamTrack`
+- Speech types/errors exported from `@liforma/client` (`UnsupportedSpeechOperationError`, …)
+- README section for bring-your-own voice
+
+### Notes
+
+- Encoded/URL decode runs in the player; MediaStreamTrack capture runs in the host SDK
+- Requires session capabilities `textSpeech` / `externalSpeechAudio` as appropriate
+
 ## 0.2.1 — 2026-08-05
 
 ### Changed

package/README.md

@@ -92,11 +92,38 @@ export function Demo() {
 
 Never put API keys in browser code. Details: [Server sessions](https://docs.liforma.ai/avatar-experiences/server-sessions), [Browser embeds](https://docs.liforma.ai/avatar-experiences/browser-embeds).
 
+## Speech API
+
+```ts
+import { Experience } from '@liforma/client';
+
+const experience = await Experience.startSession({ experienceId: 'exp_…' });
+await experience.attach({ container: '#avatar' });
+
+experience.on('started', async () => {
+  // Liforma TTS
+  await experience.speech.speak({ text: 'Hello from Liforma.' });
+
+  // Bring-your-own: PCM, encoded bytes, URL, or MediaStreamTrack
+  await experience.speech.play({
+    audio: { url: 'https://cdn.example.com/line.mp3' },
+    queue: 'append'
+  });
+});
+```
+
+| Capability | Methods |
+|------------|---------|
+| `textSpeech` | `speech.speak` |
+| `externalSpeechAudio` | `speech.play`, `speech.createUtterance`, `speech.interrupt` |
+
+Streaming vendors: open one utterance per agent turn, `write` PCM chunks, `close` on turn end — see [Bring your own voice](https://docs.liforma.ai/avatar-experiences/bring-your-own-voice).
+
 ## More components
 
 - [ExperienceThumbnail](https://docs.liforma.ai/avatar-experiences/experience-thumbnail) — gallery cards (no session)
 - [ExperienceWidget](https://docs.liforma.ai/avatar-experiences/experience-widget) — corner launcher
-- [Experience API](https://docs.liforma.ai/avatar-experiences/experience-api) — `speak()`, listen, events
+- [Experience API](https://docs.liforma.ai/avatar-experiences/experience-api) — `speech.*`, listen, events
 
 ## License