docs: Deploy to https://react-native-vision-camera.com
This commit is contained in:
parent
566eda2395
commit
757ecb0640
2
.github/ISSUE_TEMPLATE/BUG_REPORT.yml
vendored
2
.github/ISSUE_TEMPLATE/BUG_REPORT.yml
vendored
@ -47,7 +47,7 @@ body:
|
|||||||
description: Please check all the boxes that apply
|
description: Please check all the boxes that apply
|
||||||
options:
|
options:
|
||||||
- label: I am using Expo
|
- label: I am using Expo
|
||||||
- label: I have read the [Troubleshooting Guide](https://mrousavy.github.io/react-native-vision-camera/docs/guides/troubleshooting)
|
- label: I have read the [Troubleshooting Guide](https://react-native-vision-camera.com/docs/guides/troubleshooting)
|
||||||
required: true
|
required: true
|
||||||
- label: I agree to follow this project's [Code of Conduct](https://github.com/mrousavy/react-native-vision-camera/blob/main/CODE_OF_CONDUCT.md)
|
- label: I agree to follow this project's [Code of Conduct](https://github.com/mrousavy/react-native-vision-camera/blob/main/CODE_OF_CONDUCT.md)
|
||||||
required: true
|
required: true
|
||||||
|
2
.github/ISSUE_TEMPLATE/QUESTION.yml
vendored
2
.github/ISSUE_TEMPLATE/QUESTION.yml
vendored
@ -28,7 +28,7 @@ body:
|
|||||||
description: Please check all the boxes that apply
|
description: Please check all the boxes that apply
|
||||||
options:
|
options:
|
||||||
- label: I am using Expo
|
- label: I am using Expo
|
||||||
- label: I have read the [Troubleshooting Guide](https://mrousavy.github.io/react-native-vision-camera/docs/guides/troubleshooting)
|
- label: I have read the [Troubleshooting Guide](https://react-native-vision-camera.com/docs/guides/troubleshooting)
|
||||||
required: true
|
required: true
|
||||||
- label: I agree to follow this project's [Code of Conduct](https://github.com/mrousavy/react-native-vision-camera/blob/main/CODE_OF_CONDUCT.md)
|
- label: I agree to follow this project's [Code of Conduct](https://github.com/mrousavy/react-native-vision-camera/blob/main/CODE_OF_CONDUCT.md)
|
||||||
required: true
|
required: true
|
||||||
|
2
.github/ISSUE_TEMPLATE/config.yml
vendored
2
.github/ISSUE_TEMPLATE/config.yml
vendored
@ -1,7 +1,7 @@
|
|||||||
blank_issues_enabled: false
|
blank_issues_enabled: false
|
||||||
contact_links:
|
contact_links:
|
||||||
- name: Troubleshooting Guide
|
- name: Troubleshooting Guide
|
||||||
url: https://mrousavy.github.io/react-native-vision-camera/docs/guides/troubleshooting
|
url: https://react-native-vision-camera.com/docs/guides/troubleshooting
|
||||||
about: Please read the Troubleshooting Guide before opening an issue.
|
about: Please read the Troubleshooting Guide before opening an issue.
|
||||||
- name: VisionCamera Discussions
|
- name: VisionCamera Discussions
|
||||||
url: https://github.com/mrousavy/react-native-vision-camera/discussions
|
url: https://github.com/mrousavy/react-native-vision-camera/discussions
|
||||||
|
@ -36,8 +36,8 @@
|
|||||||
|
|
||||||
### Documentation
|
### Documentation
|
||||||
|
|
||||||
* [Guides](https://mrousavy.github.io/react-native-vision-camera/docs/guides)
|
* [Guides](https://react-native-vision-camera.com/docs/guides)
|
||||||
* [API](https://mrousavy.github.io/react-native-vision-camera/docs/api)
|
* [API](https://react-native-vision-camera.com/docs/api)
|
||||||
* [Example](./example/)
|
* [Example](./example/)
|
||||||
|
|
||||||
### Features
|
### Features
|
||||||
@ -45,7 +45,7 @@
|
|||||||
* Photo, Video and Snapshot capture
|
* Photo, Video and Snapshot capture
|
||||||
* Customizable devices and multi-cameras (smoothly zoom out to "fish-eye" camera)
|
* Customizable devices and multi-cameras (smoothly zoom out to "fish-eye" camera)
|
||||||
* Customizable FPS
|
* 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, ...)
|
* [Frame Processors](https://react-native-vision-camera.com/docs/guides/frame-processors) (JS worklets to run QR-Code scanning, facial recognition, AI object detection, realtime video chats, ...)
|
||||||
* Smooth zooming (Reanimated)
|
* Smooth zooming (Reanimated)
|
||||||
* Fast pause and resume
|
* Fast pause and resume
|
||||||
* HDR & Night modes
|
* HDR & Night modes
|
||||||
@ -82,4 +82,4 @@ If you're integrating VisionCamera in a production app, consider [funding this p
|
|||||||
|
|
||||||
<br />
|
<br />
|
||||||
|
|
||||||
#### 🚀 Get started by [setting up permissions](https://mrousavy.github.io/react-native-vision-camera/docs/guides/)!
|
#### 🚀 Get started by [setting up permissions](https://react-native-vision-camera.com/docs/guides/)!
|
||||||
|
@ -40,7 +40,7 @@ class NoCameraDeviceError : CameraError("device", "no-device", "No device was se
|
|||||||
class InvalidCameraDeviceError(cause: Throwable) : CameraError("device", "invalid-device", "The given Camera device could not be found for use-case binding!", cause)
|
class InvalidCameraDeviceError(cause: Throwable) : CameraError("device", "invalid-device", "The given Camera device could not be found for use-case binding!", cause)
|
||||||
class ParallelVideoProcessingNotSupportedError(cause: Throwable) : CameraError("device", "parallel-video-processing-not-supported", "The given LEGACY Camera device does not support parallel " +
|
class ParallelVideoProcessingNotSupportedError(cause: Throwable) : CameraError("device", "parallel-video-processing-not-supported", "The given LEGACY Camera device does not support parallel " +
|
||||||
"video processing (`video={true}` + `frameProcessor={...}`). Disable either `video` or `frameProcessor`. To find out if a device supports parallel video processing, check the `supportsParallelVideoProcessing` property on the CameraDevice. " +
|
"video processing (`video={true}` + `frameProcessor={...}`). Disable either `video` or `frameProcessor`. To find out if a device supports parallel video processing, check the `supportsParallelVideoProcessing` property on the CameraDevice. " +
|
||||||
"See https://mrousavy.github.io/react-native-vision-camera/docs/guides/devices#the-supportsparallelvideoprocessing-prop for more information.", cause)
|
"See https://react-native-vision-camera.com/docs/guides/devices#the-supportsparallelvideoprocessing-prop for more information.", cause)
|
||||||
|
|
||||||
class FpsNotContainedInFormatError(fps: Int) : CameraError("format", "invalid-fps", "The given FPS were not valid for the currently selected format. Make sure you select a format which `frameRateRanges` includes $fps FPS!")
|
class FpsNotContainedInFormatError(fps: Int) : CameraError("format", "invalid-fps", "The given FPS were not valid for the currently selected format. Make sure you select a format which `frameRateRanges` includes $fps FPS!")
|
||||||
class HdrNotContainedInFormatError() : CameraError(
|
class HdrNotContainedInFormatError() : CameraError(
|
||||||
|
@ -18,7 +18,7 @@ public abstract class FrameProcessorPlugin {
|
|||||||
* The actual Frame Processor plugin callback. Called for every frame the ImageAnalyzer receives.
|
* The actual Frame Processor plugin callback. Called for every frame the ImageAnalyzer receives.
|
||||||
* @param image The CameraX ImageProxy. Don't call .close() on this, as VisionCamera handles that.
|
* @param image The CameraX ImageProxy. Don't call .close() on this, as VisionCamera handles that.
|
||||||
* @return You can return any primitive, map or array you want. See the
|
* @return You can return any primitive, map or array you want. See the
|
||||||
* <a href="https://mrousavy.github.io/react-native-vision-camera/docs/guides/frame-processors-plugins-overview#types">Types</a>
|
* <a href="https://react-native-vision-camera.com/docs/guides/frame-processors-plugins-overview#types">Types</a>
|
||||||
* table for a list of supported types.
|
* table for a list of supported types.
|
||||||
*/
|
*/
|
||||||
@DoNotStrip
|
@DoNotStrip
|
||||||
|
@ -2,7 +2,7 @@ module.exports = {
|
|||||||
title: 'VisionCamera',
|
title: 'VisionCamera',
|
||||||
tagline: '📸 The Camera library that sees the vision.',
|
tagline: '📸 The Camera library that sees the vision.',
|
||||||
url: 'https://mrousavy.github.io',
|
url: 'https://mrousavy.github.io',
|
||||||
baseUrl: '/react-native-vision-camera/',
|
baseUrl: '/',
|
||||||
onBrokenLinks: 'throw',
|
onBrokenLinks: 'throw',
|
||||||
onBrokenMarkdownLinks: 'throw',
|
onBrokenMarkdownLinks: 'throw',
|
||||||
favicon: './favicon.ico',
|
favicon: './favicon.ico',
|
||||||
|
@ -64,7 +64,7 @@
|
|||||||
"bugs": {
|
"bugs": {
|
||||||
"url": "https://github.com/mrousavy/react-native-vision-camera/issues"
|
"url": "https://github.com/mrousavy/react-native-vision-camera/issues"
|
||||||
},
|
},
|
||||||
"homepage": "https://mrousavy.github.io/react-native-vision-camera/",
|
"homepage": "https://react-native-vision-camera.com/",
|
||||||
"publishConfig": {
|
"publishConfig": {
|
||||||
"registry": "https://registry.npmjs.org/"
|
"registry": "https://registry.npmjs.org/"
|
||||||
},
|
},
|
||||||
|
@ -44,7 +44,7 @@ if (CameraModule == null) console.error("Camera: Native Module 'CameraView' was
|
|||||||
/**
|
/**
|
||||||
* ### A powerful `<Camera>` component.
|
* ### A powerful `<Camera>` component.
|
||||||
*
|
*
|
||||||
* Read the [VisionCamera documentation](https://mrousavy.github.io/react-native-vision-camera/) for more information.
|
* Read the [VisionCamera documentation](https://react-native-vision-camera.com/) for more information.
|
||||||
*
|
*
|
||||||
* The `<Camera>` component's most important (and therefore _required_) properties are:
|
* The `<Camera>` component's most important (and therefore _required_) properties are:
|
||||||
*
|
*
|
||||||
@ -428,7 +428,7 @@ export class Camera extends React.PureComponent<CameraProps> {
|
|||||||
if (global.setFrameProcessor == null || global.unsetFrameProcessor == null) {
|
if (global.setFrameProcessor == null || global.unsetFrameProcessor == null) {
|
||||||
throw new CameraRuntimeError(
|
throw new CameraRuntimeError(
|
||||||
'frame-processor/unavailable',
|
'frame-processor/unavailable',
|
||||||
'Frame Processors are not enabled. See https://mrousavy.github.io/react-native-vision-camera/docs/guides/troubleshooting',
|
'Frame Processors are not enabled. See https://react-native-vision-camera.com/docs/guides/troubleshooting',
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@ -248,11 +248,11 @@ export interface CameraDevice {
|
|||||||
/**
|
/**
|
||||||
* All available formats for this camera device. Use this to find the best format for your use case and set it to the Camera's {@linkcode CameraProps.format | Camera's .format} property.
|
* All available formats for this camera device. Use this to find the best format for your use case and set it to the Camera's {@linkcode CameraProps.format | Camera's .format} property.
|
||||||
*
|
*
|
||||||
* See [the Camera Formats documentation](https://mrousavy.github.io/react-native-vision-camera/docs/guides/formats) for more information about Camera Formats.
|
* See [the Camera Formats documentation](https://react-native-vision-camera.com/docs/guides/formats) for more information about Camera Formats.
|
||||||
*/
|
*/
|
||||||
formats: CameraDeviceFormat[];
|
formats: CameraDeviceFormat[];
|
||||||
/**
|
/**
|
||||||
* Whether this camera device supports using Video Recordings (`video={true}`) and Frame Processors (`frameProcessor={...}`) at the same time. See ["The `supportsParallelVideoProcessing` prop"](https://mrousavy.github.io/react-native-vision-camera/docs/guides/devices#the-supportsparallelvideoprocessing-prop) for more information.
|
* Whether this camera device supports using Video Recordings (`video={true}`) and Frame Processors (`frameProcessor={...}`) at the same time. See ["The `supportsParallelVideoProcessing` prop"](https://react-native-vision-camera.com/docs/guides/devices#the-supportsparallelvideoprocessing-prop) for more information.
|
||||||
*
|
*
|
||||||
* If this property is `false`, you can only enable `video` or add a `frameProcessor`, but not both.
|
* If this property is `false`, you can only enable `video` or add a `frameProcessor`, but not both.
|
||||||
*
|
*
|
||||||
|
@ -152,14 +152,14 @@ class CameraError<TCode extends CameraErrorCode> extends Error {
|
|||||||
/**
|
/**
|
||||||
* Represents any kind of error that occured while trying to capture a video or photo.
|
* Represents any kind of error that occured while trying to capture a video or photo.
|
||||||
*
|
*
|
||||||
* See the ["Camera Errors" documentation](https://mrousavy.github.io/react-native-vision-camera/docs/guides/errors) for more information about Camera Errors.
|
* See the ["Camera Errors" documentation](https://react-native-vision-camera.com/docs/guides/errors) for more information about Camera Errors.
|
||||||
*/
|
*/
|
||||||
export class CameraCaptureError extends CameraError<CaptureError> {}
|
export class CameraCaptureError extends CameraError<CaptureError> {}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Represents any kind of error that occured in the Camera View Module.
|
* Represents any kind of error that occured in the Camera View Module.
|
||||||
*
|
*
|
||||||
* See the ["Camera Errors" documentation](https://mrousavy.github.io/react-native-vision-camera/docs/guides/errors) for more information about Camera Errors.
|
* See the ["Camera Errors" documentation](https://react-native-vision-camera.com/docs/guides/errors) for more information about Camera Errors.
|
||||||
*/
|
*/
|
||||||
export class CameraRuntimeError extends CameraError<
|
export class CameraRuntimeError extends CameraError<
|
||||||
PermissionError | ParameterError | DeviceError | FormatError | FrameProcessorError | SessionError | SystemError | UnknownError
|
PermissionError | ParameterError | DeviceError | FormatError | FrameProcessorError | SessionError | SystemError | UnknownError
|
||||||
|
@ -13,7 +13,7 @@ export interface CameraProps extends ViewProps {
|
|||||||
/**
|
/**
|
||||||
* The Camera Device to use.
|
* The Camera Device to use.
|
||||||
*
|
*
|
||||||
* See the [Camera Devices](https://mrousavy.github.io/react-native-vision-camera/docs/guides/devices) section in the documentation for more information about Camera Devices.
|
* See the [Camera Devices](https://react-native-vision-camera.com/docs/guides/devices) section in the documentation for more information about Camera Devices.
|
||||||
*
|
*
|
||||||
* @example
|
* @example
|
||||||
* ```tsx
|
* ```tsx
|
||||||
@ -31,7 +31,7 @@ export interface CameraProps extends ViewProps {
|
|||||||
*/
|
*/
|
||||||
device: CameraDevice;
|
device: CameraDevice;
|
||||||
/**
|
/**
|
||||||
* Whether the Camera should actively stream video frames, or not. See the [documentation about the `isActive` prop](https://mrousavy.github.io/react-native-vision-camera/docs/guides/lifecycle#the-isactive-prop) for more information.
|
* Whether the Camera should actively stream video frames, or not. See the [documentation about the `isActive` prop](https://react-native-vision-camera.com/docs/guides/lifecycle#the-isactive-prop) for more information.
|
||||||
*
|
*
|
||||||
* This can be compared to a Video component, where `isActive` specifies whether the video is paused or not.
|
* This can be compared to a Video component, where `isActive` specifies whether the video is paused or not.
|
||||||
*
|
*
|
||||||
@ -41,17 +41,17 @@ export interface CameraProps extends ViewProps {
|
|||||||
|
|
||||||
//#region Use-cases
|
//#region Use-cases
|
||||||
/**
|
/**
|
||||||
* Enables **photo capture** with the `takePhoto` function (see ["Taking Photos"](https://mrousavy.github.io/react-native-vision-camera/docs/guides/capturing#taking-photos))
|
* Enables **photo capture** with the `takePhoto` function (see ["Taking Photos"](https://react-native-vision-camera.com/docs/guides/capturing#taking-photos))
|
||||||
*/
|
*/
|
||||||
photo?: boolean;
|
photo?: boolean;
|
||||||
/**
|
/**
|
||||||
* Enables **video capture** with the `startRecording` function (see ["Recording Videos"](https://mrousavy.github.io/react-native-vision-camera/docs/guides/capturing/#recording-videos))
|
* Enables **video capture** with the `startRecording` function (see ["Recording Videos"](https://react-native-vision-camera.com/docs/guides/capturing/#recording-videos))
|
||||||
*
|
*
|
||||||
* Note: If you want to use `video` and `frameProcessor` simultaneously, make sure [`supportsParallelVideoProcessing`](https://mrousavy.github.io/react-native-vision-camera/docs/guides/devices#the-supportsparallelvideoprocessing-prop) is `true`.
|
* Note: If you want to use `video` and `frameProcessor` simultaneously, make sure [`supportsParallelVideoProcessing`](https://react-native-vision-camera.com/docs/guides/devices#the-supportsparallelvideoprocessing-prop) is `true`.
|
||||||
*/
|
*/
|
||||||
video?: boolean;
|
video?: boolean;
|
||||||
/**
|
/**
|
||||||
* Enables **audio capture** for video recordings (see ["Recording Videos"](https://mrousavy.github.io/react-native-vision-camera/docs/guides/capturing/#recording-videos))
|
* Enables **audio capture** for video recordings (see ["Recording Videos"](https://react-native-vision-camera.com/docs/guides/capturing/#recording-videos))
|
||||||
*/
|
*/
|
||||||
audio?: boolean;
|
audio?: boolean;
|
||||||
//#endregion
|
//#endregion
|
||||||
@ -80,7 +80,7 @@ export interface CameraProps extends ViewProps {
|
|||||||
/**
|
/**
|
||||||
* Enables or disables the native pinch to zoom gesture.
|
* Enables or disables the native pinch to zoom gesture.
|
||||||
*
|
*
|
||||||
* If you want to implement a custom zoom gesture, see [the Zooming with Reanimated documentation](https://mrousavy.github.io/react-native-vision-camera/docs/guides/animated).
|
* If you want to implement a custom zoom gesture, see [the Zooming with Reanimated documentation](https://react-native-vision-camera.com/docs/guides/animated).
|
||||||
*
|
*
|
||||||
* @default false
|
* @default false
|
||||||
*/
|
*/
|
||||||
@ -177,9 +177,9 @@ export interface CameraProps extends ViewProps {
|
|||||||
/**
|
/**
|
||||||
* A worklet which will be called for every frame the Camera "sees". Throttle the Frame Processor's frame rate with {@linkcode frameProcessorFps}.
|
* A worklet which will be called for every frame the Camera "sees". Throttle the Frame Processor's frame rate with {@linkcode frameProcessorFps}.
|
||||||
*
|
*
|
||||||
* > See [the Frame Processors documentation](https://mrousavy.github.io/react-native-vision-camera/docs/guides/frame-processors) for more information
|
* > See [the Frame Processors documentation](https://react-native-vision-camera.com/docs/guides/frame-processors) for more information
|
||||||
*
|
*
|
||||||
* Note: If you want to use `video` and `frameProcessor` simultaneously, make sure [`supportsParallelVideoProcessing`](https://mrousavy.github.io/react-native-vision-camera/docs/guides/devices#the-supportsparallelvideoprocessing-prop) is `true`.
|
* Note: If you want to use `video` and `frameProcessor` simultaneously, make sure [`supportsParallelVideoProcessing`](https://react-native-vision-camera.com/docs/guides/devices#the-supportsparallelvideoprocessing-prop) is `true`.
|
||||||
*
|
*
|
||||||
* @example
|
* @example
|
||||||
* ```tsx
|
* ```tsx
|
||||||
|
@ -8,7 +8,7 @@ type FrameProcessor = (frame: Frame) => void;
|
|||||||
const capturableConsole = console;
|
const capturableConsole = console;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Returns a memoized Frame Processor function wich you can pass to the `<Camera>`. (See ["Frame Processors"](https://mrousavy.github.io/react-native-vision-camera/docs/guides/frame-processors))
|
* Returns a memoized Frame Processor function wich you can pass to the `<Camera>`. (See ["Frame Processors"](https://react-native-vision-camera.com/docs/guides/frame-processors))
|
||||||
*
|
*
|
||||||
* Make sure to add the `'worklet'` directive to the top of the Frame Processor function, otherwise it will not get compiled into a worklet.
|
* Make sure to add the `'worklet'` directive to the top of the Frame Processor function, otherwise it will not get compiled into a worklet.
|
||||||
*
|
*
|
||||||
|
Loading…
Reference in New Issue
Block a user