1.0.0 • Published 9 years ago

s3-waveform v1.0.0

Weekly downloads
6
License
-
Repository
-
Last release
9 years ago

s3-waveform

Build Status Build Status

Takes an audio file key on S3, creates waveform data for the file, and uploads it back to S3 via streaming.

Installation

$ npm install s3-waveform --save

API

exports.createWaveform(config, callback)

Takes a configuration object, and a callback upon stream completion. Possible configurations below:

  • {S3} s3 required
    • An AWS.S3 instance, or something with the same interface (mock S3 instance for example).
  • {Number} byteSize required
  • {String} srcBucket required
  • {String} srcKey required
  • {String} destBucket required
  • {String} destKey required
  • {Number} samples
    • How many data points should be in the resulting waveform data. default=5000
  • {Number} config.channels
  • How many channels is the audio file. default=2
  • {Number} config.outputBitDepth
  • Bit depth of the output waveform data. default=8

Test

$ npm test

Only mock tests right now, need to add integration.

License

MIT License, Copyright (c) 2014 Jordan Santell