Skip to content

docs: fix incorrect API examples and default in camera docs #4030

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mrousavy merged 1 commit into from
Jun 22, 2026
Merged

docs: fix incorrect API examples and default in camera docs #4030

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/content/docs/photo-quality.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ const photoOutput = usePhotoOutput({
### Configure JPEG `quality`

Processed [`PhotoContainerFormat`](/api/react-native-vision-camera/type-aliases/PhotoContainerFormat)s (such as [`'jpeg'`](/api/react-native-vision-camera/type-aliases/PhotoContainerFormat) or [`'heic'`](/api/react-native-vision-camera/type-aliases/PhotoContainerFormat)) compress captured [`Photo`](/api/react-native-vision-camera/hybrid-objects/Photo)s.
By default, a compression of `0.95` (meaning 95% quality) is used, which can be adjusted via [`quality`](/api/react-native-vision-camera/interfaces/PhotoOutputOptions#quality) - for example, to capture in maximum quality set it to `1.0`:
By default, a compression of `0.9` (meaning 90% quality) is used, which can be adjusted via [`quality`](/api/react-native-vision-camera/interfaces/PhotoOutputOptions#quality) - for example, to capture in maximum quality set it to `1.0`:

```ts
const photoOutput = usePhotoOutput({
Expand Down
4 changes: 2 additions & 2 deletions docs/content/docs/recorder.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,12 +36,12 @@ To start a Video Recording, use [`Recorder.startRecording(...)`](/api/react-nati

```ts
const recorder = ...
await recorder.startRecording({
await recorder.startRecording(
(path, reason) => console.log(`Recording finished! ${reason}`),
(error) => console.error(`Recording error!`, error),
() => console.log(`Recording paused!`),
() => console.log(`Recording resumed!`)
})
)
```

#### Inspecting Progress
Expand Down
4 changes: 2 additions & 2 deletions packages/react-native-vision-camera/src/devices/getCameraDevice.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,9 @@ export interface DeviceFilter {
* @example
* ```ts
* // This device is simpler, so it starts up faster.
* getCameraDevice({ physicalDevices: ['wide-angle'] })
* getCameraDevice(devices, 'back', { physicalDevices: ['wide-angle'] })
* // This device is more complex, so it starts up slower, but you can switch between devices on 0.5x, 1x and 2x zoom.
* getCameraDevice({ physicalDevices: ['ultra-wide-angle', 'wide-angle', 'telephoto'] })
* getCameraDevice(devices, 'back', { physicalDevices: ['ultra-wide-angle', 'wide-angle', 'telephoto'] })
* ```
*/
physicalDevices?: PhysicalDeviceType[]
Expand Down