Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/danyshaanan/imagesnapjs

:package: An npm/nodejs wrapper for imagesnap
https://github.com/danyshaanan/imagesnapjs

Last synced: about 2 months ago
JSON representation

:package: An npm/nodejs wrapper for imagesnap

Awesome Lists containing this project

README

        

# imagesnapjs

[![Build Status](https://travis-ci.org/danyshaanan/imagesnapjs.png)](https://travis-ci.org/danyshaanan/imagesnapjs)
[![NPM Version](https://img.shields.io/npm/v/imagesnapjs.svg?style=flat)](https://npmjs.org/package/imagesnapjs)
[![License](http://img.shields.io/npm/l/imagesnapjs.svg?style=flat)](LICENSE)
[![Dependency Status](https://david-dm.org/danyshaanan/imagesnapjs.svg)](https://david-dm.org/danyshaanan/imagesnapjs)
[![devDependency Status](https://david-dm.org/danyshaanan/imagesnapjs/dev-status.svg)](https://david-dm.org/danyshaanan/imagesnapjs#info=devDependencies)

## An npm/nodejs wrapper for imagesnap

[imagesnap](https://github.com/rharder/imagesnap) is an OSX tool for capturing webcam photos from the command line,
written by [Robert Harder](https://github.com/rharder). (Thanks!)

imagesnapjs is first a wrapper, for making imagesnap installation as easy as `npm i -g imagesnapjs`,
and second, an npm dependency for capturing webcam shots from nodejs applications.

### As a command line tool

##### Installation

```
$ npm install -g imagesnapjs
```

##### Usage

see [the original documentation](https://github.com/rharder/imagesnap) or just type `imagesnap -h`.

### As an npm module

##### Installation

```
$ npm install --save imagesnapjs
```

##### Usage

```
var imagesnapjs = require('imagesnapjs');

imagesnapjs.capture('/Users/dany/image.jpg', { cliflags: '-w 2'}, function(err) {
console.log(err ? err : 'Success!');
});
```

The second options parameter is optional, and can include a
`cliflags` value of additional command line flags to be passed to the imagesnap command execution.

### Notes

* this is OSX specific! execution of the binary will fail on other systems.
* Using imageSnap v0.2.5

### Feedback

* If you enjoyed this package, please star it [on Github](https://github.com/danyshaanan/imagesnapjs).
* You are invited to [Open an issue on Github](https://github.com/danyshaanan/imagesnapjs/issues).
* For other matters, my email address can be found on my [NpmJS page](https://www.npmjs.org/~danyshaanan), my [Github page](https://github.com/danyshaanan), or my [website](http://danyshaanan.com/).
* Provide feedback or support for imageSnap itself from [imageSnap's page](http://www.iharder.net/current/macosx/imagesnap/).