Readied README, added Seconds type to AudioBufferSourceNode

Author: adkelley

README.md

@@ -1,57 +1,24 @@
 # purescript-webaudio
 
-## About
-
 This is an experimental library for dealing with the HTML5 [Web Audio
 API](https://webaudio.github.io/web-audio-api/)
 
-Module documentation is available [here](API.md).
-
+## Installation
+  bower install purescript-webaudio
+  
+## Examples  
 
-To build the examples to run in your browser, perform the following scripts in order:
+To build the examples perform the following scripts in order:
 1. `npm run build:example:xx` where xx is the example (siren, gain, decode, decodeAsync)
 
 To run the examples in your browser, perform the following scripts in order:
 1. `npm run exec:example:xx` where xx is the example (siren, gain, decode, decodeAsync)
 
+## Tests
+
 To build the test suite
 1. `npm run build:test:props`
 
 To run the test suite
 1. `npm run exec:test:props` and inspect the output log
 
-
-## Breaking Changes
-* Updated to work with `purs 0.11.x`
-* Renamed the `WebAudio` effect to `AUDIO` to conform with best practices
-* Renamed the `AudioNode` class as `RawAudioNode`
-* `AudioNode` is now a sum type over all the raw nodes.
-* Renamed `wau` to `audio`
-* Moved several fns from `AudioContext.purs` to `BaseAudiocontext` to match web audio spec
-* Created a `Connectable` class encompassing `connect`, `disconnect` & `connectParam` with AudioNode as an instance.  This lives in `Types.purs`
-
-## Improvements
-* Moved test/Test0X to `examples/` and renamed appropriately
-* Added `AudioParam.setTargetAtTime`
-* Updated `API.md` to reflect `decodeAudioData` error handling change
-* New type synomymns `Value` and `Seconds` for `AudioParam` methods
-* Eliminated `gulp`, putting new build test scripts in `package.json`
-* Added `decodeAudioDataAsync` to `BaseAudioContext`. This runs in Aff not Eff but has the advantage that audio buffers can be returned directly. This, of course, introduces a dependency on Aff 4.0.0 and requires users to lift the original Eff functions into Aff if they wish to use it. I hope that this overhead should not be too restrictive given that a natural way to load sound resources is via Aff anyway.
-* Added `decodeAsync` to illustrate basic usage. devDependencies now include `Affjax`.
-* Added `test/props` to test some simple properties of the new Node types.
-* Added `BiquadFilterNode`.
-* Added `detune` property to `Oscillator`.
-* Added `DelayNode`.
-* Added `disconnect` to Types.
-* Experimented with shorthand setters for `AudioParam` properties on some nodes.
-* Added `AnalyserNode` plus buffer creation functions in Utils. This introduces a dependency on `Data.ArrayBuffer`.
-* Added `StereoPannerNode`.
-* Added `DynamicsCompressorNode`
-* Added `ConvolverNode`
-
-## adkelley ToDo:
-* Add further error handling options for `decodeAudioData` besides writing to console
-* Support for further nodes (e.g., ChannelSplitterNode), and interfaces
-
-## newlandsvalley ToDo:
-* Document the changes from merging my fork

src/Audio/WebAudio/AudioBufferSourceNode.purs

@@ -7,9 +7,10 @@ module Audio.WebAudio.AudioBufferSourceNode
 -- | See https://developer.mozilla.org/en-US/docs/Web/API/AudioBufferSourceNode.
 
 import Prelude
-import Control.Monad.Eff (Eff)
-import Audio.WebAudio.Types (AudioBuffer, AudioBufferSourceNode, AUDIO)
+
+import Audio.WebAudio.Types (AUDIO, AudioBuffer, AudioBufferSourceNode, Seconds)
 import Audio.WebAudio.Utils (unsafeGetProp, unsafeSetProp)
+import Control.Monad.Eff (Eff)
 
 -- | Prime the node with its AudioBuffer.
 foreign import setBuffer
@@ -19,13 +20,13 @@ foreign import setBuffer
 
 -- | Start playing the AudioBuffer.
 foreign import startBufferSource
-  :: ∀ eff. Number
+  :: ∀ eff. Seconds
   -> AudioBufferSourceNode
   -> (Eff (audio :: AUDIO | eff) Unit)
 
 -- | Stop playing the AudioBuffer.
 foreign import stopBufferSource
-  :: ∀ eff. Number
+  :: ∀ eff. Seconds
   -> AudioBufferSourceNode
   -> (Eff (audio :: AUDIO | eff) Unit)
 
@@ -39,16 +40,16 @@ setLoop l n = unsafeSetProp "loop" n l
 
 -- | The time, in seconds, at which playback of the AudioBuffer must begin when
 -- | loop is true (default 0).
-loopStart :: ∀ eff. AudioBufferSourceNode -> (Eff (audio :: AUDIO | eff) Number)
+loopStart :: ∀ eff. AudioBufferSourceNode -> (Eff (audio :: AUDIO | eff) Seconds)
 loopStart = unsafeGetProp "loopStart"
 
-setLoopStart :: ∀ eff. Number -> AudioBufferSourceNode -> (Eff (audio :: AUDIO | eff) Unit)
+setLoopStart :: ∀ eff. Seconds -> AudioBufferSourceNode -> (Eff (audio :: AUDIO | eff) Unit)
 setLoopStart l n = unsafeSetProp "loopStart" n l
 
 -- | The time, in seconds, at which playback of the AudioBuffer must end when
 -- | loop is true (default 0).
-loopEnd :: ∀ eff. AudioBufferSourceNode -> (Eff (audio :: AUDIO | eff) Number)
+loopEnd :: ∀ eff. AudioBufferSourceNode -> (Eff (audio :: AUDIO | eff) Seconds)
 loopEnd = unsafeGetProp "loopEnd"
 
-setLoopEnd :: ∀ eff. Number -> AudioBufferSourceNode -> (Eff (audio :: AUDIO | eff) Unit)
+setLoopEnd :: ∀ eff. Seconds -> AudioBufferSourceNode -> (Eff (audio :: AUDIO | eff) Unit)
 setLoopEnd l n = unsafeSetProp "loopEnd" n l