Skip to content
Branch: master
Go to file
Code

Latest commit

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
lib
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.md

Afplay

Afplay - Apple Audio File Play wrapper for Node.js

NPM Version Build Status Dependency Status

Afplay is a wrapper for Apple Audio File Play (afplay).

Use Afplay to play audio files on OS X via afplay. Afplay afplay!

Installation

Afplay was written for Node.js 4+.

npm install --save afplay

Usage

Afplay is super simple to use!

Play a Local File

let Afplay = require('afplay');

// Instantiate a new player
let player = new Afplay;

// Play a sound, handle result within a Promise
player.play('/tmp/my-file.mp3')
  .then(() => {
    console.log('Audio done playing');
  })
  .catch(error => {
    console.log('Error playing file');
  });

Configure Volume & Play Time

It is possible to configure volume and play time (in seconds).

player.play('/tmp/my-file.mp3', {volume: 100, time: 15})
  .then(() => {
    console.log('Loud, short duration audio done playing');
  })
  .catch(error => {
  	console.log('Error playing file');
  });

Examples

View the examples directory.

Logo

Afplay's initial logo was designed by scorpion6 on Fiverr. Font used is Lato Black.

License

This software is licensed under the MIT License. View the license.

Copyright © 2015 Michael K. Squires

About

Apple Audio File Play wrapper for Node.js

Resources

License

You can’t perform that action at this time.