/ng-camera

AngularJS directive for capturing images form your computer's camera.

Primary LanguageHTML

ng-camera

Ng-camera is an AngularJS directive for capturing images form your computer's camera, and delivering them to you as Data URIs. The images is transmitted to your AngularJS controller and can be modified like you want.

To manage this process, ng-camera uses the WebcamJS standalone Javascript library developed by Joseph Huckaby, to ensure fallback and crossbrowser requirements.

Live example

To see a live example, go to the demo's page.

Installation

Using Bower

bower install ng-camera

Usage

Import files scripts

Ng-camera uses WebcamJS to work properly so you need to add the script in your main file, don't forget to load the directive file:

<script src="/path/to/webcam.js"></script>
<script src="/path/to/ng-camera.js"></script>

Add the module as dependency

Simply add the module as dependency to your main application module like this:

angular.module('myApplication', ['camera']);

The directive

<ng-camera
    capture-message="Cheeeese!"
    countdown="3"
    output-height="160"
    output-width="213"
    viewer-height="320"
    viewer-width="426"
    crop-height="90"
    crop-width="120"
    image-format="jpeg"
    jpeg-quality="100"
    action-message="Take picture"
    snapshot="vm.picture"
    flash-fallback-url="/vendors/webcamjs/webcam.swf"
    overlay-url="/overlay.png"
    shutter-url="/shutter.mp3"
></ng-camera>

Options

ng-camera comes with lots of options to simplify your development:

  • capture-message string Message to display when the countdown is finished | dependant of countdown
  • countdown string Number of seconds to wait and display before getting the snapshot | opional
  • output-height string Height of the captured snapshot image in pixels | default to viewer-height
  • output-width string Width of the captured snapshot image in pixels | default to 'viewer-width'
  • viewer-height string Height of the live camera viewer in pixels | default to the actual size of the DOM element 'auto'
  • crop-height string Crop height of the captured snapshot image in pixels | default to 'false'
  • crop-width string Crop width of the captured snapshot image in pixels | default to 'false'
  • image-format string Image format of captured snapshot image, may be jpeg or png | not used
  • jpeg-quality string For JPEG images, this is the desired quality, from 0 (worst) to 100 (best) | not used
  • action-message string Message/Text to display inside the action button
  • snapshot object AngularJS model to retreive the snapshot image to your controller
  • flash-fallback-url string Url of the Adobe Flash player to enable the fallback and crossbrowser modes, default based on navigator.getUserMedia
  • overlay-url string Overlay's url to display on top of the camera stream
  • shutter-url string Shutter sound's url to play when taking the snapshot

Working example

A working example is available in the app folder. Make sure to install bower and node dependencies:

npm install && bower install

Then start the node server, it will be accessible on http:0.0.0.0:3000

node server.js

License

The MIT License (MIT)

Copyright (c) 2015 Benjamin Cabanes

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.