railbird/react-native-vision-camera
8
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: Add "Templates" to Format docs

Browse Source
This commit is contained in:
Marc Rousavy 2023-10-24 14:50:29 +02:00
parent f90dace142
commit e1f8e1bd2a
No known key found for this signature in database
GPG Key ID: 8B9C709EA0B16A6D
1 changed files with 29 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
docs/docs/guides/FORMATS.mdx
View File

@ -148,6 +148,35 @@ const format = getCameraFormat(device, [
</TabItem>
</Tabs>
### Templates
For common use-cases, VisionCamera also exposes pre-defined Format templates:
<Tabs
groupId="component-style"
defaultValue="hooks"
values={[
{label: 'Hooks API', value: 'hooks'},
{label: 'Imperative API', value: 'imperative'}
]}>
<TabItem value="hooks">
```ts
const device = ...
const format = useCameraFormat(device, Templates.Snapchat)
```
</TabItem>
<TabItem value="imperative">
```ts
const device = ...
const format = getCameraFormat(device, Templates.Snapchat)
```
</TabItem>
</Tabs>
## Camera Props
The `Camera` View provides a few props that depend on the specified `format`. For example, you can only set the `fps` prop to a value that is supported by the current `format`. So if you have a format that supports 240 FPS, you can set the `fps` to `240`: