react-camera-pro-with-torch
TypeScript icon, indicating that this package has built-in type declarations

1.1.4 • Public • Published

npm downloads

react-camera-pro-with-torch

Universal Camera component for React.

Designed with focus on Android and iOS cameras. Works with standard webcams as well.

See this for browser compatibility.

Note: WebRTC is only supported on secure connections. So you need to serve it from https. You can test and debug in Chrome from localhost though (this doesn't work in Safari).

Features

  • mobile friendly camera solution (tested on iOS and Android)
  • video element is fully responsive
    • you can setup parameter to cover your container
    • you can define aspectRatio of view: 16/9, 4/3, 1/1, ...
  • taking photo to base64 jpeg file - with same aspect Ratio as view, with FullHD resolution (or maximum supported by camera).
  • set quality of the photo taken as well.
  • working with standard webcams or other video input devices
  • supports autofocus
  • supports torch
  • switching between the different front and back cameras.
  • detect number of front or back cameras.
  • facing camera is mirrored, back is not.
  • controlled by react Ref
  • public functions to take photo, to switch camera and to get number of cameras
  • function to switch flash on/off
  • typescript library

Installation

npm install --save react-camera-pro-with-torch

Example

https://github.com/purple-technology/react-camera-pro/blob/master/example/src/App.tsx

Usage

import React, { useState, useRef } from "react";
import {Camera} from "react-camera-pro-with-torch";

const Component = () => {
  const camera = useRef(null);
  const [image, setImage] = useState(null);

  return (
    <div>
      <Camera ref={camera} />
      <button onClick={() => setImage(camera.current.takePhoto())}>Take photo</button>
      <img src={image} alt='Taken photo'/>
    </div>
  );
}

export Component;

Props

prop type default notes
facingMode 'front'|'back' 'front' default camera - 'front'
aspectRatio 'cover'|number 'cover' aspect ratio of video (16/9, 4/3);
numberOfFrontCamerasCallback (numberOffrontCameras: number):void () => null callback is called if number of cameras change
numberOfBackCamerasCallback (numberOfbackCameras: number):void () => null callback is called if number of cameras change
errorMessages object? see below see below Error messages object (optional)
pictureQuality number 0.9 number between 0 and 1, sets the image quality

Error messages (prop errorMessages)

Type:

errorMessages: {
  noCameraAccessible?: string;
  permissionDenied?: string;
  switchCamera?: string;
  canvas?: string;
};

Default:

  {
    noCameraAccessible: 'No camera device accessible. Please connect your camera or try a different browser.',
    permissionDenied: 'Permission denied. Please refresh and give camera permission.',
    switchCamera:
    'It is not possible to switch camera to different one because there is only one video device accessible.',
    canvas: 'Canvas is not supported.'
  }

Methods

  • takePhoto(): string - Returns a base64 encoded string of the taken image.
  • switchCamera(): void - Switches between the different cameras of the device depending on if chosen 'front' or 'back' in facingMode prop.
  • toggleTorch(): void - Toggles between on and off state of torch.
  • flashStatus(): Boolean - Returns if torch is supported by the current stream or not.
const Component = () => {
  const camera = useRef(null);
  const [numberOfCameras, setNumberOfCameras] = useState(0);
  const [image, setImage] = useState(null);
  const [devices, setDevices] = useState<MediaDeviceInfo[]>([]);

  //You need to add a useEffect hook to get the latest state change associated with flashStatus, otherwise
  //because of how useImperativeHandle is implemented, it will always give you the last state, not the current one which has been updated.
  //Slight inconvenience, if you know how to fix it, you can do a pull request.
  //Will highly appreciate it. Below useEffect hook does this!


  useEffect(() => {
    (async () => {
      const devices = await navigator.mediaDevices.enumerateDevices();
      const videoDevices = devices.filter((i) => i.kind == 'videoinput');
      setDevices(videoDevices);
    })();
  });

  return (
    <Camera ref={camera} facingMode='front' numberOfFrontCamerasCallback={setNumberOfCameras} />
      <img src={image} alt='Image preview' />
      <button
        onClick={() => {
            const photo = camera.current.takePhoto();
            setImage(photo);
        }}
      />
      <button
        hidden={numberOfCameras < 2}
        onClick={() => {
          camera.current.switchCamera();
        }}
      />

      {camera?.current?.flashStatus() ? (
        <button  onClick={()=>{
          if (camera?.current) {
            camera.current.toggleTorch();
          }}}>
          {/*Lightning Icon*/}
          <svg
            xmlns="http://www.w3.org/2000/svg"
            width={20}
            height={20}
            viewBox="0 0 16 16"
            fill="#00000"
          >
            <path d="M11.251.068a.5.5 0 0 1 .227.58L9.677 6.5H13a.5.5 0 0 1 .364.843l-8 8.5a.5.5 0 0 1-.842-.49L6.323 9.5H3a.5.5 0 0 1-.364-.843l8-8.5a.5.5 0 0 1 .615-.09zM4.157 8.5H7a.5.5 0 0 1 .478.647L6.11 13.59l5.732-6.09H9a.5.5 0 0 1-.478-.647L9.89 2.41 4.157 8.5z" />
          </svg>
        </button>
      ) : (
        ''
      )}

  )

Camera options

front/back camera

  const Cam = () => <Camera ref={camera} facingMode='front'} />

Aspect ratio

const Cam = () => <Camera ref={camera} aspectRatio={16 / 9} />;

Using within an iframe

<iframe src="https://example.com/camera-pro-iframe" allow="camera;"/>

Credits

License

MIT

Package Sidebar

Install

npm i react-camera-pro-with-torch

Weekly Downloads

5

Version

1.1.4

License

MIT

Unpacked Size

63.3 kB

Total Files

10

Last publish

Collaborators

  • strangerknowme