web-audio-workers-sockets - npm Package Compare versions

Comparing version 1.0.1 to 1.0.2

package.json

 {
   "name": "web-audio-workers-sockets",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "stream audio using web sockets in web worker rendered using web audio",
@@ -10,2 +10,5 @@ "main": "index.js",
   },
+  "engines": {
+    "node": "0.10.x"
+  },
   "dependencies": {
@@ -12,0 +15,0 @@ "ws": "0.4.x",

README.md

@@ -5,1 +5,46 @@ web-audio-workers-sockets
 stream audio using web sockets in web worker rendered using web audio
+
+The goal is to stream audio from server to browser to be rendered using web audio.
+Without using webworkers, my experience is the audio gets choppy when the single thread
+of the browser is used for everything (streaming sockets / audio rendering)
+
+I have discovered firefox fails to allow websockets from inside a webworker, yet
+this is OK on chrome.  Also, no browser supports web audio from a webworker.
+So I will see if I can eliminate this choppy audio issue by creating a sandwich :
+   
+    websocket <--> webworker <--> webaudio
+
+... but first I will attempt to get a smooth audio rendering using just websockets + web audio
+
+
+# Installation
+
+Dependencies include node/npm
+
+
+```bash
+npm install -g web-audio-workers-sockets
+cd $NODE_PATH/web-audio-workers-sockets
+npm start
+```
+
+... or if you prefer to have the git repo local :
+
+
+```bash
+git clone [e-mail]:scottstensland/web-audio-workers-sockets.git
+cd web-audio-workers-sockets
+npm install    # install the dependent modules
+npm start
+```
+
+
+Using a web audio/web worker/websocket savvy browser, point it at URL :
+
+```bash
+		 http://localhost:8888 
+```
+
+
+As of today - August 26th 2014 - only chrome works on linux, firefox (34.0a1 (2014-08-04)) fails since it cannot yet handle launching a websocket from a webworker thread.  Opera also fails on lack of web audio.
+

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

133522

increased by60.83%

Number of package files

14

increased by16.67%

Lines of code

2183

increased by75.48%

Number of lines in readme file

50

increased by900%

No dependency changes