jorgebambu / ngx-webcam

A simple Angular 4+ Webcam-Component / pure & minimal, no Flash-Fallback

Ngx-Webcam

A simple Angular 4+ Webcam-Component. Pure & minimal, no Flash-Fallback. See the Demo!

Plug-and-play. This library contains a single webcam-module which can be imported into nearly every Angular 4+ project.

Simple to use. The one component gives you full control and lets you take snapshots via actions and event bindings.

Minimal. No unnecessary Flash-fallbacks, no bundle-size bloating.

Demo

Try out the Live-Demo or see the Demo-Project.

Features

• Webcam live view
• Photo capturing
• Smartphone compatibility for modern OS's (OS must support WebRTC/UserMedia access)
• Access to front- and back-camera, if multiple cameras exist (feature in progress)
• Portrait & Landscape mode on smartphones

More features coming soon.

Prerequisites

Runtime Dependencies:

• Angular 2.x, 4.x or 5.x
• RxJs (Observables, Subjects)

Client:

• Current Browser w/ HTML5 and WebRTC/UserMedia support (Chrome >53, Safari >11, Firefox >38, Edge)
• Webcam :)
• User permissions to access the webcam

Usage

1. Install the library via standard npm command:

npm install --save ngx-webcam

2. Import the WebcamModule into your Angular module:

import {WebcamModule} from 'ngx-webcam';

@NgModule({
  imports: [
    WebcamModule
    ...
  ],
  ...
})
export class AppModule { }

3. Use the WebcamComponent on your pages:

<webcam></webcam>

As simple as that.

Options and Events

This section describes the basic Inputs/Outputs of the component.

Inputs

• trigger: Observable<void>: An Observable to trigger image capturing. When it fires, an image will be captured and emitted (see Outputs).

Outputs

• imageCapture: EventEmitter<WebcamImage>: Whenever an image is captured (e.g. triggered by [trigger]), the image is emitted via this EventEmitter. The image data is contained in the WebcamImage data structure.
• imageClick: EventEmitter<void>: An EventEmitter to signal clicks on the webcam area.
• initError: EventEmitter<WebcamInitError>: An EventEmitter to signal errors during the webcam initialization.

Development

Here you can find instructions on how to start developing this library.

Build

Run npm run packagr to build the library. The build artifacts will be stored in the dist/ directory.

Start

Run npm start to build and run the surrounding webapp with the WebcamModule. Essential for live-developing.

Generate docs/

Run npm run docs to generate the live-demo documentation pages in the docs/ directory.

Running Unit Tests

Run npm run test to run unit-tests.