node-webcam

Cross platform webcam usage

Install

$3

``
#Linux relies on fswebcam currently
#ubuntu

sudo apt-get install fswebcam

#arch
#fswebcam requires a build from the AUR, it is not listed for installation on pacman/pamac

sudo pamac build fswebcam
`

$3

`
#Mac OSX relies on imagesnap
#Repo https://github.com/rharder/imagesnap
#Avaliable through brew

brew install imagesnap

`

$3

Standalone exe included. See src/bindings/CommandCam




Usage

$3

` javascript
//Available in nodejs

var NodeWebcam = require( "node-webcam" );


//Default options

var opts = {

//Picture related

width: 1280,

height: 720,

quality: 100,

// Number of frames to capture
// More the frames, longer it takes to capture
// Use higher framerate for quality. Ex: 60

frames: 60,


//Delay in seconds to take shot
//if the platform supports miliseconds
//use a float (0.1)
//Currently only on windows

delay: 0,


//Save shots in memory

saveShots: true,


// [jpeg, png] support varies
// Webcam.OutputTypes

output: "jpeg",


//Which camera to use
//Use Webcam.list() for results
//false for default device

device: false,


// [location, buffer, base64]
// Webcam.CallbackReturnTypes

callbackReturn: "location",


//Logging

verbose: false

};


//Creates webcam instance

var Webcam = NodeWebcam.create( opts );


//Will automatically append location output type

Webcam.capture( "test_picture", function( err, data ) {} );


//Also available for quick use

NodeWebcam.capture( "test_picture", opts, function( err, data ) {

});


//Get list of cameras

Webcam.list( function( list ) {

//Use another device

var anotherCam = NodeWebcam.create( { device: list[ 0 ] } );

});

//Return type with base 64 image

var opts = {
callbackReturn: "base64"
};

NodeWebcam.capture( "test_picture", opts, function( err, data ) {

var image = "";

});
`

$3

`
#Config opts

--width Picture width

--height Picture height

--delay Delay till shot

--quality Quality of image 0-100

--output Output type [png, jpg, bmp]

--verbose Verbose debugging

--help Usage help text

--version node-webcam version

--location Location to output webcam capture

--list list available camera devices


#Shorthand options

w: [ "--width" ],

h: [ "--height" ],

d: [ "--delay" ],

q: [ "--quality" ],

out: [ "--output" ],

h: [ "--help", true ],

v: [ "--version", true ],

l: [ "--location" ]


#node-webcam will auto output the file type at the end

node-webcam --w 500 --h 500 --d 2 --l picture # ./bin/node-webcam.js

`

Generated Documentation

`


install yuidoc and run


./bin/generate_doc.sh
`

Classes

NodeWebcam

Main require used. Also has helper functions just for you.

$3

Main factory creation of a webcam for use. Uses NodeWebcam.Factory to create.

`javascript
//Default options defined in API usage

var NodeWebcam = require( "node-webcam" );

var Webcam = NodeWebcam.create({});
`

$3

Quick helper for taking pictures via one function. Will return Webcam instance via NodeWebcam.create.

`javascript
NodeWebcam.capture( "my_picture", {}, function( err, data ) {

if ( !err ) console.log( "Image created!" );

});
`

Webcam

Base webcam class in which all other cameras inherit from

$3

`javascript
//Default options and basic usage

var opts = {

width: 1280,

height: 720,

delay: 0,

quality: 100,

// [jpeg, png] support varies
// Webcam.OutputTypes

output: "jpeg",

device: false,


// [buffer, base64]
// Webcam.CallbackReturnTypes

callbackReturn: "location",

verbose: false

}

var cam = new Webcam( opts );
`

$3

$3

Reset data and memory of past shots

$3

First param of callback will be a possible error or null. Second will return the location of the image or null. The following functions will follow similarly. This function will auto append the output type if not specified in file name.




$3

$3

$3

Get base 64 of shot number or data already grabbed from FS.

FSWebcam

Uses the fswebcam program. Available in linux (apt-get install fswebcam). Extra program addons provided in options.

`javascript
var NodeWebcam = require( "node-webcam" );

var FSWebcam = NodeWebcam.FSWebcam; //require( "node-webcam/webcams/FSWebcam" );

var opts = {};

var cam = new FSWebcam( opts );
``

What's next?

* Video capture functionality
* Battle testing
* What do you want to see? Leave an issue on the github page!