Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/redkenrok/node-audiorecorder
Audio recorder for Node.js, delivers a 16-bit signed-integer linear pulse modulation WAV stream.
https://github.com/redkenrok/node-audiorecorder
arecord audio-recording rec sox
Last synced: 6 days ago
JSON representation
Audio recorder for Node.js, delivers a 16-bit signed-integer linear pulse modulation WAV stream.
- Host: GitHub
- URL: https://github.com/redkenrok/node-audiorecorder
- Owner: RedKenrok
- License: mit
- Created: 2017-12-08T16:16:04.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2024-03-30T08:07:14.000Z (9 months ago)
- Last Synced: 2024-12-24T18:10:08.659Z (13 days ago)
- Topics: arecord, audio-recording, rec, sox
- Language: JavaScript
- Homepage:
- Size: 470 KB
- Stars: 95
- Watchers: 5
- Forks: 14
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://npmjs.com/package/node-audiorecorder)
[](https://github.com/redkenrok/node-audiorecorder/blob/master/LICENSE)
[](https://github.com/redkenrok/node-audiorecorder/issues)
# Audio recorder (unmaintained)
Audio recorder for [Node.js](https://nodejs.org/), delivers a 16-bit signed-integer linear pulse modulation WAV stream. Based of [Gilles De Mey](https://github.com/gillesdemey)'s [node-record-lpcm16](https://github.com/gillesdemey/node-record-lpcm16).
## Installation
```
npm install node-audiorecorder
```
## Dependencies
This module requires you to install [SoX](http://sox.sourceforge.net/) and it must be available in your \$PATH.
### For Linux
```
sudo apt-get install sox libsox-fmt-all
```
### For MacOS
```
brew install sox
```
### For Windows
[Download the binaries](http://sourceforge.net/projects/sox/files/latest/download)
## Usage
### Constructor
```javascript
// Import module.
const AudioRecorder = require('node-audiorecorder')
// Options is an optional parameter for the constructor call.
// If an option is not given the default value, as seen below, will be used.
const options = {
program: `rec`, // Which program to use, either `arecord`, `rec`, or `sox`.
device: null, // Recording device to use. Null means default.
// List available devices with 'arecord -l', 'rec -V6 -n -t coreaudio junk_device_name', or 'sox -V6 -n -t coreaudio junk_device_name'.
driver: null, // Recording driver to use. Null means default.
bits: 16, // Sample size. (only for `rec` and `sox`)
channels: 1, // Channel count.
encoding: `signed-integer`, // Encoding type. (only for `rec` and `sox`)
format: `S16_LE`, // Encoding type. (only for `arecord`)
rate: 16000, // Sample rate.
type: `wav`, // Format type.
// Following options only available when using `rec` or `sox`.
silence: 2, // Duration of silence in seconds before it stops recording.
thresholdStart: 0.5, // Silence threshold to start recording.
thresholdStop: 0.5, // Silence threshold to stop recording.
keepSilence: true, // Keep the silence in the recording.
}
// Optional parameter intended for debugging.
// The object has to implement a log and warn function.
const logger = console
// Create an instance.
let audioRecorder = new AudioRecorder(options, logger)
```
> If you can't capture any sound with 'arecord' try to running 'arecord -l' to which devices are available.
> See the [arecord documentation](https://linux.die.net/man/1/arecord) for more detail on its options.
> See the [sox documentation](http://sox.sourceforge.net/Docs/Documentation) for more detail on the rec and sox options.
### Methods
```javascript
// Creates and starts the recording process.
audioRecorder.start()
// Stops and removes the recording process.
audioRecorder.stop()
// Returns the stream of the recording process.
audioRecorder.stream()
```
### Examples
See the [examples directory](https://github.com/RedKenrok/node-audiorecorder/tree/master/examples) for example usage.
> For another example see the [node-hotworddetector](https://github.com/RedKenrok/node-hotworddetector) module, or [Electron-VoiceInterfaceBoilerplate](https://github.com/RedKenrok/Electron-VoiceInterfaceBoilerplate)'s input.js.
## Troubleshooting
### Windows continues recording
If you have issues with continues recording on Windows 10 with SoX 14.4.2 or later, install version [14.4.1](https://sourceforge.net/projects/sox/files/sox/14.4.1/) instead.
## License
[MIT license](https://github.com/redkenrok/node-audiorecorder/blob/master/LICENSE)