react-native-vision-camera/README.md

90 lines
2.1 KiB
Markdown
Raw Normal View History

2021-02-19 08:08:26 -07:00
<table>
<tr>
2021-02-23 01:39:52 -07:00
<th>README</th>
2021-02-24 14:19:28 -07:00
<th><a href="./docs/SETUP.md">SETUP</a></th>
2021-02-23 01:39:52 -07:00
<th><a href="./docs/DEVICES.md">DEVICES</a></th>
<th><a href="./docs/FORMATS.md">FORMATS</a></th>
<th><a href="./docs/FRAME_PROCESSORS.md">FRAME_PROCESSORS</a></th>
<th><a href="./docs/ANIMATED.md">ANIMATED</a></th>
<th><a href="./docs/ERRORS.md">ERRORS</a></th>
2021-02-19 08:08:26 -07:00
</tr>
</table>
2021-02-23 01:36:50 -07:00
<br/>
<h1 align="center">Camera</h1>
2021-02-19 08:08:26 -07:00
<div align="center">
2021-02-24 13:51:47 -07:00
<img src="img/11.png" width="50%">
2021-02-19 08:08:26 -07:00
<br />
<br />
2021-02-20 08:45:10 -07:00
<blockquote><h4>📸 The Camera library that sees the vision.</h4></blockquote>
2021-02-19 08:08:26 -07:00
<br />
2021-02-25 05:02:10 -07:00
2021-02-23 03:16:08 -07:00
<a href="https://cuvent.com"><img height=40 src="./img/cuvent-logo-text.svg"></a>
2021-02-25 05:02:10 -07:00
<br/>
2021-02-25 05:41:07 -07:00
<span>
<a align="center" href="https://github.com/mrousavy?tab=followers">
2021-02-25 05:45:45 -07:00
<img src="https://img.shields.io/github/followers/mrousavy?label=Follow%20%40mrousavy&style=social" />
2021-02-25 05:41:07 -07:00
</a>
</span>
<br />
<span>
<a align="center" href="https://twitter.com/mrousavy">
<img src="https://img.shields.io/twitter/follow/mrousavy?label=Follow%20%40mrousavy&style=social" />
</a>
<a align="center" href="https://twitter.com/cuventtech">
<img src="https://img.shields.io/twitter/follow/cuventtech?label=Follow%20%40cuventtech&style=social" />
</a>
</span>
</table>
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="./img/example.png">
</div>
2021-02-19 08:08:26 -07:00
### Install
2021-02-19 08:07:53 -07:00
```sh
2021-03-01 01:34:34 -07:00
npm i react-native-vision-camera
2021-02-19 08:08:26 -07:00
npx pod-install
2021-02-19 08:07:53 -07:00
```
2021-02-20 08:45:10 -07:00
2021-02-20 08:48:32 -07:00
### Features
* Photo and Video capture
* Customizable device (`ultra-wide-angle`, `wide-angle`, `telephoto` and virtual multi-cameras)
2021-02-20 08:51:13 -07:00
* Customizable FPS
* JS worklet frame processors powered by JSI and Reanimated (WIP [#2](https://github.com/cuvent/react-native-vision-camera/pull/2))
2021-02-20 08:48:32 -07:00
* Reanimated zooming
* 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
<br />
2021-02-24 14:19:28 -07:00
#### 🚀 Get started by [setting up permissions](./docs/SETUP.md)!