Quentin Fuxa
commited on
Commit
·
69b53e8
1
Parent(s):
5ea5ea1
Update README.md
Browse files
README.md
CHANGED
@@ -19,12 +19,12 @@ This project is based on [Whisper Streaming](https://github.com/ufal/whisper_str
|
|
19 |
|
20 |
### 🔄 Architecture
|
21 |
|
22 |
-
WhisperLiveKit consists of
|
23 |
|
24 |
-
- **
|
25 |
-
- **
|
|
|
26 |
|
27 |
-
> **Note**: We recommend installing this library on the server/backend. For the frontend, you can use and adapt the provided HTML template from [whisperlivekit/web/live_transcription.html](https://github.com/QuentinFuxa/WhisperLiveKit/blob/main/whisperlivekit/web/live_transcription.html) for your specific use case.
|
28 |
|
29 |
### ✨ Key Features
|
30 |
|
|
|
19 |
|
20 |
### 🔄 Architecture
|
21 |
|
22 |
+
WhisperLiveKit consists of three main components:
|
23 |
|
24 |
+
- **Frontend**: A basic HTML & JavaScript interface that captures microphone audio and streams it to the backend via WebSockets. You can use and adapt the provided template at [whisperlivekit/web/live_transcription.html](https://github.com/QuentinFuxa/WhisperLiveKit/blob/main/whisperlivekit/web/live_transcription.html) for your specific use case.
|
25 |
+
- **Backend (Web Server)**: A FastAPI-based WebSocket server that receives streamed audio data, processes it in real time, and returns transcriptions to the frontend. This is where the WebSocket logic and routing live.
|
26 |
+
- **Core Backend (Library Logic)**: A server-agnostic core that handles audio processing, ASR, and diarization. It exposes reusable components that take in audio bytes and return transcriptions. This makes it easy to plug into any WebSocket or audio stream pipeline.
|
27 |
|
|
|
28 |
|
29 |
### ✨ Key Features
|
30 |
|