Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/xavierfoucrier/instacam
Instant canvas video
https://github.com/xavierfoucrier/instacam
audio camera canvas css-filters javascript microphone module npm video webcam webpack webrtc
Last synced: about 2 months ago
JSON representation
Instant canvas video
- Host: GitHub
- URL: https://github.com/xavierfoucrier/instacam
- Owner: xavierfoucrier
- License: mit
- Created: 2014-07-08T21:01:07.000Z (about 10 years ago)
- Default Branch: main
- Last Pushed: 2024-04-01T21:33:29.000Z (6 months ago)
- Last Synced: 2024-07-08T19:14:39.623Z (2 months ago)
- Topics: audio, camera, canvas, css-filters, javascript, microphone, module, npm, video, webcam, webpack, webrtc
- Language: JavaScript
- Homepage: https://instacam.js.org
- Size: 5.15 MB
- Stars: 140
- Watchers: 6
- Forks: 14
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-webrtc - instacam - Library to perform instant canvas video through the WebRTC API with a fresh touch of CSS filters. (JavaScript)
README
# Instacam – [](https://www.npmjs.com/package/instacam) [](https://bundlephobia.com/result?p=instacam)
Instacam is a library to perform **instant canvas video** through the WebRTC API with a fresh touch of CSS filters.
[](https://instacam.js.org)
## 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](https://caniuse.com) 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:
```console
# npm
npm install instacam
# yarn
yarn add instacam
```
> For other implementation of Instacam in your project, see the [usage documentation](DOCUMENTATION.md#usage)
## Documentation
Here you will find the documentation describing **how to use** the library.
1. [How it works](DOCUMENTATION.md#how-it-works) - how the library do the stuff
2. [Markup](DOCUMENTATION.md#markup) - how should the HTML and CSS look like
3. [Usage](DOCUMENTATION.md#usage) - how to use Instacam
4. [Data attributes](DOCUMENTATION.md#data-attributes) - set of data attributes
5. [Properties](DOCUMENTATION.md#properties) - all available properties
6. [Methods](DOCUMENTATION.md#methods) - all available methods
7. [Callbacks](DOCUMENTATION.md#callbacks) - all available callbacks
8. [Demo](DOCUMENTATION.md#demo) - Instacam in action
## Contribute
If you want to report a bug or request a new feature/improvement, please **read the project [contributors guidelines](.github/CONTRIBUTING.md) 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](LICENSE.md) for more information about your rights.
## Questions?
If you have any questions, please **feel free to contact me!**
[xavier.foucrier [at] gmail.com](mailto:[email protected])