LLM/WhisperLiveKit
1
0
Fork 0
mirror of https://github.com/QuentinFuxa/WhisperLiveKit.git synced 2026-03-07 22:33:36 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Quentin Fuxa
2025-02-20 10:30:47 +01:00
committed by GitHub
parent d7c945dcce
commit cf7944f13d
1 changed files with 19 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

41
README.md
View File

@@ -1,32 +1,29 @@
# Whisper Streaming Web: Real-time Speech-to-Text with Web UI & FastAPI WebSocket
This fork of [Whisper Streaming](https://github.com/ufal/whisper_streaming) adds a ready-to-use HTML interface, making it super easy to start transcribing audio directly from your browser. Just launch the local server, allow microphone access, and start streaming. Everything runs locally on your machine 🎙️✨
### What's New?
#### 🌐 **Web & API**
✅ **Built-in Web UI** – No frontend setup needed, just open your browser and start transcribing.
✅ **FastAPI WebSocket Server** – Real-time STT processing with async FFmpeg streaming.
✅ **JavaScript Client** – A ready-to-use MediaRecorder implementation that can be copied on your client side.
#### ⚙️ **Core Improvements**
✅ **Buffering Preview** – Displays unvalidated transcription segments for better feedback.
✅ **Multi-User Support** – Handle multiple users simultaneously without conflicts.
✅ **MLX Whisper Backend** – Optimized for Apple Silicon for faster local processing.
✅ **Enhanced Sentence Segmentation** – Better buffer trimming for better accuracy across languages.
✅ **Extended Logging** – More detailed logs to improve debugging and monitoring.
#### 🔥 **Advanced Features**
✅ **Real-Time Diarization (Beta)** – Assigns speaker labels dynamically using [Diart](https://github.com/juanmc2005/diart).
### Web UI
This fork of [Whisper Streaming](https://github.com/ufal/whisper_streaming) adds a ready-to-use HTML interface, making it easy to start transcribing audio directly from your browser. Launch the local server, allow microphone access, and start speaking. Everything runs locally on your machine 🎙️✨
<p align="center">
<img src="src/web/demo.png" alt="Demo Screenshot" width="600">
</p>
### What's New?
#### 🌐 **Web & API**
- **Built-in Web UI** – No frontend setup needed, just open your browser and start transcribing.
- **FastAPI WebSocket Server** – Real-time STT processing with async FFmpeg streaming.
- **JavaScript Client** – A ready-to-use MediaRecorder implementation that can be copied on your client side.
#### ⚙️ **Core Improvements**
- **Buffering Preview** – Displays unvalidated transcription segments for better feedback.
- **Multi-User Support** – Handle multiple users simultaneously without conflicts.
- **MLX Whisper Backend** – Optimized for Apple Silicon for faster local processing.
- **Enhanced Sentence Segmentation** – Better buffer trimming for better accuracy across languages.
- **Extended Logging** – More detailed logs to improve debugging and monitoring.
#### 🎙️ **Advanced Features**
- **Real-Time Diarization** – Recognize different speakers in real time using [Diart](https://github.com/juanmc2005/diart).
## Installation
1. **Clone the Repository**: