https://github.com/msqr1/vosklet
A speech recognizer that can run on the browser, inspired by vosk-browser
https://github.com/msqr1/vosklet
api javascript speech-recognizer vosk webassembly
Last synced: 15 days ago
JSON representation
A speech recognizer that can run on the browser, inspired by vosk-browser
- Host: GitHub
- URL: https://github.com/msqr1/vosklet
- Owner: msqr1
- License: apache-2.0
- Created: 2024-01-15T01:55:30.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-05-15T23:30:09.000Z (over 1 year ago)
- Last Synced: 2024-05-19T01:25:15.919Z (over 1 year ago)
- Topics: api, javascript, speech-recognizer, vosk, webassembly
- Language: Shell
- Homepage:
- Size: 239 MB
- Stars: 7
- Watchers: 1
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Overview
- A fast, lightweight, actively maintained speech recognizer in the browser with total brotlied (used by JSDelivr) size of **under a megabyte** (614 KB)
- Live Demo (ASR in 20 languages): https://msqr1-github-io.pages.dev/Vosklet
- Inspired by vosk-browser by [ccoreilly](https://github.com/ccoreilly)
# Documentation
- See [Documentation.md](Documentation.md)
# Vosklet ...
- Is regularly maintained
- Support multiple models
- Include model cache path management
- Include model cache ID management (for updates)
- Wraps all Vosk's functionaly
- Faster and lighter than vosk-browser
# Basic usage (microphone recognition in English)
- Using JsDelivr CDN
- Result are logged to the console
- Copied from [Examples/fromMic.html](Examples/fromMic.html)
- **IMPORTANT:** Please see [Examples/README.md](Examples/README.md)
```html
async function start() {
// All data is collected and transfered to the main thread so the AudioContext won't output anything. Set sinkId type to none to save power
let ctx = new AudioContext({sinkId: {type: "none"}});
// Setup microphone
let micNode = ctx.createMediaStreamSource(await navigator.mediaDevices.getUserMedia({
video: false,
audio: {
echoCancellation: true,
noiseSuppression: true,
channelCount: 1
},
}));
// Load Vosklet module, model and recognizer
let module = await loadVosklet();
let model = await module.createModel("https://ccoreilly.github.io/vosk-browser/models/vosk-model-small-en-us-0.15.tar.gz","English","vosk-model-small-en-us-0.15");
let recognizer = await module.createRecognizer(model, ctx.sampleRate);
// Listen for result and partial result
recognizer.addEventListener("result", ev => console.log("Result: ", ev.detail));
recognizer.addEventListener("partialResult", ev => console.log("Partial result: ", ev.detail));
// Create a transferer node to get audio data on the main thread
let transferer = await module.createTransferer(ctx, 128 * 150);
// Recognize data on arrival
transferer.port.onmessage = ev => recognizer.acceptWaveform(ev.data);
// Connect transferer to microphone
micNode.connect(transferer);
}
Start
```