wavesurfer-rails 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e6d5207276b66fe5b32d975bd97a71e270d024fd
-  data.tar.gz: 3e551455000ace906dcd2f624e759f8e0055c6b1
+  metadata.gz: d583a26ff8fe19758090aa446c2888af1f3578c6
+  data.tar.gz: 01700088d6050b7b858d6cfbf9bce1098c9dc5cf
 SHA512:
-  metadata.gz: 8f2c2beae816567f43c7b798596af964922c0bef92c2798b03112ab73dd5de87cb24b31f8614ddc9c4f55ea902a691ccc9e4e46ef0bfe03816d56daa391384c4
-  data.tar.gz: 6ee4250bafda4fdff04917e1e8c576436326f60a185bd5a1ddd3b7dfc95b2725c5c97aac291c2966e5f1b415c26cb6d9eaebef9a7e4b947cfb47d8e568f42bcd
+  metadata.gz: 49608f4c19dd4cbbe3efabaa5de60f4d02142fe436206a0a1a62150e73d1840fa2f5bb9306bd8b0c5d81ea6b03ffaba60a4db79e07549e7ba2028945412339a0
+  data.tar.gz: f32462fd869f0a0d02eb2d326cf1b204b5f3a4fa1637964fc58cd437dc6296622f6c19630449ffec1cb93692e2042aa362f9cdbc4386e13edf4103580342a0f9

data/README.md

@@ -1,8 +1,6 @@
-# Wavesurfer::Rails
+# Wavesurfer-rails
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/wavesurfer/rails`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+[Wavesurfer-js](http://wavesurfer-js.org/)
 
 ## Installation
 
@@ -16,24 +14,105 @@ And then execute:
 
     $ bundle
 
-Or install it yourself as:
+In `app/assets/javascripts/application.js` put the following:
+
+```javascript
+//= require wavesurfer
+```
+
+If you want the wavesurfer plugins:
 
-    $ gem install wavesurfer-rails
+```javascript
+//= require wavesurfer-plugins
+```
 
 ## Usage
 
-TODO: Write usage instructions here
+From the wavesurfer documentation:
 
-## Development
+```javascript
+var wavesurfer = Object.create(WaveSurfer);
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+wavesurfer.init({
+    container: document.querySelector('#wave'),
+    waveColor: 'violet',
+    progressColor: 'purple'
+});
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+wavesurfer.on('ready', function () {
+    wavesurfer.play();
+});
 
