react-native-vision-camera/README.md

74 lines
2.6 KiB
Markdown
Raw Normal View History

<h1 align="center">Vision Camera</h1>
2021-02-19 08:08:26 -07:00
<div align="center">
<img src="docs/static/img/11.png" width="50%">
2021-02-19 08:08:26 -07:00
<br />
<br />
2021-04-08 04:27:38 -06:00
<blockquote><b>📸 The Camera library that sees the vision.</b></blockquote>
2021-04-08 05:40:28 -06:00
<pre align="center">npm i <a href="https://www.npmjs.com/package/react-native-vision-camera">react-native-vision-camera</a><br/>npx pod-install </pre>
2021-06-21 14:45:13 -06:00
<a align="center" href='https://ko-fi.com/F1F8CLXG' target='_blank'>
<img height='36' style='border:0px;height:36px;' src='https://az743702.vo.msecnd.net/cdn/kofi2.png?v=0' border='0' alt='Buy Me a Coffee at ko-fi.com' />
</a>
<br/>
<a align="center" href="https://github.com/mrousavy?tab=followers">
<img src="https://img.shields.io/github/followers/mrousavy?label=Follow%20%40mrousavy&style=social" />
</a>
2021-02-25 05:41:07 -07:00
<br />
2021-06-21 14:45:13 -06:00
<a align="center" href="https://twitter.com/mrousavy">
<img src="https://img.shields.io/twitter/follow/mrousavy?label=Follow%20%40mrousavy&style=social" />
</a>
2021-02-19 08:08:26 -07:00
</div>
<br/>
<br/>
2021-02-20 08:45:10 -07:00
<div>
<img align="right" width="35%" src="docs/static/img/example.png">
2021-02-20 08:45:10 -07:00
</div>
2021-02-19 08:08:26 -07:00
### Documentation
* [Guides](https://mrousavy.github.io/react-native-vision-camera/docs/guides)
* [API](https://mrousavy.github.io/react-native-vision-camera/docs/api)
2021-03-03 12:48:57 -07:00
* [Example](./example/)
2021-02-20 08:48:32 -07:00
### Features
2021-03-23 10:08:06 -06:00
* Photo, Video and Snapshot capture
2021-03-23 10:10:17 -06:00
* Customizable devices and multi-cameras (smoothly zoom out to "fish-eye" camera)
2021-02-20 08:51:13 -07:00
* Customizable FPS
* [Frame Processors](https://mrousavy.github.io/react-native-vision-camera/docs/guides/frame-processors) (JS worklets to run QR-Code scanning, facial recognition, AI object detection, realtime video chats, ...)
2021-03-23 10:08:06 -06:00
* Smooth zooming (Reanimated)
* Fast pause and resume
2021-02-20 08:48:32 -07:00
* HDR & Night modes
2021-02-20 08:49:13 -07:00
> See the [example](./example/) app
2021-02-20 08:45:10 -07:00
### Example
```tsx
function App() {
2021-02-22 01:43:47 -07:00
const devices = useCameraDevices('wide-angle-camera')
const device = devices.back
2021-02-20 08:45:10 -07:00
2021-03-01 04:41:59 -07:00
if (device == null) return <LoadingView />
2021-02-20 08:45:10 -07:00
return (
<Camera
style={StyleSheet.absoluteFill}
device={device}
2021-02-23 02:56:05 -07:00
isActive={true}
2021-02-20 08:45:10 -07:00
/>
)
}
```
2021-02-24 13:56:50 -07:00
### Adopting at scale
VisionCamera is provided _as is_, I work on it in my free time.
2021-09-08 08:37:20 -06:00
If you're integrating VisionCamera in a production app, consider [funding this project](https://github.com/sponsors/mrousavy) and <a href="mailto:me@mrousavy.com?subject=Adopting VisionCamera at scale">contact me</a> to receive premium enterprise support, help with issues, prioritize bugfixes, request features, help at integrating VisionCamera and/or Frame Processors, and more.
2021-02-24 13:56:50 -07:00
<br />
#### 🚀 Get started by [setting up permissions](https://mrousavy.github.io/react-native-vision-camera/docs/guides/)!