PCM audio data to the speakersOutput
A Writable stream instance that accepts PCM audio data and outputs it
to the speakers. The output is backed by
mpg123's audio output modules, which
in turn use any number of audio backends commonly found on Operating Systems
Simply compile and install
npm install speaker
On Debian/Ubuntu, the ALSA backend is selected by default, so be sure
to have the
alsa.h header file in place:
sudo apt-get install libasound2-dev
Here's an example of piping
stdin to the speaker, which should be 2 channel,
16-bit audio at 44,100 samples per second (a.k.a CD quality audio).
const Speaker = ;// Create the Speaker instanceconst speaker =channels: 2 // 2 channelsbitDepth: 16 // 16-bit samplessampleRate: 44100 // 44,100 Hz sample rate;// PCM data from stdin gets piped into the speakerprocessstdin;
require('speaker') directly returns the
Speaker constructor. It is the only
interface exported by
new Speaker([ options ]) -> Speaker instance
Creates a new
Speaker instance, which is a writable stream that you can pipe
PCM audio data to. The optional
options object may contain any of the
base class options, as well as any of these PCM formatting options:
channels- The number of audio channels. PCM data must be interleaved. Defaults to
bitDepth- The number of bits per sample. Defaults to
sampleRate- The number of samples per second per channel. Defaults to
signed- Boolean specifying if the samples are signed or unsigned. Defaults to
truewhen bit depth is 8-bit,
float- Boolean specifying if the samples are floating-point values. Defaults to
samplesPerFrame- The number of samples to send to the audio backend at a time. You likely don't need to mess with this value. Defaults to
device- The name of the playback device. E.g.
'hw:0,0'for first device of first sound card or
'hw:1,0'for first device of second sound card. Defaults to
nullwhich will pick the default device.
Fired when the backend
open() call has completed. This happens once the first
write() call happens on the speaker instance.
Fired after the speaker instance has had
end() called, and after the audio data
has been flushed to the speakers.
Fired after the "flush" event, after the backend
close() call has completed.
This speaker instance is essentially finished after this point.
Audio Backend Selection
node-speaker is backed by
mpg123's "output modules", which in turn use one of
many popular audio backends like ALSA, OSS, SDL, and lots more. The default
backends for each operating system are described in the table below:
|Operating System||Audio Backend||Description|
||Output audio using Advanced Linux Sound Architecture (ALSA).|
|Mac OS X||
||Output audio using Mac OS X's CoreAudio.|
||Audio output for Windows (winmm).|
||Audio output for Sun Audio.|
To manually override the default backend, pass the
--mpg123-backend switch to
npm install speaker --mpg123-backend=openal