npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@webcam/react

v1.0.1

Published

Ultimate tool for working with media stream and displaying it in your React application

Downloads

307

Readme

📸 Webcam React

Ultimate tool for working with media stream in your React application

References

Installation

Install with npm or yarn

npm i @webcam/react
# or
yarn add @webcam/react

🦉 Philosophy

📸 Webcam React is a package that includes ready-made solutions for common cases of setting up and using a media stream from your webcam using Web API. Our goal is to create simple and flexible tools that allow users to create, test and maintain their products.

Features

  • TypeScript support out of the box - full typed package
  • Webcam Snapshots - creating an image from a video stream
  • Media Stream Handling - request, errors, update, stop, etc
  • Advanced Video Settings - selecting camera type and resolution
  • Legacy API Support - outdated implementations for each browser
  • React Apps Support - component and hooks for working with playing a media stream

Usage

import React from 'react';
import ReactDOM from 'react-dom';
import { Webcam } from '@webcam/react';

const App = () => (
  <Webcam />
);

const root = ReactDOM.createRoot(document.getElementById('root'));
root.render(<App/>);

How to get webcam snapshot

Returns a base64 encoded string of the current video stream frame in the specified format and quality.

import { Webcam } from '@webcam/react';

const YourComponent = () => (
  <Webcam mirrored>
    {({ getSnapshot }) => (
      <button onClick={() => getSnapshot({ quality: 0.8 })}>
        Make photo
      </button>
    )}
  </Webcam>
);

API

You can pass any supported properties to the underlying video tag (eg autoPlay, className, etc). However, for convenience, the component uses its own values for these properties, but you can reassign them without any problems: | Prop | Type | Default | Note | | ------------------------- | -------- | ------------ | --------------------------------------------------------------------------------------- | | muted | boolean | true | excludes audio constraints from the MediaStream request | | autoPlay | boolean | true | | | playsInline | boolean | true | | | controls | boolean | false | |

The component also supports many properties for more specific work: | Prop | Type | Default | Note | | ------------------------- | -------- | ------------ | --------------------------------------------------------------------------------------- | | mirrored | boolean | false | show camera preview and get the screenshot mirrored | | mainCamera | boolean | object | false | should use a main camera (requires Navigator.mediaDevices.enumerateDevices) | | frontCamera | boolean | false | should use a front camera (MediaTrackConstraints['facingFront'] === 'user') | | applyConstraints | boolean | false | should new constraints be applied to the media stream | | cameraResolutionMode | string | 'ideal' | video track resolution mode - ('min' \| 'max' \| 'ideal' \| 'exact') | | cameraResolutionType | string | | video track resolution size - ('UHD' \| 'QHD' \| 'FHD' \| 'HD') | | requestTimeLimit | number | | limiting the media stream request by time | | onStreamRequest | function | | callback for when component requests a media stream | | onStreamStart | function | | callback for when component starts a media stream | | onStreamStop | function | | callback for when component stops a media stream | | onStreamError | function | | callback for when component can't receive a media stream | | audioConstraints | object ||MediaStreamConstraints['audio']| | videoConstraints | object ||MediaStreamConstraints['video']| | stream | object ||external MediaStream (turns off internal media stream handling logic)|

✨ Contributors