admin-valentin/WhisperLiveKit
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

update api doc

Browse source
This commit is contained in:
Quentin Fuxa 2025-10-05 11:09:47 +02:00
parent 8434ef5efc
commit 971f8473eb
1 changed files with 3 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
docs/API.md
View file

@ -40,19 +40,14 @@ The current API sends complete state snapshots on each update (several time per
### Philosophy ### Philosophy
Designed with the following principles: Principles:
1. **Incremental Updates**: Only updates and new segments are sent - **Incremental Updates**: Only updates and new segments are sent
2. **Word-Level Granularity**: Each word includes timing and validation status for text and speaker - **Ephemeral Buffers**: Temporary, unvalidated data displayed in real-time but overwritten on next update, at speaker level
3. **Per-Segment Buffers**: Buffers are associated with specific speakers
4. **Efficient Client-Side Handling**: Segments have IDs for easy front updates
5. **Ephemeral Buffers**: Temporary, unvalidated data displayed in real-time but overwritten on next update
---
## Message Format ## Message Format
### Transcript Update Message
```typescript ```typescript
{ {