Package Exports
- play-sound
- play-sound/index.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (play-sound) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
play-sound
Play sounds by shelling out to one of the available audio players.
Installation
npm install play-soundExamples
var player = require('play-sound')(opts = {})
// $ mplayer foo.mp3
player.play('foo.mp3', function(err){
if (err) throw err
})
// { timeout: 300 } will be passed to child process
player.play('foo.mp3', { timeout: 300 }, function(err){
if (err) throw err
})
// configure arguments for executable if any
player.play('foo.mp3', { afplay: ['-v', 1 ] /* lower volume for afplay on OSX */ }, function(err){
if (err) throw err
})
// access the node child_process in case you need to kill it on demand
var audio = player.play('foo.mp3', function(err){
if (err && !err.killed) throw err
})
audio.kill()Options
players– List of available audio players to check. Default:player– Audio player to use (skips availability checks)
Prior art
- play.js - play sound files from node.js to your speakers
License
MIT