Socket
Socket
Sign inDemoInstall

audio-vs1053b

Package Overview
Dependencies
Maintainers
1
Versions
12
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

audio-vs1053b

##Installation


Version published
Weekly downloads
1
Maintainers
1
Weekly downloads
 
Created
Source

#Audio Module

##Installation

npm install audio-vs1053b

##Example

  1. Writing mic data to a file (w/out streams)
var tessel = require('tessel');
var fs = require('fs');
var audio = require('audio-vs1053b').use(tessel.port('a'), function(err) {
  
  // Start recording data for a second into a file
  audio.setInput('microphone', function(err) {
    
    // Start the recording
    audio.startRecording(function(err) {
      // In one second
      setTimeout(function() {
        // Stop recording
        audio.stopRecording(function(err, oggBuffer) {
          // Write the buffer to a file
          fs.writeFile("micdata", oggBuffer, function(err) {
            console.log("Wrote to a file");
          });
        })
      }, 1000);
    });
  });
});
  1. Writing line-in to a file (w/ streams)
var tessel = require('tessel');
var fs = require('fs');
var audio = require('audio-vs1053b').use(tessel.port('a'), function(err) {
  
  // Start recording data for a second into a file
  audio.setInput('microphone', function(err) {
    // Open a stream to a file
    var file = fs.createWriteStream('lineInData.ogg');
    // Create a readable stream of incoming data
    var soundData = audio.createReadStream();
    // Pipe data to the file
    soundData.pipe(file);
  
    // Enable sound input
    audio.startRecording();
  });
});

  1. Output audio on the headphone Jack
var tessel = require('tessel');
var fs = require('fs');
var audio = require('audio-vs1053b').use(tessel.port('a'), function(err) {
  
  // Start recording data for a second into a file
  audio.setOutput('headphone', function(err) {
    // Open a file
    var audioFile = fs.readFileSync('Oops... I did it again.mp3');
    // Play the file
    audio.play(audioFile);
  });
});

##API

###Commands

// Set the output volume. Level is a Number from 0.0 to 1.0
audio.setVolume( level, function(err) {...} );

// Set the input to either 'lineIn' or 'microphone'. Defaults to 'lineIn'.
audio.setInput( input, function(err) {...} );

// Set the output to either 'lineOut' or 'headPhones'. Defaults to 'lineOut'.
audio.setOutput(output, function(err) {...} );

// Start recording sound from the input.
audio.startRecording( function(err) {...} );

// Stop recording sound and return an OGG-encoded buffer
audio.stopRecording( function(err, oggBuff) {...} );

// Play a buffer
audio.play( audioBuff, function(err) {...} );

// Pause the buffer
audio.pause( function(err) {...} );

// Stop playing and flush the buffer
audio.stop( function(err) {...} );

// Returns a stream that a buffer can be piped into to play audio
audio.createWriteableStream();

// Returns a readable stream of mic data
audio.createReadableStream()

###Events


// The audio module is ready to use 
audio.on( 'ready', function() {...} );

// The audio module had an error on connection
audio.on( 'error', function(err) {...} );

// Volume was set
audio.on( 'volume', function(volume) {...} );

// The input mode was set
audio.on('input', function(input) {...} );

// The output mode was set
audio.on('output', function(output) {...} );

// Started recording from the input
audio.on('startRecording', function() {...} );

// Stopped recording on the input
audio.on('stopRecording', function() {...} );

// A buffer is beginning to be played
audio.on('play', function() {...} );

// The buffer was paused
audio.on('pause', function() {...} );

// The buffer was stopped
audio.on('stop', function() {...} );

FAQs

Package last updated on 24 May 2014

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc