Skip to content

Latest commit

 

History

History
51 lines (36 loc) · 2.88 KB

README.md

File metadata and controls

51 lines (36 loc) · 2.88 KB
Raw

Instacam – npm npm

Instacam is a library to perform instant canvas video through the WebRTC API with a fresh touch of CSS filters.

Instacam

Compatibility

Instacam is fully tested on Google Chrome for desktop (latest public released version). The library is compatible with browsers that natively support the HTML5 canvas tag, requestAnimationFrame API, HTMLMediaElement API, navigator.mediaDevices and Promises API. The CSS filtering requires the CSS filter features to properly work.

Official support on Chrome 52+, Firefox 52+, Edge 15+ and Opera 52+. Many other browsers may work, but are not extensively tested. You can check at any time the support table about the partial or full support of these features.

Install

Instacam is published on the NPM (Node Package Manager) registry, so you can install it through the command line interpreter using your favorite package manager:

# npm
npm install instacam

# yarn
yarn add instacam

For other implementation of Instacam in your project, see the usage documentation

Documentation

Here you will find the documentation describing how to use the library.

  1. How it works - how the library do the stuff
  2. Markup - how should the HTML and CSS look like
  3. Usage - how to use Instacam
  4. Data attributes - set of data attributes
  5. Properties - all available properties
  6. Methods - all available methods
  7. Callbacks - all available callbacks
  8. Demo - Instacam in action

Contribute

If you want to report a bug or request a new feature/improvement, please read the project contributors guidelines before. Thanks for taking time to contribute.

License

The project is developed under the MIT license:

  • Permissions: This software and derivatives may be used for commercial purposes, you may distribute this software, this software may be modified and you may use and modify the software without distributing it.
  • Conditions: Include a copy of the license and copyright notice with the code.
  • Limitations: Software is provided without warranty and the software author/license owner cannot be held liable for damages.

Read the full license for more information about your rights.

Questions?

If you have any questions, please feel free to contact me!
xavier.foucrier [at] gmail.com