Skip to content

aslafy-z/uppy-audio

Repository files navigation

@zadkiel/uppy-audio

Uppy logo: a superman puppy in a pink suit

Build Status

The Audio plugin for Uppy lets you record audio with a built-in microphone.

Uppy is being developed by the folks at Transloadit, a versatile file encoding service.

Example

const Uppy = require('@uppy/core')
const Audio = require('@zadkiel/uppy-audio')

const uppy = Uppy()
uppy.use(Audio, {
  showRecordingLength: true,
  encoderPath: '/path/to/waveWorker.min.js'
})

You should host waveWorker.min.js from opus-recorder project file on same-origin and then precise its path with encoderPath configuration variable.

Installation

$ npm install @zadkiel/uppy-audio --save

We recommend installing from npm and then using a module bundler such as Webpack, Browserify or Rollup.js.

Alternatively, you can also use this plugin in a pre-built bundle from Transloadit's CDN: Edgly. In that case Uppy will attach itself to the global window.Uppy object. See the main Uppy documentation for instructions.

Documentation

Documentation for this plugin can be found on the Uppy website.

License

The MIT License.