patrick/Vosklet
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Test npm package

Browse Source
This commit is contained in:
msqr1
2024-04-23 22:24:13 -07:00
parent 64e4c4c117
commit a92d1457da
3 changed files with 118 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

65
npm/README.md Normal file
View File

@@ -0,0 +1,65 @@
# Overview
- A speech recognizer built on Vosk that can be run on the browser, inspired by [vosk-browser](https://github.com/ccoreilly/vosk-browser), but built from scratch and no code taken!
- Designed with basic/nothrow exception safety
- See the *examples* folder for examples on using the API.
- See *API.md* for the API reference
- See the *devel* folder for the build script for development
# Compared to vosk-browser
- Support multiple models
- Has models' storage path management
- Has models' ID management (for model updates)
- Has smaller JS size (>3.1MB vs 1.4MB gzipped)
- Has all related files (pthread worker, audio worklet processor,...) merged
- Has faster processing time
- Has shorter from-scratch build time
- Has more Vosk functions exposed
# Basic usage (microphone recognition)
- Result are logged to the console.
- Copied from *examples/fromMic.html*
```html
<!DOCTYPE html>
<html>
<head>
<script src="https://cdn.jsdelivr.net/gh/msqr1/Vosklet@1.0.0/Vosklet.js" async defer></script>
<script>
async function start() {
// Make sure sample rate matches that in the training data
let ctx = new AudioContext({sampleRate : 16000})
// Setup mic with correct sample rate
let micNode = ctx.createMediaStreamSource(await navigator.mediaDevices.getUserMedia({
video: false,
audio: {
echoCancellation: true,
noiseSuppression: true,
channelCount: 1,
sampleRate: 16000
},
}))
// Load Vosklet module, model and recognizer
let module = await loadVosklet()
let model = await module.createModel("en-model.tgz","model","ID")
let recognizer = await module.createRecognizer(model, 16000)
// 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 to microphone
micNode.connect(transferer)
}
</script>
<!-- Start and create audio context only as a result of user's action -->
<button onclick="start()">Start</button>
</head>
</html>
```

22
npm/index.js Normal file
View File

File diff suppressed because one or more lines are too long

31
npm/package.json Normal file
View File

@@ -0,0 +1,31 @@
{
"name": "vosklet",
"version": "1.0.1",
"description": "A speech recognizer that can run on the browser, inspired by vosk-browser",
"main": "index.js",
"directories": {
"example": "examples"
},
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},
"repository": {
"type": "git",
"url": "git+https://github.com/msqr1/Vosklet.git"
},
"keywords": [
"javascript",
"api",
"wasm",
"webassembly",
"speech-recognizer",
"vosk",
"kaldi"
],
"author": "msqr1",
"license": "Apache-2.0",
"bugs": {
"url": "https://github.com/msqr1/Vosklet/issues"
},
"homepage": "https://github.com/msqr1/Vosklet#readme"
}