-## Contributing
+wavesurfer.load('example/media/demo.mp3');
+```
 
-1. Fork it ( https://github.com/[my-github-username]/wavesurfer-rails/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create a new Pull Request
+## WaveSurfer Options
+
+| option | type | default | description |
+| --- | --- | --- | --- |
+| `audioContext` | object | _none_ | Use your own previously initialized `AudioContext` or leave blank. |
+| `audioRate` | float | `1` | Speed at which to play audio.  Lower number is slower. |
+| `backend` | string | `WebAudio` | `WebAudio` or `MediaElement`. In most cases you don't have to set this manually. `MediaElement` is a fallback for unsupported browsers. |
+| `barWidth` | number | _none_ | If specified, the waveform will be drawn like this: ▁ ▂ ▇ ▃ ▅ ▂ |
+| `container` | mixed | _none_ | CSS-selector or HTML-element where the waveform should be drawn. This is the only required parameter. |
+| `cursorColor` | string | `#333` | The fill color of the cursor indicating the playhead position. |
+| `cursorWidth` | integer | `1` | Measured in pixels. |
+| `fillParent` | boolean | `true` | Whether to fill the entire container or draw only according to `minPxPerSec`. |
+| `height` | integer | `128` | The height of the waveform.  Measured in pixels. |
+| `hideScrollbar` | boolean | `false` | Whether to hide the horizontal scrollbar when one would normally be shown. |
+| `interact` | boolean | `true` | Whether the mouse interaction will be enabled at initialization.  You can switch this parameter at any time later on. |
+| `minPxPerSec` | integer | `50` | Minimum number of pixels per second of audio. |
+| `normalize` | boolean | `false` | If `true`, normalize by the maximum peak instead of 1.0. |
+| `pixelRatio` | integer | `window.devicePixelRatio` | Can be set to `1` for faster rendering. |
+| `progressColor` | string | `#555` | The fill color of the part of the waveform behind the cursor. |
+| `scrollParent` | boolean | `false` | Whether to scroll the container with a lengthy waveform. Otherwise the waveform is shrunk to the container width (see `fillParent`). |
+| `skipLength` | float | `2` | Number of seconds to skip with the `skipForward()` and `skipBackward()` methods. |
+| `waveColor` | string | `#999` | The fill color of the waveform after the cursor. |
+
+## WaveSurfer Methods
+
+All methods are intentionally public, but the most readily available are the following:
+
+ * `init(options)` – Initializes with the options listed above.
+ * `destroy()` – Removes events, elements and disconnects Web Audio nodes.
+ * `empty()` – Clears the waveform as if a zero-length audio is loaded.
+ * `getCurrentTime()` – Returns current progress in seconds.
+ * `getDuration()` – Returns the duration of an audio clip in seconds.
+ * `isPlaying()` – Returns true if currently playing, false otherwise.
+ * `load(url)` – Loads audio from URL via XHR. Returns XHR object.
+ * `loadBlob(url)` – Loads audio from a `Blob` or `File` object.
+ * `on(eventName, callback)` – Subscribes to an event.  See [WaveSurfer Events](#wavesurfer-events) section below for a list.
+ * `un(eventName, callback)` – Unsubscribes from an event.
+ * `unAll()` – Unsubscribes from all events.
+ * `pause()` – Stops playback.
+ * `play([start[, end]])` – Starts playback from the current position.  Optional `start` and `end` measured in seconds can be used to set the range of audio to play.
+ * `playPause()` – Plays if paused, pauses if playing.
+ * `seekAndCenter(progress)` – Seeks to a progress and centers view `[0..1]` (0 = beginning, 1 = end).
+ * `seekTo(progress)` – Seeks to a progress `[0..1]` (0=beginning, 1=end).
+ * `setFilter(filters)` - For inserting your own WebAudio nodes into the graph.  See [Connecting Filters](#connecting-filters) below.
+ * `setPlaybackRate(rate)` – Sets the speed of playback (`0.5` is half speed, `1` is normal speed, `2` is double speed and so on).
+ * `setVolume(newVolume)` – Sets the playback volume to a new value `[0..1]` (0 = silent, 1 = maximum).
+ * `skip(offset)` – Skip a number of seconds from the current position (use a negative value to go backwards).
+ * `skipBackward()` - Rewind `skipLength` seconds.
+ * `skipForward()` - Skip ahead `skipLength` seconds.
+ * `stop()` – Stops and goes to the beginning.
+ * `toggleMute()` – Toggles the volume on and off.
+ * `toggleInteraction()` – Toggle mouse interaction.
+ * `toggleScroll()` – Toggles `scrollParent`.
+ * `zoom(pxPerSec)` – Horiontally zooms the waveform in and out. The
+   parameter is a number of horizontal pixels per second of audio. It
+   also changes the parameter `minPxPerSec` and enables the
+   `scrollParent` option.
+
+## Credits
+
+Initial idea by [Alex Khokhulin](https://github.com/xoxulin). Many
+thanks to
+[the awesome contributors](https://github.com/katspaugh/wavesurfer.js/contributors)!
+
+## License
+
+![cc-by](http://i.creativecommons.org/l/by/3.0/88x31.png)
+
+This work is licensed under a
+[Creative Commons Attribution 3.0 Unported License](http://creativecommons.org/licenses/by/3.0/deed.en_US).

data/lib/wavesurfer/rails/version.rb

@@ -1,5 +1,5 @@
 module Wavesurfer
   module Rails
-    VERSION = "0.1.0"
+    VERSION = "0.1.1"
   end
 end

data/wavesurfer-rails.gemspec

@@ -9,8 +9,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Taylor Daugherty"]
   spec.email         = ["mdaugherty6@gmail.com"]
 
-  spec.summary       = %q{}
-  spec.description   = %q{Wavsurfer.js for the rails asset pipeline}
+  spec.summary       = %q{http://wavesurfer-js.org/}
+  spec.description   = %q{Wavesurfer.js for the rails asset pipeline.}
   spec.homepage      = "https://taylord.io"
   spec.license       = "MIT"
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wavesurfer-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Taylor Daugherty
@@ -38,7 +38,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
-description: Wavsurfer.js for the rails asset pipeline
+description: Wavesurfer.js for the rails asset pipeline.
 email:
 - mdaugherty6@gmail.com
 executables: []
@@ -88,5 +88,5 @@ rubyforge_project:
 rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
-summary: ''
+summary: http://wavesurfer-js.org/
 test_files: []