Skip to content

aimanesmimah/fastRecorder_project

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

11 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Fast Recorder JS

npm version

Fast Recorder is a simple, easy to use library built on top of javascript browser api whose purpose is to provide developers with ready to consume functions allowing them to perform recording tasks quickly without the need of the browser api messing up, one of the perks of that one is that it makes audio processing to detect silence within the stream

Features

  • starting/stopping Recording Audio

  • restarting recording if needed

  • pausing/resuming record

  • convert text to woman/man voice

  • detecting silence while recording

  • exporting output to mp3/ogg file

  • resampling the recorded track to fit your software requirement

  • playing record

Installation & Usage

  • Include the pre-compiled javascript production bundle
<script type="text/javascript" src="./dist/fast-recorder.min.js"></script>
  • Or, include the library CDN
<script type="text/javascript" src="https://unpkg.com/fastrecorder@0.0.2/dist/fast-recorder.min.js"></script>
  • Next you can instantiate the library constructor this way
 var recorder= new FastRecorder.audioRecoder()   

API

Library methods

  • recorder.startRecording(onStart,onSilence,onHappening)

  • recorder.stopRecording(onStop)

  • recorder.restart(onRestart,onSilence,onHappening)

  • recorder.exportResampledAudio(reSampleRate,onComplete)

  • recorder.exportAsMP3(filename)

  • recorder.pause(onPause)

  • recorder.resume(onResume)

  • recorder.playAudio(url)

  • recorder.speakText(payload,onStart,onFinish)

Tests

  • to run the demo locally, you need first to do
bower install && run the index.html file locally 

License

FastRecorder.js is freely distributable under the terms of the MIT LICENSE