# fastrecorder

> a javascript library that gather & ease audio recording tasks

Latest version **0.0.2** (published 2018-07-25) · MIT license · 0 weekly downloads

## Install

```sh
npm install fastrecorder
pnpm add fastrecorder
yarn add fastrecorder
bun add fastrecorder
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.2 |
| Published | 2018-07-25 |
| First published | 2018-07-25 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 115.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | cloud strife |
| Maintainers | cloudstrife94 |
| Keywords | recording, audio, audio recording, fast recording, recorder, audio recorder, record, record audio, audio player |

## Links

- npm: https://www.npmjs.com/package/fastrecorder
- Repository: https://github.com/cloudstrife9494/fastRecorder_project
- Homepage: https://github.com/cloudstrife9494/fastRecorder_project#readme
- Issues: https://github.com/cloudstrife9494/fastRecorder_project/issues
- npm.io page: https://npm.io/package/fastrecorder

## Recent versions

- 0.0.2 (latest) — 2018-07-25

## README

<a name="README">[<img src="https://firebasestorage.googleapis.com/v0/b/github-833f9.appspot.com/o/fastlogo.png?alt=media&token=abe70d26-bc91-40c3-a982-dae919c8c462" height="100px" width="400px" />](#)</a>

# Fast Recorder JS

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


## 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

```html
<script type="text/javascript" src="./dist/fast-recorder.min.js"></script>
```

- Next you can instantiate the library constructor this way 

```javascript
 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

---
_Source: https://npm.io/package/fastrecorder · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._