updated some packages to new versions and added more info to README

voicegain · Sep 23, 2021 · 9313c02 · 9313c02
1 parent 4f91d29
commit 9313c02
Show file tree

Hide file tree

Showing 3 changed files with 27 additions and 12 deletions.
diff --git a/examples/microphone-websocket-node-js-v2/README.md b/examples/microphone-websocket-node-js-v2/README.md
@@ -39,3 +39,19 @@ For Firefox you need to read the actual sample rate and pass it in the body of t
 </br>
 
 ![Screenshot of the microphone capture app running.](./mic-capture.PNG) *Screenshot of the microphone capture app running.*
+
+## Tweaks ##
+
+You can control the delay and the amount of corrections by modifying the `minimumDelay` parameter in file microphone-capture.js
+
+```
+websocket: { adHoc: true, minimumDelay: 175, useSTOMP: false },
+```
+
+`minimumDelay` = 0 will give fastest response but also most corrections. You can increase the value of `minimumDelay` if you do not mind some delay but would like to see fewer rewrites of the text.
+
+## API ##
+
+The core API used is documented here: https://console.voicegain.ai/api-documentation#operation/asrTranscribeAsyncPost
+
+If you want to know the format of the messages sent over webscoket look here: https://console.voicegain.ai/api-documentation#operation/wsTranscribeWords
diff --git a/examples/microphone-websocket-node-js-v2/package-lock.json b/examples/microphone-websocket-node-js-v2/package-lock.json
diff --git a/examples/microphone-websocket-node-js-v2/package.json b/examples/microphone-websocket-node-js-v2/package.json
@@ -6,9 +6,8 @@
   "dependencies": {
     "cors": "^2.8.5",
     "express": "^4.17.1",
-    "got": "^11.5.0"
+    "got": "^11.8.2"
   },
-  "devDependencies": {},
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
     "start": "node server.js"