node-microphone


Information

node-microphone is a module that use arecord ALSA tools on Linux or SoX on Windows & OSX to start and stop recording audio from a USB Microphone in PCM

Notice

Version 0.1.0 is incompatible with 0.0.x !
It is currently only tested with Windows (sox 14.4.2), will also be tested with Raspbian in the near future.
As it uses ECMAScript 2015, it will probably not work with older Node versions (works with Node 5.10.0).

For Windows, do not forget to add sox to your environment variables.

Roadmap

No official roadmap yet. If you experience issues, submit a PR and I will try to merge :-)

Dependencies

This library needs:

* ALSA tools installed on the machine (sudo apt-get install alsa-utils) for Linux
* SoX Tools installed on the machine for Windows or OSX

Usage

#### Simple example

A simple example on how to use this module:

let Mic = require('node-microphone');
let mic = new Mic();
let micStream = mic.startRecording();
micStream.pipe( myWritableStream );
setTimeout(() => {
logger.info('stopped recording');
mic.stopRecording();
}, 3000);
mic.on('info', (info) => {
console.log(info);
});
mic.on('error', (error) => {
console.log(error);
});

API

$3

Creates a new instance of the Microphone class. You can give an options object to the constructor with these parameters:

| Option | Value | Default |
|--------|-------|---------|
| endian | 'big' or 'little' | 'little' |
| bitwidth | 8, 16, 24 ^* | 16 |
| encoding | 'signed-integer' or 'unsigned-integer' | 'signed-integer' |
| rate | 8000, 16000, 44100 ^* | 16000 |
| channels | 1, 2 ^* | 1 (mono) |
| device | 'hw:0,0', 'plughw:1,0' ^* | |
| additionalParameters | Array of raw string parameters to pass to spawn() | |
| useDataEmitter | true or false - enables data via mic.on('data') | false | |

^* or any other value supported by arecord or sox.

With sox, the device option is used as waveaudio driver.

#### startRecording()

Starts recording by creating a new child process with the options given to the constructor.
Returns the recording PCM wave stream as Node stream.

#### stopRecording();

Stops the child process.

#### events

The Microphone class extends EventEmitter and emits info and error events.
The simple example shows how to use them.

CONTRIBUTORS

Thanks to ashishbajaj99 and vincentsaluzzo for their node microphone modules.

LICENSE

(MIT License)

Copyright (c) 2016 Carlos Knoke Flores

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.