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

Downgrade TypeScript to 4.1.5 to make the docusaurus plugin work again

Browse Source
This commit is contained in:
Marc Rousavy 2021-03-03 14:03:20 +01:00
parent 919aa3d82c
commit c31425523a
32 changed files with 205 additions and 205 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

44
docs/docs/api/classes/camera.camera-1.md
View File

@ -56,7 +56,7 @@ Name | Type |
**Returns:** [*Camera*](camera.camera-1.md) **Returns:** [*Camera*](camera.camera-1.md)
Defined in: [src/Camera.tsx:210](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/Camera.tsx#L210) Defined in: [src/Camera.tsx:210](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/Camera.tsx#L210)
## Properties ## Properties
@ -86,7 +86,7 @@ ___
• **displayName**: *string* • **displayName**: *string*
Defined in: [src/Camera.tsx:208](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/Camera.tsx#L208) Defined in: [src/Camera.tsx:208](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/Camera.tsx#L208)
___ ___
@ -102,7 +102,7 @@ ___
• `Private` `Readonly` **ref**: *RefObject*<RefType\> • `Private` `Readonly` **ref**: *RefObject*<RefType\>
Defined in: [src/Camera.tsx:210](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/Camera.tsx#L210) Defined in: [src/Camera.tsx:210](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/Camera.tsx#L210)
___ ___
@ -158,7 +158,7 @@ ___
▪ `Static` **displayName**: *string*= 'Camera' ▪ `Static` **displayName**: *string*= 'Camera'
Defined in: [src/Camera.tsx:207](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/Camera.tsx#L207) Defined in: [src/Camera.tsx:207](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/Camera.tsx#L207)
## Accessors ## Accessors
@ -168,7 +168,7 @@ Defined in: [src/Camera.tsx:207](https://github.com/cuvent/react-native-vision-c
**Returns:** *null* \| *number* **Returns:** *null* \| *number*
Defined in: [src/Camera.tsx:221](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/Camera.tsx#L221) Defined in: [src/Camera.tsx:221](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/Camera.tsx#L221)
## Methods ## Methods
@ -429,7 +429,7 @@ Name | Type | Description |
**Returns:** *Promise*<void\> **Returns:** *Promise*<void\>
Defined in: [src/Camera.tsx:326](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/Camera.tsx#L326) Defined in: [src/Camera.tsx:326](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/Camera.tsx#L326)
___ ___
@ -460,7 +460,7 @@ so only use this after the `onInitialized` event has fired.
**Returns:** *Promise*<[*CameraPhotoCodec*](../modules/cameracodec.md#cameraphotocodec)[]\> **Returns:** *Promise*<[*CameraPhotoCodec*](../modules/cameracodec.md#cameraphotocodec)[]\>
Defined in: [src/Camera.tsx:353](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/Camera.tsx#L353) Defined in: [src/Camera.tsx:353](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/Camera.tsx#L353)
___ ___
@ -475,7 +475,7 @@ so only use this after the `onInitialized` event has fired.
**Returns:** *Promise*<[*CameraVideoCodec*](../modules/cameracodec.md#cameravideocodec)[]\> **Returns:** *Promise*<[*CameraVideoCodec*](../modules/cameracodec.md#cameravideocodec)[]\>
Defined in: [src/Camera.tsx:340](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/Camera.tsx#L340) Defined in: [src/Camera.tsx:340](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/Camera.tsx#L340)
___ ___
@ -515,7 +515,7 @@ Name | Type |
**Returns:** *void* **Returns:** *void*
Defined in: [src/Camera.tsx:445](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/Camera.tsx#L445) Defined in: [src/Camera.tsx:445](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/Camera.tsx#L445)
___ ___
@ -531,7 +531,7 @@ Name | Type |
**Returns:** *void* **Returns:** *void*
Defined in: [src/Camera.tsx:428](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/Camera.tsx#L428) Defined in: [src/Camera.tsx:428](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/Camera.tsx#L428)
___ ___
@ -541,7 +541,7 @@ ___
**Returns:** *void* **Returns:** *void*
Defined in: [src/Camera.tsx:441](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/Camera.tsx#L441) Defined in: [src/Camera.tsx:441](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/Camera.tsx#L441)
___ ___
@ -551,7 +551,7 @@ ___
**Returns:** ReactNode **Returns:** ReactNode
Defined in: [src/Camera.tsx:461](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/Camera.tsx#L461) Defined in: [src/Camera.tsx:461](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/Camera.tsx#L461)
___ ___
@ -638,7 +638,7 @@ Name | Type |
**Returns:** *void* **Returns:** *void*
Defined in: [src/Camera.tsx:282](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/Camera.tsx#L282) Defined in: [src/Camera.tsx:282](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/Camera.tsx#L282)
___ ___
@ -658,7 +658,7 @@ setTimeout(async () => {
**Returns:** *Promise*<void\> **Returns:** *Promise*<void\>
Defined in: [src/Camera.tsx:309](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/Camera.tsx#L309) Defined in: [src/Camera.tsx:309](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/Camera.tsx#L309)
___ ___
@ -678,7 +678,7 @@ Name | Type |
**Returns:** *Promise*<Readonly<*Readonly*<{ `path`: *string* }\> & { `height`: *number* ; `isRawPhoto`: *boolean* ; `metadata`: { `DPIHeight`: *number* ; `DPIWidth`: *number* ; `Orientation`: *number* ; `{Exif}`: { `ApertureValue`: *number* ; `BrightnessValue`: *number* ; `ColorSpace`: *number* ; `DateTimeDigitized`: *string* ; `DateTimeOriginal`: *string* ; `ExifVersion`: *string* ; `ExposureBiasValue`: *number* ; `ExposureMode`: *number* ; `ExposureProgram`: *number* ; `ExposureTime`: *number* ; `FNumber`: *number* ; `Flash`: *number* ; `FocalLenIn35mmFilm`: *number* ; `FocalLength`: *number* ; `ISOSpeedRatings`: *number*[] ; `LensMake`: *string* ; `LensModel`: *string* ; `LensSpecification`: *number*[] ; `MeteringMode`: *number* ; `OffsetTime`: *string* ; `OffsetTimeDigitized`: *string* ; `OffsetTimeOriginal`: *string* ; `PixelXDimension`: *number* ; `PixelYDimension`: *number* ; `SceneType`: *number* ; `SensingMethod`: *number* ; `ShutterSpeedValue`: *number* ; `SubjectArea`: *number*[] ; `SubsecTimeDigitized`: *string* ; `SubsecTimeOriginal`: *string* ; `WhiteBalance`: *number* } ; `{MakerApple}?`: *undefined* \| *Record*<string, unknown\> ; `{TIFF}`: { `DateTime`: *string* ; `HostComputer?`: *undefined* \| *string* ; `Make`: *string* ; `Model`: *string* ; `ResolutionUnit`: *number* ; `Software`: *string* ; `XResolution`: *number* ; `YResolution`: *number* } } ; `thumbnail?`: *undefined* \| *Record*<string, unknown\> ; `width`: *number* }\>\> **Returns:** *Promise*<Readonly<*Readonly*<{ `path`: *string* }\> & { `height`: *number* ; `isRawPhoto`: *boolean* ; `metadata`: { `DPIHeight`: *number* ; `DPIWidth`: *number* ; `Orientation`: *number* ; `{Exif}`: { `ApertureValue`: *number* ; `BrightnessValue`: *number* ; `ColorSpace`: *number* ; `DateTimeDigitized`: *string* ; `DateTimeOriginal`: *string* ; `ExifVersion`: *string* ; `ExposureBiasValue`: *number* ; `ExposureMode`: *number* ; `ExposureProgram`: *number* ; `ExposureTime`: *number* ; `FNumber`: *number* ; `Flash`: *number* ; `FocalLenIn35mmFilm`: *number* ; `FocalLength`: *number* ; `ISOSpeedRatings`: *number*[] ; `LensMake`: *string* ; `LensModel`: *string* ; `LensSpecification`: *number*[] ; `MeteringMode`: *number* ; `OffsetTime`: *string* ; `OffsetTimeDigitized`: *string* ; `OffsetTimeOriginal`: *string* ; `PixelXDimension`: *number* ; `PixelYDimension`: *number* ; `SceneType`: *number* ; `SensingMethod`: *number* ; `ShutterSpeedValue`: *number* ; `SubjectArea`: *number*[] ; `SubsecTimeDigitized`: *string* ; `SubsecTimeOriginal`: *string* ; `WhiteBalance`: *number* } ; `{MakerApple}?`: *undefined* \| *Record*<string, unknown\> ; `{TIFF}`: { `DateTime`: *string* ; `HostComputer?`: *undefined* \| *string* ; `Make`: *string* ; `Model`: *string* ; `ResolutionUnit`: *number* ; `Software`: *string* ; `XResolution`: *number* ; `YResolution`: *number* } } ; `thumbnail?`: *undefined* \| *Record*<string, unknown\> ; `width`: *number* }\>\>
Defined in: [src/Camera.tsx:234](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/Camera.tsx#L234) Defined in: [src/Camera.tsx:234](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/Camera.tsx#L234)
___ ___
@ -700,7 +700,7 @@ Name | Type |
**Returns:** *Promise*<Readonly<*Readonly*<{ `path`: *string* }\> & { `height`: *number* ; `isRawPhoto`: *boolean* ; `metadata`: { `DPIHeight`: *number* ; `DPIWidth`: *number* ; `Orientation`: *number* ; `{Exif}`: { `ApertureValue`: *number* ; `BrightnessValue`: *number* ; `ColorSpace`: *number* ; `DateTimeDigitized`: *string* ; `DateTimeOriginal`: *string* ; `ExifVersion`: *string* ; `ExposureBiasValue`: *number* ; `ExposureMode`: *number* ; `ExposureProgram`: *number* ; `ExposureTime`: *number* ; `FNumber`: *number* ; `Flash`: *number* ; `FocalLenIn35mmFilm`: *number* ; `FocalLength`: *number* ; `ISOSpeedRatings`: *number*[] ; `LensMake`: *string* ; `LensModel`: *string* ; `LensSpecification`: *number*[] ; `MeteringMode`: *number* ; `OffsetTime`: *string* ; `OffsetTimeDigitized`: *string* ; `OffsetTimeOriginal`: *string* ; `PixelXDimension`: *number* ; `PixelYDimension`: *number* ; `SceneType`: *number* ; `SensingMethod`: *number* ; `ShutterSpeedValue`: *number* ; `SubjectArea`: *number*[] ; `SubsecTimeDigitized`: *string* ; `SubsecTimeOriginal`: *string* ; `WhiteBalance`: *number* } ; `{MakerApple}?`: *undefined* \| *Record*<string, unknown\> ; `{TIFF}`: { `DateTime`: *string* ; `HostComputer?`: *undefined* \| *string* ; `Make`: *string* ; `Model`: *string* ; `ResolutionUnit`: *number* ; `Software`: *string* ; `XResolution`: *number* ; `YResolution`: *number* } } ; `thumbnail?`: *undefined* \| *Record*<string, unknown\> ; `width`: *number* }\>\> **Returns:** *Promise*<Readonly<*Readonly*<{ `path`: *string* }\> & { `height`: *number* ; `isRawPhoto`: *boolean* ; `metadata`: { `DPIHeight`: *number* ; `DPIWidth`: *number* ; `Orientation`: *number* ; `{Exif}`: { `ApertureValue`: *number* ; `BrightnessValue`: *number* ; `ColorSpace`: *number* ; `DateTimeDigitized`: *string* ; `DateTimeOriginal`: *string* ; `ExifVersion`: *string* ; `ExposureBiasValue`: *number* ; `ExposureMode`: *number* ; `ExposureProgram`: *number* ; `ExposureTime`: *number* ; `FNumber`: *number* ; `Flash`: *number* ; `FocalLenIn35mmFilm`: *number* ; `FocalLength`: *number* ; `ISOSpeedRatings`: *number*[] ; `LensMake`: *string* ; `LensModel`: *string* ; `LensSpecification`: *number*[] ; `MeteringMode`: *number* ; `OffsetTime`: *string* ; `OffsetTimeDigitized`: *string* ; `OffsetTimeOriginal`: *string* ; `PixelXDimension`: *number* ; `PixelYDimension`: *number* ; `SceneType`: *number* ; `SensingMethod`: *number* ; `ShutterSpeedValue`: *number* ; `SubjectArea`: *number*[] ; `SubsecTimeDigitized`: *string* ; `SubsecTimeOriginal`: *string* ; `WhiteBalance`: *number* } ; `{MakerApple}?`: *undefined* \| *Record*<string, unknown\> ; `{TIFF}`: { `DateTime`: *string* ; `HostComputer?`: *undefined* \| *string* ; `Make`: *string* ; `Model`: *string* ; `ResolutionUnit`: *number* ; `Software`: *string* ; `XResolution`: *number* ; `YResolution`: *number* } } ; `thumbnail?`: *undefined* \| *Record*<string, unknown\> ; `width`: *number* }\>\>
Defined in: [src/Camera.tsx:249](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/Camera.tsx#L249) Defined in: [src/Camera.tsx:249](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/Camera.tsx#L249)
___ ___
@ -712,7 +712,7 @@ Get a list of all available camera devices on the current phone.
**Returns:** *Promise*<Readonly<{ `devices`: [*PhysicalCameraDeviceType*](../modules/cameradevice.md#physicalcameradevicetype)[] ; `formats`: *Readonly*<{ `autoFocusSystem`: [*AutoFocusSystem*](../modules/cameradevice.md#autofocussystem) ; `colorSpaces`: [*ColorSpace*](../modules/cameradevice.md#colorspace)[] ; `fieldOfView`: *number* ; `frameRateRanges`: *Readonly*<{ `maxFrameRate`: *number* ; `minFrameRate`: *number* }\>[] ; `isHighestPhotoQualitySupported?`: *undefined* \| *boolean* ; `maxISO`: *number* ; `maxZoom`: *number* ; `minISO`: *number* ; `photoHeight`: *number* ; `photoWidth`: *number* ; `supportsPhotoHDR`: *boolean* ; `supportsVideoHDR`: *boolean* ; `videoHeight?`: *undefined* \| *number* ; `videoStabilizationModes`: [*VideoStabilizationMode*](../modules/cameradevice.md#videostabilizationmode)[] ; `videoWidth?`: *undefined* \| *number* }\>[] ; `hasFlash`: *boolean* ; `hasTorch`: *boolean* ; `id`: *string* ; `isMultiCam`: *boolean* ; `maxZoom`: *number* ; `minZoom`: *number* ; `name`: *string* ; `neutralZoom`: *number* ; `position`: [*CameraPosition*](../modules/cameraposition.md#cameraposition) ; `supportsLowLightBoost`: *boolean* }\>[]\> **Returns:** *Promise*<Readonly<{ `devices`: [*PhysicalCameraDeviceType*](../modules/cameradevice.md#physicalcameradevicetype)[] ; `formats`: *Readonly*<{ `autoFocusSystem`: [*AutoFocusSystem*](../modules/cameradevice.md#autofocussystem) ; `colorSpaces`: [*ColorSpace*](../modules/cameradevice.md#colorspace)[] ; `fieldOfView`: *number* ; `frameRateRanges`: *Readonly*<{ `maxFrameRate`: *number* ; `minFrameRate`: *number* }\>[] ; `isHighestPhotoQualitySupported?`: *undefined* \| *boolean* ; `maxISO`: *number* ; `maxZoom`: *number* ; `minISO`: *number* ; `photoHeight`: *number* ; `photoWidth`: *number* ; `supportsPhotoHDR`: *boolean* ; `supportsVideoHDR`: *boolean* ; `videoHeight?`: *undefined* \| *number* ; `videoStabilizationModes`: [*VideoStabilizationMode*](../modules/cameradevice.md#videostabilizationmode)[] ; `videoWidth?`: *undefined* \| *number* }\>[] ; `hasFlash`: *boolean* ; `hasTorch`: *boolean* ; `id`: *string* ; `isMultiCam`: *boolean* ; `maxZoom`: *number* ; `minZoom`: *number* ; `name`: *string* ; `neutralZoom`: *number* ; `position`: [*CameraPosition*](../modules/cameraposition.md#cameraposition) ; `supportsLowLightBoost`: *boolean* }\>[]\>
Defined in: [src/Camera.tsx:366](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/Camera.tsx#L366) Defined in: [src/Camera.tsx:366](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/Camera.tsx#L366)
___ ___
@ -727,7 +727,7 @@ To actually prompt the user for camera permission, use `Camera.requestCameraPerm
**Returns:** *Promise*<[*CameraPermissionStatus*](../modules/camera.md#camerapermissionstatus)\> **Returns:** *Promise*<[*CameraPermissionStatus*](../modules/camera.md#camerapermissionstatus)\>
Defined in: [src/Camera.tsx:379](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/Camera.tsx#L379) Defined in: [src/Camera.tsx:379](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/Camera.tsx#L379)
___ ___
@ -744,7 +744,7 @@ Name | Type |
**Returns:** *null* \| CameraState **Returns:** *null* \| CameraState
Defined in: [src/Camera.tsx:454](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/Camera.tsx#L454) Defined in: [src/Camera.tsx:454](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/Camera.tsx#L454)
___ ___
@ -759,7 +759,7 @@ To actually prompt the user for microphone permission, use `Camera.requestMicrop
**Returns:** *Promise*<[*CameraPermissionStatus*](../modules/camera.md#camerapermissionstatus)\> **Returns:** *Promise*<[*CameraPermissionStatus*](../modules/camera.md#camerapermissionstatus)\>
Defined in: [src/Camera.tsx:392](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/Camera.tsx#L392) Defined in: [src/Camera.tsx:392](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/Camera.tsx#L392)
___ ___
@ -774,7 +774,7 @@ and `"denied"` will be returned.
**Returns:** *Promise*<[*CameraPermissionRequestResult*](../modules/camera.md#camerapermissionrequestresult)\> **Returns:** *Promise*<[*CameraPermissionRequestResult*](../modules/camera.md#camerapermissionrequestresult)\>
Defined in: [src/Camera.tsx:405](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/Camera.tsx#L405) Defined in: [src/Camera.tsx:405](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/Camera.tsx#L405)
___ ___
@ -789,4 +789,4 @@ and `"denied"` will be returned.
**Returns:** *Promise*<[*CameraPermissionRequestResult*](../modules/camera.md#camerapermissionrequestresult)\> **Returns:** *Promise*<[*CameraPermissionRequestResult*](../modules/camera.md#camerapermissionrequestresult)\>
Defined in: [src/Camera.tsx:418](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/Camera.tsx#L418) Defined in: [src/Camera.tsx:418](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/Camera.tsx#L418)

12
docs/docs/api/classes/cameraerror.cameracaptureerror.md
View File

@ -34,7 +34,7 @@ Name | Type |
**Returns:** [*CameraCaptureError*](cameraerror.cameracaptureerror.md) **Returns:** [*CameraCaptureError*](cameraerror.cameracaptureerror.md)
Defined in: [src/CameraError.ts:105](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/CameraError.ts#L105) Defined in: [src/CameraError.ts:105](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/CameraError.ts#L105)
## Properties ## Properties
@ -42,7 +42,7 @@ Defined in: [src/CameraError.ts:105](https://github.com/cuvent/react-native-visi
• **name**: *string* • **name**: *string*
Defined in: node_modules/typescript/lib/lib.es5.d.ts:973 Defined in: docs/node_modules/typescript/lib/lib.es5.d.ts:973
___ ___
@ -50,7 +50,7 @@ ___
• `Optional` **stack**: *undefined* \| *string* • `Optional` **stack**: *undefined* \| *string*
Defined in: node_modules/typescript/lib/lib.es5.d.ts:975 Defined in: docs/node_modules/typescript/lib/lib.es5.d.ts:975
___ ___
@ -80,7 +80,7 @@ Defined in: node_modules/@types/node/globals.d.ts:13
**Returns:** *undefined* \| [*ErrorWithCause*](../interfaces/cameraerror.errorwithcause.md) **Returns:** *undefined* \| [*ErrorWithCause*](../interfaces/cameraerror.errorwithcause.md)
Defined in: [src/CameraError.ts:103](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/CameraError.ts#L103) Defined in: [src/CameraError.ts:103](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/CameraError.ts#L103)
___ ___
@ -90,7 +90,7 @@ ___
**Returns:** TCode **Returns:** TCode
Defined in: [src/CameraError.ts:97](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/CameraError.ts#L97) Defined in: [src/CameraError.ts:97](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/CameraError.ts#L97)
___ ___
@ -100,7 +100,7 @@ ___
**Returns:** *string* **Returns:** *string*
Defined in: [src/CameraError.ts:100](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/CameraError.ts#L100) Defined in: [src/CameraError.ts:100](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/CameraError.ts#L100)
## Methods ## Methods

12
docs/docs/api/classes/cameraerror.cameraruntimeerror.md
View File

@ -34,7 +34,7 @@ Name | Type |
**Returns:** [*CameraRuntimeError*](cameraerror.cameraruntimeerror.md) **Returns:** [*CameraRuntimeError*](cameraerror.cameraruntimeerror.md)
Defined in: [src/CameraError.ts:105](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/CameraError.ts#L105) Defined in: [src/CameraError.ts:105](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/CameraError.ts#L105)
## Properties ## Properties
@ -42,7 +42,7 @@ Defined in: [src/CameraError.ts:105](https://github.com/cuvent/react-native-visi
• **name**: *string* • **name**: *string*
Defined in: node_modules/typescript/lib/lib.es5.d.ts:973 Defined in: docs/node_modules/typescript/lib/lib.es5.d.ts:973
___ ___
@ -62,7 +62,7 @@ ___
• `Optional` **stack**: *undefined* \| *string* • `Optional` **stack**: *undefined* \| *string*
Defined in: node_modules/typescript/lib/lib.es5.d.ts:975 Defined in: docs/node_modules/typescript/lib/lib.es5.d.ts:975
___ ___
@ -80,7 +80,7 @@ Defined in: node_modules/@types/node/globals.d.ts:13
**Returns:** *undefined* \| [*ErrorWithCause*](../interfaces/cameraerror.errorwithcause.md) **Returns:** *undefined* \| [*ErrorWithCause*](../interfaces/cameraerror.errorwithcause.md)
Defined in: [src/CameraError.ts:103](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/CameraError.ts#L103) Defined in: [src/CameraError.ts:103](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/CameraError.ts#L103)
___ ___
@ -90,7 +90,7 @@ ___
**Returns:** TCode **Returns:** TCode
Defined in: [src/CameraError.ts:97](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/CameraError.ts#L97) Defined in: [src/CameraError.ts:97](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/CameraError.ts#L97)
___ ___
@ -100,7 +100,7 @@ ___
**Returns:** *string* **Returns:** *string*
Defined in: [src/CameraError.ts:100](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/CameraError.ts#L100) Defined in: [src/CameraError.ts:100](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/CameraError.ts#L100)
## Methods ## Methods

44
docs/docs/api/classes/index.camera.md
View File

@ -56,7 +56,7 @@ Name | Type |
**Returns:** [*Camera*](camera.camera-1.md) **Returns:** [*Camera*](camera.camera-1.md)
Defined in: [src/Camera.tsx:210](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/Camera.tsx#L210) Defined in: [src/Camera.tsx:210](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/Camera.tsx#L210)
## Properties ## Properties
@ -86,7 +86,7 @@ ___
• **displayName**: *string* • **displayName**: *string*
Defined in: [src/Camera.tsx:208](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/Camera.tsx#L208) Defined in: [src/Camera.tsx:208](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/Camera.tsx#L208)
___ ___
@ -102,7 +102,7 @@ ___
• `Private` `Readonly` **ref**: *RefObject*<RefType\> • `Private` `Readonly` **ref**: *RefObject*<RefType\>
Defined in: [src/Camera.tsx:210](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/Camera.tsx#L210) Defined in: [src/Camera.tsx:210](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/Camera.tsx#L210)
___ ___
@ -158,7 +158,7 @@ ___
▪ `Static` **displayName**: *string*= 'Camera' ▪ `Static` **displayName**: *string*= 'Camera'
Defined in: [src/Camera.tsx:207](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/Camera.tsx#L207) Defined in: [src/Camera.tsx:207](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/Camera.tsx#L207)
## Accessors ## Accessors
@ -168,7 +168,7 @@ Defined in: [src/Camera.tsx:207](https://github.com/cuvent/react-native-vision-c
**Returns:** *null* \| *number* **Returns:** *null* \| *number*
Defined in: [src/Camera.tsx:221](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/Camera.tsx#L221) Defined in: [src/Camera.tsx:221](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/Camera.tsx#L221)
## Methods ## Methods
@ -429,7 +429,7 @@ Name | Type | Description |
**Returns:** *Promise*<void\> **Returns:** *Promise*<void\>
Defined in: [src/Camera.tsx:326](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/Camera.tsx#L326) Defined in: [src/Camera.tsx:326](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/Camera.tsx#L326)
___ ___
@ -460,7 +460,7 @@ so only use this after the `onInitialized` event has fired.
**Returns:** *Promise*<[*CameraPhotoCodec*](../modules/cameracodec.md#cameraphotocodec)[]\> **Returns:** *Promise*<[*CameraPhotoCodec*](../modules/cameracodec.md#cameraphotocodec)[]\>
Defined in: [src/Camera.tsx:353](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/Camera.tsx#L353) Defined in: [src/Camera.tsx:353](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/Camera.tsx#L353)
___ ___
@ -475,7 +475,7 @@ so only use this after the `onInitialized` event has fired.
**Returns:** *Promise*<[*CameraVideoCodec*](../modules/cameracodec.md#cameravideocodec)[]\> **Returns:** *Promise*<[*CameraVideoCodec*](../modules/cameracodec.md#cameravideocodec)[]\>
Defined in: [src/Camera.tsx:340](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/Camera.tsx#L340) Defined in: [src/Camera.tsx:340](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/Camera.tsx#L340)
___ ___
@ -515,7 +515,7 @@ Name | Type |
**Returns:** *void* **Returns:** *void*
Defined in: [src/Camera.tsx:445](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/Camera.tsx#L445) Defined in: [src/Camera.tsx:445](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/Camera.tsx#L445)
___ ___
@ -531,7 +531,7 @@ Name | Type |
**Returns:** *void* **Returns:** *void*
Defined in: [src/Camera.tsx:428](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/Camera.tsx#L428) Defined in: [src/Camera.tsx:428](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/Camera.tsx#L428)
___ ___
@ -541,7 +541,7 @@ ___
**Returns:** *void* **Returns:** *void*
Defined in: [src/Camera.tsx:441](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/Camera.tsx#L441) Defined in: [src/Camera.tsx:441](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/Camera.tsx#L441)
___ ___
@ -551,7 +551,7 @@ ___
**Returns:** ReactNode **Returns:** ReactNode
Defined in: [src/Camera.tsx:461](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/Camera.tsx#L461) Defined in: [src/Camera.tsx:461](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/Camera.tsx#L461)
___ ___
@ -638,7 +638,7 @@ Name | Type |
**Returns:** *void* **Returns:** *void*
Defined in: [src/Camera.tsx:282](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/Camera.tsx#L282) Defined in: [src/Camera.tsx:282](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/Camera.tsx#L282)
___ ___
@ -658,7 +658,7 @@ setTimeout(async () => {
**Returns:** *Promise*<void\> **Returns:** *Promise*<void\>
Defined in: [src/Camera.tsx:309](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/Camera.tsx#L309) Defined in: [src/Camera.tsx:309](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/Camera.tsx#L309)
___ ___
@ -678,7 +678,7 @@ Name | Type |
**Returns:** *Promise*<Readonly<*Readonly*<{ `path`: *string* }\> & { `height`: *number* ; `isRawPhoto`: *boolean* ; `metadata`: { `DPIHeight`: *number* ; `DPIWidth`: *number* ; `Orientation`: *number* ; `{Exif}`: { `ApertureValue`: *number* ; `BrightnessValue`: *number* ; `ColorSpace`: *number* ; `DateTimeDigitized`: *string* ; `DateTimeOriginal`: *string* ; `ExifVersion`: *string* ; `ExposureBiasValue`: *number* ; `ExposureMode`: *number* ; `ExposureProgram`: *number* ; `ExposureTime`: *number* ; `FNumber`: *number* ; `Flash`: *number* ; `FocalLenIn35mmFilm`: *number* ; `FocalLength`: *number* ; `ISOSpeedRatings`: *number*[] ; `LensMake`: *string* ; `LensModel`: *string* ; `LensSpecification`: *number*[] ; `MeteringMode`: *number* ; `OffsetTime`: *string* ; `OffsetTimeDigitized`: *string* ; `OffsetTimeOriginal`: *string* ; `PixelXDimension`: *number* ; `PixelYDimension`: *number* ; `SceneType`: *number* ; `SensingMethod`: *number* ; `ShutterSpeedValue`: *number* ; `SubjectArea`: *number*[] ; `SubsecTimeDigitized`: *string* ; `SubsecTimeOriginal`: *string* ; `WhiteBalance`: *number* } ; `{MakerApple}?`: *undefined* \| *Record*<string, unknown\> ; `{TIFF}`: { `DateTime`: *string* ; `HostComputer?`: *undefined* \| *string* ; `Make`: *string* ; `Model`: *string* ; `ResolutionUnit`: *number* ; `Software`: *string* ; `XResolution`: *number* ; `YResolution`: *number* } } ; `thumbnail?`: *undefined* \| *Record*<string, unknown\> ; `width`: *number* }\>\> **Returns:** *Promise*<Readonly<*Readonly*<{ `path`: *string* }\> & { `height`: *number* ; `isRawPhoto`: *boolean* ; `metadata`: { `DPIHeight`: *number* ; `DPIWidth`: *number* ; `Orientation`: *number* ; `{Exif}`: { `ApertureValue`: *number* ; `BrightnessValue`: *number* ; `ColorSpace`: *number* ; `DateTimeDigitized`: *string* ; `DateTimeOriginal`: *string* ; `ExifVersion`: *string* ; `ExposureBiasValue`: *number* ; `ExposureMode`: *number* ; `ExposureProgram`: *number* ; `ExposureTime`: *number* ; `FNumber`: *number* ; `Flash`: *number* ; `FocalLenIn35mmFilm`: *number* ; `FocalLength`: *number* ; `ISOSpeedRatings`: *number*[] ; `LensMake`: *string* ; `LensModel`: *string* ; `LensSpecification`: *number*[] ; `MeteringMode`: *number* ; `OffsetTime`: *string* ; `OffsetTimeDigitized`: *string* ; `OffsetTimeOriginal`: *string* ; `PixelXDimension`: *number* ; `PixelYDimension`: *number* ; `SceneType`: *number* ; `SensingMethod`: *number* ; `ShutterSpeedValue`: *number* ; `SubjectArea`: *number*[] ; `SubsecTimeDigitized`: *string* ; `SubsecTimeOriginal`: *string* ; `WhiteBalance`: *number* } ; `{MakerApple}?`: *undefined* \| *Record*<string, unknown\> ; `{TIFF}`: { `DateTime`: *string* ; `HostComputer?`: *undefined* \| *string* ; `Make`: *string* ; `Model`: *string* ; `ResolutionUnit`: *number* ; `Software`: *string* ; `XResolution`: *number* ; `YResolution`: *number* } } ; `thumbnail?`: *undefined* \| *Record*<string, unknown\> ; `width`: *number* }\>\>
Defined in: [src/Camera.tsx:234](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/Camera.tsx#L234) Defined in: [src/Camera.tsx:234](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/Camera.tsx#L234)
___ ___
@ -700,7 +700,7 @@ Name | Type |
**Returns:** *Promise*<Readonly<*Readonly*<{ `path`: *string* }\> & { `height`: *number* ; `isRawPhoto`: *boolean* ; `metadata`: { `DPIHeight`: *number* ; `DPIWidth`: *number* ; `Orientation`: *number* ; `{Exif}`: { `ApertureValue`: *number* ; `BrightnessValue`: *number* ; `ColorSpace`: *number* ; `DateTimeDigitized`: *string* ; `DateTimeOriginal`: *string* ; `ExifVersion`: *string* ; `ExposureBiasValue`: *number* ; `ExposureMode`: *number* ; `ExposureProgram`: *number* ; `ExposureTime`: *number* ; `FNumber`: *number* ; `Flash`: *number* ; `FocalLenIn35mmFilm`: *number* ; `FocalLength`: *number* ; `ISOSpeedRatings`: *number*[] ; `LensMake`: *string* ; `LensModel`: *string* ; `LensSpecification`: *number*[] ; `MeteringMode`: *number* ; `OffsetTime`: *string* ; `OffsetTimeDigitized`: *string* ; `OffsetTimeOriginal`: *string* ; `PixelXDimension`: *number* ; `PixelYDimension`: *number* ; `SceneType`: *number* ; `SensingMethod`: *number* ; `ShutterSpeedValue`: *number* ; `SubjectArea`: *number*[] ; `SubsecTimeDigitized`: *string* ; `SubsecTimeOriginal`: *string* ; `WhiteBalance`: *number* } ; `{MakerApple}?`: *undefined* \| *Record*<string, unknown\> ; `{TIFF}`: { `DateTime`: *string* ; `HostComputer?`: *undefined* \| *string* ; `Make`: *string* ; `Model`: *string* ; `ResolutionUnit`: *number* ; `Software`: *string* ; `XResolution`: *number* ; `YResolution`: *number* } } ; `thumbnail?`: *undefined* \| *Record*<string, unknown\> ; `width`: *number* }\>\> **Returns:** *Promise*<Readonly<*Readonly*<{ `path`: *string* }\> & { `height`: *number* ; `isRawPhoto`: *boolean* ; `metadata`: { `DPIHeight`: *number* ; `DPIWidth`: *number* ; `Orientation`: *number* ; `{Exif}`: { `ApertureValue`: *number* ; `BrightnessValue`: *number* ; `ColorSpace`: *number* ; `DateTimeDigitized`: *string* ; `DateTimeOriginal`: *string* ; `ExifVersion`: *string* ; `ExposureBiasValue`: *number* ; `ExposureMode`: *number* ; `ExposureProgram`: *number* ; `ExposureTime`: *number* ; `FNumber`: *number* ; `Flash`: *number* ; `FocalLenIn35mmFilm`: *number* ; `FocalLength`: *number* ; `ISOSpeedRatings`: *number*[] ; `LensMake`: *string* ; `LensModel`: *string* ; `LensSpecification`: *number*[] ; `MeteringMode`: *number* ; `OffsetTime`: *string* ; `OffsetTimeDigitized`: *string* ; `OffsetTimeOriginal`: *string* ; `PixelXDimension`: *number* ; `PixelYDimension`: *number* ; `SceneType`: *number* ; `SensingMethod`: *number* ; `ShutterSpeedValue`: *number* ; `SubjectArea`: *number*[] ; `SubsecTimeDigitized`: *string* ; `SubsecTimeOriginal`: *string* ; `WhiteBalance`: *number* } ; `{MakerApple}?`: *undefined* \| *Record*<string, unknown\> ; `{TIFF}`: { `DateTime`: *string* ; `HostComputer?`: *undefined* \| *string* ; `Make`: *string* ; `Model`: *string* ; `ResolutionUnit`: *number* ; `Software`: *string* ; `XResolution`: *number* ; `YResolution`: *number* } } ; `thumbnail?`: *undefined* \| *Record*<string, unknown\> ; `width`: *number* }\>\>
Defined in: [src/Camera.tsx:249](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/Camera.tsx#L249) Defined in: [src/Camera.tsx:249](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/Camera.tsx#L249)
___ ___
@ -712,7 +712,7 @@ Get a list of all available camera devices on the current phone.
**Returns:** *Promise*<Readonly<{ `devices`: [*PhysicalCameraDeviceType*](../modules/cameradevice.md#physicalcameradevicetype)[] ; `formats`: *Readonly*<{ `autoFocusSystem`: [*AutoFocusSystem*](../modules/cameradevice.md#autofocussystem) ; `colorSpaces`: [*ColorSpace*](../modules/cameradevice.md#colorspace)[] ; `fieldOfView`: *number* ; `frameRateRanges`: *Readonly*<{ `maxFrameRate`: *number* ; `minFrameRate`: *number* }\>[] ; `isHighestPhotoQualitySupported?`: *undefined* \| *boolean* ; `maxISO`: *number* ; `maxZoom`: *number* ; `minISO`: *number* ; `photoHeight`: *number* ; `photoWidth`: *number* ; `supportsPhotoHDR`: *boolean* ; `supportsVideoHDR`: *boolean* ; `videoHeight?`: *undefined* \| *number* ; `videoStabilizationModes`: [*VideoStabilizationMode*](../modules/cameradevice.md#videostabilizationmode)[] ; `videoWidth?`: *undefined* \| *number* }\>[] ; `hasFlash`: *boolean* ; `hasTorch`: *boolean* ; `id`: *string* ; `isMultiCam`: *boolean* ; `maxZoom`: *number* ; `minZoom`: *number* ; `name`: *string* ; `neutralZoom`: *number* ; `position`: [*CameraPosition*](../modules/cameraposition.md#cameraposition) ; `supportsLowLightBoost`: *boolean* }\>[]\> **Returns:** *Promise*<Readonly<{ `devices`: [*PhysicalCameraDeviceType*](../modules/cameradevice.md#physicalcameradevicetype)[] ; `formats`: *Readonly*<{ `autoFocusSystem`: [*AutoFocusSystem*](../modules/cameradevice.md#autofocussystem) ; `colorSpaces`: [*ColorSpace*](../modules/cameradevice.md#colorspace)[] ; `fieldOfView`: *number* ; `frameRateRanges`: *Readonly*<{ `maxFrameRate`: *number* ; `minFrameRate`: *number* }\>[] ; `isHighestPhotoQualitySupported?`: *undefined* \| *boolean* ; `maxISO`: *number* ; `maxZoom`: *number* ; `minISO`: *number* ; `photoHeight`: *number* ; `photoWidth`: *number* ; `supportsPhotoHDR`: *boolean* ; `supportsVideoHDR`: *boolean* ; `videoHeight?`: *undefined* \| *number* ; `videoStabilizationModes`: [*VideoStabilizationMode*](../modules/cameradevice.md#videostabilizationmode)[] ; `videoWidth?`: *undefined* \| *number* }\>[] ; `hasFlash`: *boolean* ; `hasTorch`: *boolean* ; `id`: *string* ; `isMultiCam`: *boolean* ; `maxZoom`: *number* ; `minZoom`: *number* ; `name`: *string* ; `neutralZoom`: *number* ; `position`: [*CameraPosition*](../modules/cameraposition.md#cameraposition) ; `supportsLowLightBoost`: *boolean* }\>[]\>
Defined in: [src/Camera.tsx:366](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/Camera.tsx#L366) Defined in: [src/Camera.tsx:366](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/Camera.tsx#L366)
___ ___
@ -727,7 +727,7 @@ To actually prompt the user for camera permission, use `Camera.requestCameraPerm
**Returns:** *Promise*<[*CameraPermissionStatus*](../modules/camera.md#camerapermissionstatus)\> **Returns:** *Promise*<[*CameraPermissionStatus*](../modules/camera.md#camerapermissionstatus)\>
Defined in: [src/Camera.tsx:379](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/Camera.tsx#L379) Defined in: [src/Camera.tsx:379](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/Camera.tsx#L379)
___ ___
@ -744,7 +744,7 @@ Name | Type |
**Returns:** *null* \| CameraState **Returns:** *null* \| CameraState
Defined in: [src/Camera.tsx:454](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/Camera.tsx#L454) Defined in: [src/Camera.tsx:454](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/Camera.tsx#L454)
___ ___
@ -759,7 +759,7 @@ To actually prompt the user for microphone permission, use `Camera.requestMicrop
**Returns:** *Promise*<[*CameraPermissionStatus*](../modules/camera.md#camerapermissionstatus)\> **Returns:** *Promise*<[*CameraPermissionStatus*](../modules/camera.md#camerapermissionstatus)\>
Defined in: [src/Camera.tsx:392](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/Camera.tsx#L392) Defined in: [src/Camera.tsx:392](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/Camera.tsx#L392)
___ ___
@ -774,7 +774,7 @@ and `"denied"` will be returned.
**Returns:** *Promise*<[*CameraPermissionRequestResult*](../modules/camera.md#camerapermissionrequestresult)\> **Returns:** *Promise*<[*CameraPermissionRequestResult*](../modules/camera.md#camerapermissionrequestresult)\>
Defined in: [src/Camera.tsx:405](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/Camera.tsx#L405) Defined in: [src/Camera.tsx:405](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/Camera.tsx#L405)
___ ___
@ -789,4 +789,4 @@ and `"denied"` will be returned.
**Returns:** *Promise*<[*CameraPermissionRequestResult*](../modules/camera.md#camerapermissionrequestresult)\> **Returns:** *Promise*<[*CameraPermissionRequestResult*](../modules/camera.md#camerapermissionrequestresult)\>
Defined in: [src/Camera.tsx:418](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/Camera.tsx#L418) Defined in: [src/Camera.tsx:418](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/Camera.tsx#L418)

12
docs/docs/api/classes/index.cameracaptureerror.md
View File

@ -34,7 +34,7 @@ Name | Type |
**Returns:** [*CameraCaptureError*](cameraerror.cameracaptureerror.md) **Returns:** [*CameraCaptureError*](cameraerror.cameracaptureerror.md)
Defined in: [src/CameraError.ts:105](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/CameraError.ts#L105) Defined in: [src/CameraError.ts:105](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/CameraError.ts#L105)
## Properties ## Properties
@ -42,7 +42,7 @@ Defined in: [src/CameraError.ts:105](https://github.com/cuvent/react-native-visi
• **name**: *string* • **name**: *string*
Defined in: node_modules/typescript/lib/lib.es5.d.ts:973 Defined in: docs/node_modules/typescript/lib/lib.es5.d.ts:973
___ ___
@ -62,7 +62,7 @@ ___
• `Optional` **stack**: *undefined* \| *string* • `Optional` **stack**: *undefined* \| *string*
Defined in: node_modules/typescript/lib/lib.es5.d.ts:975 Defined in: docs/node_modules/typescript/lib/lib.es5.d.ts:975
___ ___
@ -80,7 +80,7 @@ Defined in: node_modules/@types/node/globals.d.ts:13
**Returns:** *undefined* \| [*ErrorWithCause*](../interfaces/cameraerror.errorwithcause.md) **Returns:** *undefined* \| [*ErrorWithCause*](../interfaces/cameraerror.errorwithcause.md)
Defined in: [src/CameraError.ts:103](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/CameraError.ts#L103) Defined in: [src/CameraError.ts:103](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/CameraError.ts#L103)
___ ___
@ -90,7 +90,7 @@ ___
**Returns:** TCode **Returns:** TCode
Defined in: [src/CameraError.ts:97](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/CameraError.ts#L97) Defined in: [src/CameraError.ts:97](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/CameraError.ts#L97)
___ ___
@ -100,7 +100,7 @@ ___
**Returns:** *string* **Returns:** *string*
Defined in: [src/CameraError.ts:100](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/CameraError.ts#L100) Defined in: [src/CameraError.ts:100](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/CameraError.ts#L100)
## Methods ## Methods

12
docs/docs/api/classes/index.cameraruntimeerror.md
View File

@ -34,7 +34,7 @@ Name | Type |
**Returns:** [*CameraRuntimeError*](cameraerror.cameraruntimeerror.md) **Returns:** [*CameraRuntimeError*](cameraerror.cameraruntimeerror.md)
Defined in: [src/CameraError.ts:105](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/CameraError.ts#L105) Defined in: [src/CameraError.ts:105](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/CameraError.ts#L105)
## Properties ## Properties
@ -42,7 +42,7 @@ Defined in: [src/CameraError.ts:105](https://github.com/cuvent/react-native-visi
• **name**: *string* • **name**: *string*
Defined in: node_modules/typescript/lib/lib.es5.d.ts:973 Defined in: docs/node_modules/typescript/lib/lib.es5.d.ts:973
___ ___
@ -62,7 +62,7 @@ ___
• `Optional` **stack**: *undefined* \| *string* • `Optional` **stack**: *undefined* \| *string*
Defined in: node_modules/typescript/lib/lib.es5.d.ts:975 Defined in: docs/node_modules/typescript/lib/lib.es5.d.ts:975
___ ___
@ -80,7 +80,7 @@ Defined in: node_modules/@types/node/globals.d.ts:13
**Returns:** *undefined* \| [*ErrorWithCause*](../interfaces/cameraerror.errorwithcause.md) **Returns:** *undefined* \| [*ErrorWithCause*](../interfaces/cameraerror.errorwithcause.md)
Defined in: [src/CameraError.ts:103](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/CameraError.ts#L103) Defined in: [src/CameraError.ts:103](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/CameraError.ts#L103)
___ ___
@ -90,7 +90,7 @@ ___
**Returns:** TCode **Returns:** TCode
Defined in: [src/CameraError.ts:97](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/CameraError.ts#L97) Defined in: [src/CameraError.ts:97](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/CameraError.ts#L97)
___ ___
@ -100,7 +100,7 @@ ___
**Returns:** *string* **Returns:** *string*
Defined in: [src/CameraError.ts:100](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/CameraError.ts#L100) Defined in: [src/CameraError.ts:100](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/CameraError.ts#L100)
## Methods ## Methods

12
docs/docs/api/interfaces/cameraerror.errorwithcause.md
View File

@ -23,7 +23,7 @@ Optional additional cause for nested errors
* iOS: N/A * iOS: N/A
* Android: `Throwable.cause` * Android: `Throwable.cause`
Defined in: [src/CameraError.ts:84](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/CameraError.ts#L84) Defined in: [src/CameraError.ts:84](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/CameraError.ts#L84)
___ ___
@ -36,7 +36,7 @@ The native error's code.
* iOS: `NSError.code` * iOS: `NSError.code`
* Android: N/A * Android: N/A
Defined in: [src/CameraError.ts:49](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/CameraError.ts#L49) Defined in: [src/CameraError.ts:49](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/CameraError.ts#L49)
___ ___
@ -49,7 +49,7 @@ Optional additional details
* iOS: `NSError.userInfo` * iOS: `NSError.userInfo`
* Android: N/A * Android: N/A
Defined in: [src/CameraError.ts:70](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/CameraError.ts#L70) Defined in: [src/CameraError.ts:70](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/CameraError.ts#L70)
___ ___
@ -62,7 +62,7 @@ The native error's domain.
* iOS: `NSError.domain` * iOS: `NSError.domain`
* Android: N/A * Android: N/A
Defined in: [src/CameraError.ts:56](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/CameraError.ts#L56) Defined in: [src/CameraError.ts:56](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/CameraError.ts#L56)
___ ___
@ -75,7 +75,7 @@ The native error description (Localized on iOS)
* iOS: `NSError.message` * iOS: `NSError.message`
* Android: `Throwable.message` * Android: `Throwable.message`
Defined in: [src/CameraError.ts:63](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/CameraError.ts#L63) Defined in: [src/CameraError.ts:63](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/CameraError.ts#L63)
___ ___
@ -88,4 +88,4 @@ Optional stacktrace
* iOS: N/A * iOS: N/A
* Android: `Throwable.stacktrace.toString()` * Android: `Throwable.stacktrace.toString()`
Defined in: [src/CameraError.ts:77](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/CameraError.ts#L77) Defined in: [src/CameraError.ts:77](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/CameraError.ts#L77)

12
docs/docs/api/interfaces/index.errorwithcause.md
View File

@ -23,7 +23,7 @@ Optional additional cause for nested errors
* iOS: N/A * iOS: N/A
* Android: `Throwable.cause` * Android: `Throwable.cause`
Defined in: [src/CameraError.ts:84](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/CameraError.ts#L84) Defined in: [src/CameraError.ts:84](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/CameraError.ts#L84)
___ ___
@ -36,7 +36,7 @@ The native error's code.
* iOS: `NSError.code` * iOS: `NSError.code`
* Android: N/A * Android: N/A
Defined in: [src/CameraError.ts:49](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/CameraError.ts#L49) Defined in: [src/CameraError.ts:49](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/CameraError.ts#L49)
___ ___
@ -49,7 +49,7 @@ Optional additional details
* iOS: `NSError.userInfo` * iOS: `NSError.userInfo`
* Android: N/A * Android: N/A
Defined in: [src/CameraError.ts:70](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/CameraError.ts#L70) Defined in: [src/CameraError.ts:70](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/CameraError.ts#L70)
___ ___
@ -62,7 +62,7 @@ The native error's domain.
* iOS: `NSError.domain` * iOS: `NSError.domain`
* Android: N/A * Android: N/A
Defined in: [src/CameraError.ts:56](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/CameraError.ts#L56) Defined in: [src/CameraError.ts:56](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/CameraError.ts#L56)
___ ___
@ -75,7 +75,7 @@ The native error description (Localized on iOS)
* iOS: `NSError.message` * iOS: `NSError.message`
* Android: `Throwable.message` * Android: `Throwable.message`
Defined in: [src/CameraError.ts:63](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/CameraError.ts#L63) Defined in: [src/CameraError.ts:63](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/CameraError.ts#L63)
___ ___
@ -88,4 +88,4 @@ Optional stacktrace
* iOS: N/A * iOS: N/A
* Android: `Throwable.stacktrace.toString()` * Android: `Throwable.stacktrace.toString()`
Defined in: [src/CameraError.ts:77](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/CameraError.ts#L77) Defined in: [src/CameraError.ts:77](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/CameraError.ts#L77)

4
docs/docs/api/interfaces/index.point.md
View File

@ -20,7 +20,7 @@ Represents a Point in a 2 dimensional coordinate system.
The X coordinate of this Point. (double) The X coordinate of this Point. (double)
Defined in: [src/Point.ts:8](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/Point.ts#L8) Defined in: [src/Point.ts:8](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/Point.ts#L8)
___ ___
@ -30,4 +30,4 @@ ___
The Y coordinate of this Point. (double) The Y coordinate of this Point. (double)
Defined in: [src/Point.ts:12](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/Point.ts#L12) Defined in: [src/Point.ts:12](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/Point.ts#L12)

10
docs/docs/api/interfaces/index.recordvideooptions.md
View File

@ -18,7 +18,7 @@ hide_title: true
Set the video flash mode. Natively, this just enables the torch while recording. Set the video flash mode. Natively, this just enables the torch while recording.
Defined in: [src/VideoFile.ts:36](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/VideoFile.ts#L36) Defined in: [src/VideoFile.ts:36](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/VideoFile.ts#L36)
___ ___
@ -40,9 +40,9 @@ Name | Type |
**Returns:** *void* **Returns:** *void*
Defined in: [src/VideoFile.ts:40](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/VideoFile.ts#L40) Defined in: [src/VideoFile.ts:40](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/VideoFile.ts#L40)
Defined in: [src/VideoFile.ts:40](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/VideoFile.ts#L40) Defined in: [src/VideoFile.ts:40](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/VideoFile.ts#L40)
___ ___
@ -64,6 +64,6 @@ Name | Type |
**Returns:** *void* **Returns:** *void*
Defined in: [src/VideoFile.ts:44](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/VideoFile.ts#L44) Defined in: [src/VideoFile.ts:44](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/VideoFile.ts#L44)
Defined in: [src/VideoFile.ts:44](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/VideoFile.ts#L44) Defined in: [src/VideoFile.ts:44](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/VideoFile.ts#L44)

16
docs/docs/api/interfaces/index.takephotooptions.md
View File

@ -20,7 +20,7 @@ Specifies whether the photo output should use content aware distortion correctio
**`default`** false **`default`** false
Defined in: [src/PhotoFile.ts:52](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/PhotoFile.ts#L52) Defined in: [src/PhotoFile.ts:52](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/PhotoFile.ts#L52)
___ ___
@ -32,7 +32,7 @@ Specifies whether red-eye reduction should be applied automatically on flash cap
**`default`** false **`default`** false
Defined in: [src/PhotoFile.ts:33](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/PhotoFile.ts#L33) Defined in: [src/PhotoFile.ts:33](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/PhotoFile.ts#L33)
___ ___
@ -44,7 +44,7 @@ Indicates whether still image stabilization will be employed when capturing the
**`default`** false **`default`** false
Defined in: [src/PhotoFile.ts:46](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/PhotoFile.ts#L46) Defined in: [src/PhotoFile.ts:46](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/PhotoFile.ts#L46)
___ ___
@ -57,7 +57,7 @@ to create a combined, higher quality image.
**`see`** [`isAutoVirtualDeviceFusionEnabled`](https://developer.apple.com/documentation/avfoundation/avcapturephotosettings/3192192-isautovirtualdevicefusionenabled) **`see`** [`isAutoVirtualDeviceFusionEnabled`](https://developer.apple.com/documentation/avfoundation/avcapturephotosettings/3192192-isautovirtualdevicefusionenabled)
Defined in: [src/PhotoFile.ts:40](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/PhotoFile.ts#L40) Defined in: [src/PhotoFile.ts:40](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/PhotoFile.ts#L40)
___ ___
@ -69,7 +69,7 @@ Whether the Flash should be enabled or disabled
**`default`** "auto" **`default`** "auto"
Defined in: [src/PhotoFile.ts:27](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/PhotoFile.ts#L27) Defined in: [src/PhotoFile.ts:27](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/PhotoFile.ts#L27)
___ ___
@ -81,7 +81,7 @@ Specify the photo codec to use. To get a list of available photo codecs use the
**`default`** undefined **`default`** undefined
Defined in: [src/PhotoFile.ts:10](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/PhotoFile.ts#L10) Defined in: [src/PhotoFile.ts:10](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/PhotoFile.ts#L10)
___ ___
@ -99,7 +99,7 @@ Indicates how photo quality should be prioritized against speed.
**`default`** "balanced" **`default`** "balanced"
Defined in: [src/PhotoFile.ts:21](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/PhotoFile.ts#L21) Defined in: [src/PhotoFile.ts:21](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/PhotoFile.ts#L21)
___ ___
@ -115,4 +115,4 @@ This might result in a faster capture, as metadata reading and mapping requires
**`platform`** Android **`platform`** Android
Defined in: [src/PhotoFile.ts:62](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/PhotoFile.ts#L62) Defined in: [src/PhotoFile.ts:62](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/PhotoFile.ts#L62)

4
docs/docs/api/interfaces/index.takesnapshotoptions.md
View File

@ -22,7 +22,7 @@ It is recommended to set this to `90` or even `80`, since the user probably won'
**`default`** 100 **`default`** 100
Defined in: [src/Snapshot.ts:9](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/Snapshot.ts#L9) Defined in: [src/Snapshot.ts:9](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/Snapshot.ts#L9)
___ ___
@ -38,4 +38,4 @@ This might result in a faster capture, as metadata reading and mapping requires
**`platform`** Android **`platform`** Android
Defined in: [src/Snapshot.ts:20](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/Snapshot.ts#L20) Defined in: [src/Snapshot.ts:20](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/Snapshot.ts#L20)

16
docs/docs/api/interfaces/photofile.takephotooptions.md
View File

@ -20,7 +20,7 @@ Specifies whether the photo output should use content aware distortion correctio
**`default`** false **`default`** false
Defined in: [src/PhotoFile.ts:52](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/PhotoFile.ts#L52) Defined in: [src/PhotoFile.ts:52](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/PhotoFile.ts#L52)
___ ___
@ -32,7 +32,7 @@ Specifies whether red-eye reduction should be applied automatically on flash cap
**`default`** false **`default`** false
Defined in: [src/PhotoFile.ts:33](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/PhotoFile.ts#L33) Defined in: [src/PhotoFile.ts:33](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/PhotoFile.ts#L33)
___ ___
@ -44,7 +44,7 @@ Indicates whether still image stabilization will be employed when capturing the
**`default`** false **`default`** false
Defined in: [src/PhotoFile.ts:46](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/PhotoFile.ts#L46) Defined in: [src/PhotoFile.ts:46](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/PhotoFile.ts#L46)
___ ___
@ -57,7 +57,7 @@ to create a combined, higher quality image.
**`see`** [`isAutoVirtualDeviceFusionEnabled`](https://developer.apple.com/documentation/avfoundation/avcapturephotosettings/3192192-isautovirtualdevicefusionenabled) **`see`** [`isAutoVirtualDeviceFusionEnabled`](https://developer.apple.com/documentation/avfoundation/avcapturephotosettings/3192192-isautovirtualdevicefusionenabled)
Defined in: [src/PhotoFile.ts:40](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/PhotoFile.ts#L40) Defined in: [src/PhotoFile.ts:40](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/PhotoFile.ts#L40)
___ ___
@ -69,7 +69,7 @@ Whether the Flash should be enabled or disabled
**`default`** "auto" **`default`** "auto"
Defined in: [src/PhotoFile.ts:27](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/PhotoFile.ts#L27) Defined in: [src/PhotoFile.ts:27](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/PhotoFile.ts#L27)
___ ___
@ -81,7 +81,7 @@ Specify the photo codec to use. To get a list of available photo codecs use the
**`default`** undefined **`default`** undefined
Defined in: [src/PhotoFile.ts:10](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/PhotoFile.ts#L10) Defined in: [src/PhotoFile.ts:10](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/PhotoFile.ts#L10)
___ ___
@ -99,7 +99,7 @@ Indicates how photo quality should be prioritized against speed.
**`default`** "balanced" **`default`** "balanced"
Defined in: [src/PhotoFile.ts:21](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/PhotoFile.ts#L21) Defined in: [src/PhotoFile.ts:21](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/PhotoFile.ts#L21)
___ ___
@ -115,4 +115,4 @@ This might result in a faster capture, as metadata reading and mapping requires
**`platform`** Android **`platform`** Android
Defined in: [src/PhotoFile.ts:62](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/PhotoFile.ts#L62) Defined in: [src/PhotoFile.ts:62](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/PhotoFile.ts#L62)

4
docs/docs/api/interfaces/point.point-1.md
View File

@ -20,7 +20,7 @@ Represents a Point in a 2 dimensional coordinate system.
The X coordinate of this Point. (double) The X coordinate of this Point. (double)
Defined in: [src/Point.ts:8](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/Point.ts#L8) Defined in: [src/Point.ts:8](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/Point.ts#L8)
___ ___
@ -30,4 +30,4 @@ ___
The Y coordinate of this Point. (double) The Y coordinate of this Point. (double)
Defined in: [src/Point.ts:12](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/Point.ts#L12) Defined in: [src/Point.ts:12](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/Point.ts#L12)

4
docs/docs/api/interfaces/snapshot.takesnapshotoptions.md
View File

@ -22,7 +22,7 @@ It is recommended to set this to `90` or even `80`, since the user probably won'
**`default`** 100 **`default`** 100
Defined in: [src/Snapshot.ts:9](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/Snapshot.ts#L9) Defined in: [src/Snapshot.ts:9](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/Snapshot.ts#L9)
___ ___
@ -38,4 +38,4 @@ This might result in a faster capture, as metadata reading and mapping requires
**`platform`** Android **`platform`** Android
Defined in: [src/Snapshot.ts:20](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/Snapshot.ts#L20) Defined in: [src/Snapshot.ts:20](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/Snapshot.ts#L20)

10
docs/docs/api/interfaces/videofile.recordvideooptions.md
View File

@ -18,7 +18,7 @@ hide_title: true
Set the video flash mode. Natively, this just enables the torch while recording. Set the video flash mode. Natively, this just enables the torch while recording.
Defined in: [src/VideoFile.ts:36](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/VideoFile.ts#L36) Defined in: [src/VideoFile.ts:36](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/VideoFile.ts#L36)
___ ___
@ -40,9 +40,9 @@ Name | Type |
**Returns:** *void* **Returns:** *void*
Defined in: [src/VideoFile.ts:40](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/VideoFile.ts#L40) Defined in: [src/VideoFile.ts:40](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/VideoFile.ts#L40)
Defined in: [src/VideoFile.ts:40](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/VideoFile.ts#L40) Defined in: [src/VideoFile.ts:40](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/VideoFile.ts#L40)
___ ___
@ -64,6 +64,6 @@ Name | Type |
**Returns:** *void* **Returns:** *void*
Defined in: [src/VideoFile.ts:44](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/VideoFile.ts#L44) Defined in: [src/VideoFile.ts:44](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/VideoFile.ts#L44)
Defined in: [src/VideoFile.ts:44](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/VideoFile.ts#L44) Defined in: [src/VideoFile.ts:44](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/VideoFile.ts#L44)

14
docs/docs/api/modules/camera.md
View File

@ -29,7 +29,7 @@ Name | Type | Description |
`enableHighResolutionCapture`? | *boolean* | Indicates whether the photo render pipeline should be configured to deliver high resolution still images **`default`** false | `enableHighResolutionCapture`? | *boolean* | Indicates whether the photo render pipeline should be configured to deliver high resolution still images **`default`** false |
`enablePortraitEffectsMatteDelivery`? | *boolean* | A boolean specifying whether the photo render pipeline is prepared for portrait effects matte delivery. When enabling this, you must also set `enableDepthData` to `true`. **`platform`** iOS 12.0+ **`default`** false | `enablePortraitEffectsMatteDelivery`? | *boolean* | A boolean specifying whether the photo render pipeline is prepared for portrait effects matte delivery. When enabling this, you must also set `enableDepthData` to `true`. **`platform`** iOS 12.0+ **`default`** false |
Defined in: [src/Camera.tsx:73](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/Camera.tsx#L73) Defined in: [src/Camera.tsx:73](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/Camera.tsx#L73)
___ ___
@ -46,7 +46,7 @@ Name | Type | Description |
`torch`? | *off* \| *on* | Set the current torch mode. Note: The torch is only available on `"back"` cameras, and isn't supported by every phone. **`default`** "off" | `torch`? | *off* \| *on* | Set the current torch mode. Note: The torch is only available on `"back"` cameras, and isn't supported by every phone. **`default`** "off" |
`zoom`? | *number* | Specifies the zoom factor of the current camera, in percent. (`0.0` - `1.0`) **`default`** 0.0 | `zoom`? | *number* | Specifies the zoom factor of the current camera, in percent. (`0.0` - `1.0`) **`default`** 0.0 |
Defined in: [src/Camera.tsx:102](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/Camera.tsx#L102) Defined in: [src/Camera.tsx:102](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/Camera.tsx#L102)
___ ___
@ -61,7 +61,7 @@ Name | Type | Description |
`onError`? | (`error`: [*CameraRuntimeError*](../classes/cameraerror.cameraruntimeerror.md)) => *void* | Called when any kind of runtime error occured. | `onError`? | (`error`: [*CameraRuntimeError*](../classes/cameraerror.cameraruntimeerror.md)) => *void* | Called when any kind of runtime error occured. |
`onInitialized`? | () => *void* | Called when the camera was successfully initialized. | `onInitialized`? | () => *void* | Called when the camera was successfully initialized. |
Defined in: [src/Camera.tsx:133](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/Camera.tsx#L133) Defined in: [src/Camera.tsx:133](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/Camera.tsx#L133)
___ ___
@ -69,7 +69,7 @@ ___
Ƭ **CameraPermissionRequestResult**: *authorized* \| *denied* Ƭ **CameraPermissionRequestResult**: *authorized* \| *denied*
Defined in: [src/Camera.tsx:152](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/Camera.tsx#L152) Defined in: [src/Camera.tsx:152](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/Camera.tsx#L152)
___ ___
@ -77,7 +77,7 @@ ___
Ƭ **CameraPermissionStatus**: *authorized* \| *not-determined* \| *denied* \| *restricted* Ƭ **CameraPermissionStatus**: *authorized* \| *not-determined* \| *denied* \| *restricted*
Defined in: [src/Camera.tsx:151](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/Camera.tsx#L151) Defined in: [src/Camera.tsx:151](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/Camera.tsx#L151)
___ ___
@ -85,7 +85,7 @@ ___
Ƭ **CameraProps**: CameraPresetProps \| CameraFormatProps & CameraScannerPropsNever \| [*CameraScannerProps*](camera.md#camerascannerprops) & [*CameraDeviceProps*](camera.md#cameradeviceprops) & [*CameraDynamicProps*](camera.md#cameradynamicprops) & [*CameraEventProps*](camera.md#cameraeventprops) & ViewProps Ƭ **CameraProps**: CameraPresetProps \| CameraFormatProps & CameraScannerPropsNever \| [*CameraScannerProps*](camera.md#camerascannerprops) & [*CameraDeviceProps*](camera.md#cameradeviceprops) & [*CameraDynamicProps*](camera.md#cameradynamicprops) & [*CameraEventProps*](camera.md#cameraeventprops) & ViewProps
Defined in: [src/Camera.tsx:144](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/Camera.tsx#L144) Defined in: [src/Camera.tsx:144](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/Camera.tsx#L144)
___ ___
@ -93,4 +93,4 @@ ___
Ƭ **CameraScannerProps**: *Modify*<CameraScannerPropsNever, { `onCodeScanned`: (`codes`: [*Code*](code.md#code)[]) => *void* ; `scannableCodes`: [*CodeType*](code.md#codetype)[] }\> Ƭ **CameraScannerProps**: *Modify*<CameraScannerPropsNever, { `onCodeScanned`: (`codes`: [*Code*](code.md#code)[]) => *void* ; `scannableCodes`: [*CodeType*](code.md#codetype)[] }\>
Defined in: [src/Camera.tsx:65](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/Camera.tsx#L65) Defined in: [src/Camera.tsx:65](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/Camera.tsx#L65)

4
docs/docs/api/modules/cameracodec.md
View File

@ -20,7 +20,7 @@ Available Photo Codec types used for taking a photo.
* `"jpeg"`: The JPEG (`jpeg`) video codec. _(iOS 11.0+)_ * `"jpeg"`: The JPEG (`jpeg`) video codec. _(iOS 11.0+)_
* `"hevc-alpha"`: The HEVC (`muxa`) video codec that supports an alpha channel. This constant is used to select the appropriate encoder, but is NOT used on the encoded content, which is backwards compatible and hence uses `"hvc1"` as its codec type. _(iOS 13.0+)_ * `"hevc-alpha"`: The HEVC (`muxa`) video codec that supports an alpha channel. This constant is used to select the appropriate encoder, but is NOT used on the encoded content, which is backwards compatible and hence uses `"hvc1"` as its codec type. _(iOS 13.0+)_
Defined in: [src/CameraCodec.ts:33](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/CameraCodec.ts#L33) Defined in: [src/CameraCodec.ts:33](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/CameraCodec.ts#L33)
___ ___
@ -40,4 +40,4 @@ Available Video Codec types used for recording a video.
* `"pro-res-422-proxy"`: The Apple ProRes 422 Proxy (`apco`) video codec. _(iOS 13.0+)_ * `"pro-res-422-proxy"`: The Apple ProRes 422 Proxy (`apco`) video codec. _(iOS 13.0+)_
* `"hevc-alpha"`: The HEVC (`muxa`) video codec that supports an alpha channel. This constant is used to select the appropriate encoder, but is NOT used on the encoded content, which is backwards compatible and hence uses `"hvc1"` as its codec type. _(iOS 13.0+)_ * `"hevc-alpha"`: The HEVC (`muxa`) video codec that supports an alpha channel. This constant is used to select the appropriate encoder, but is NOT used on the encoded content, which is backwards compatible and hence uses `"hvc1"` as its codec type. _(iOS 13.0+)_
Defined in: [src/CameraCodec.ts:14](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/CameraCodec.ts#L14) Defined in: [src/CameraCodec.ts:14](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/CameraCodec.ts#L14)

18
docs/docs/api/modules/cameradevice.md
View File

@ -20,7 +20,7 @@ Indicates a format's autofocus system.
* `"contrast-detection"`: Indicates that autofocus is achieved by contrast detection. Contrast detection performs a focus scan to find the optimal position * `"contrast-detection"`: Indicates that autofocus is achieved by contrast detection. Contrast detection performs a focus scan to find the optimal position
* `"phase-detection"`: Indicates that autofocus is achieved by phase detection. Phase detection has the ability to achieve focus in many cases without a focus scan. Phase detection autofocus is typically less visually intrusive than contrast detection autofocus * `"phase-detection"`: Indicates that autofocus is achieved by phase detection. Phase detection has the ability to achieve focus in many cases without a focus scan. Phase detection autofocus is typically less visually intrusive than contrast detection autofocus
Defined in: [src/CameraDevice.ts:64](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/CameraDevice.ts#L64) Defined in: [src/CameraDevice.ts:64](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/CameraDevice.ts#L64)
___ ___
@ -30,7 +30,7 @@ ___
Represents a camera device discovered by the `Camera.getAvailableCameraDevices()` function Represents a camera device discovered by the `Camera.getAvailableCameraDevices()` function
Defined in: [src/CameraDevice.ts:159](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/CameraDevice.ts#L159) Defined in: [src/CameraDevice.ts:159](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/CameraDevice.ts#L159)
___ ___
@ -40,7 +40,7 @@ ___
A Camera Device's video format. Do not create instances of this type yourself, only use `Camera.getAvailableCameraDevices(...)`. A Camera Device's video format. Do not create instances of this type yourself, only use `Camera.getAvailableCameraDevices(...)`.
Defined in: [src/CameraDevice.ts:85](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/CameraDevice.ts#L85) Defined in: [src/CameraDevice.ts:85](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/CameraDevice.ts#L85)
___ ___
@ -58,7 +58,7 @@ Indicates a format's color space.
#### The following colorspaces are available on Android: #### The following colorspaces are available on Android:
* `"yuv"`: The YCbCr color space. * `"yuv"`: The YCbCr color space.
Defined in: [src/CameraDevice.ts:55](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/CameraDevice.ts#L55) Defined in: [src/CameraDevice.ts:55](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/CameraDevice.ts#L55)
___ ___
@ -66,7 +66,7 @@ ___
Ƭ **FrameRateRange**: *Readonly*<{ `maxFrameRate`: *number* ; `minFrameRate`: *number* }\> Ƭ **FrameRateRange**: *Readonly*<{ `maxFrameRate`: *number* ; `minFrameRate`: *number* }\>
Defined in: [src/CameraDevice.ts:77](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/CameraDevice.ts#L77) Defined in: [src/CameraDevice.ts:77](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/CameraDevice.ts#L77)
___ ___
@ -81,7 +81,7 @@ Indentifiers for a logical camera (Combinations of multiple physical cameras to
* `"triple-camera"`: A device that consists of three cameras of fixed focal length, one ultrawide angle, one wide angle, and one telephoto. * `"triple-camera"`: A device that consists of three cameras of fixed focal length, one ultrawide angle, one wide angle, and one telephoto.
* `"true-depth-camera"`: A combination of cameras and other sensors that creates a capture device capable of photo, video, and depth capture. * `"true-depth-camera"`: A combination of cameras and other sensors that creates a capture device capable of photo, video, and depth capture.
Defined in: [src/CameraDevice.ts:20](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/CameraDevice.ts#L20) Defined in: [src/CameraDevice.ts:20](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/CameraDevice.ts#L20)
___ ___
@ -95,7 +95,7 @@ Indentifiers for a physical camera (one that actually exists on the back/front o
* `"wide-angle-camera"`: A built-in wide-angle camera. (focal length between 24mm and 35mm) * `"wide-angle-camera"`: A built-in wide-angle camera. (focal length between 24mm and 35mm)
* `"telephoto-camera"`: A built-in camera device with a longer focal length than a wide-angle camera. (focal length between above 85mm) * `"telephoto-camera"`: A built-in camera device with a longer focal length than a wide-angle camera. (focal length between above 85mm)
Defined in: [src/CameraDevice.ts:10](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/CameraDevice.ts#L10) Defined in: [src/CameraDevice.ts:10](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/CameraDevice.ts#L10)
___ ___
@ -111,7 +111,7 @@ Indicates a format's supported video stabilization mode
* `"cinematic-extended"`: Indicates that the video should be stabilized using the extended cinematic stabilization algorithm. Enabling extended cinematic stabilization introduces longer latency into the video capture pipeline compared to the AVCaptureVideoStabilizationModeCinematic and consumes more memory, but yields improved stability. It is recommended to use identical or similar min and max frame durations in conjunction with this mode (iOS 13.0+) * `"cinematic-extended"`: Indicates that the video should be stabilized using the extended cinematic stabilization algorithm. Enabling extended cinematic stabilization introduces longer latency into the video capture pipeline compared to the AVCaptureVideoStabilizationModeCinematic and consumes more memory, but yields improved stability. It is recommended to use identical or similar min and max frame durations in conjunction with this mode (iOS 13.0+)
* `"auto"`: Indicates that the most appropriate video stabilization mode for the device and format should be chosen automatically * `"auto"`: Indicates that the most appropriate video stabilization mode for the device and format should be chosen automatically
Defined in: [src/CameraDevice.ts:75](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/CameraDevice.ts#L75) Defined in: [src/CameraDevice.ts:75](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/CameraDevice.ts#L75)
## Functions ## Functions
@ -131,4 +131,4 @@ Name | Type |
**Returns:** *ultra-wide-angle-camera* \| *wide-angle-camera* \| *telephoto-camera* \| *dual-camera* \| *dual-wide-camera* \| *triple-camera* \| *true-depth-camera* **Returns:** *ultra-wide-angle-camera* \| *wide-angle-camera* \| *telephoto-camera* \| *dual-camera* \| *dual-wide-camera* \| *triple-camera* \| *true-depth-camera*
Defined in: [src/CameraDevice.ts:26](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/CameraDevice.ts#L26) Defined in: [src/CameraDevice.ts:26](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/CameraDevice.ts#L26)

20
docs/docs/api/modules/cameraerror.md
View File

@ -25,7 +25,7 @@ hide_title: true
Ƭ **CaptureError**: *capture/invalid-photo-format* \| *capture/encoder-error* \| *capture/muxer-error* \| *capture/recording-in-progress* \| *capture/no-recording-in-progress* \| *capture/file-io-error* \| *capture/create-temp-file-error* \| *capture/invalid-photo-codec* \| *capture/not-bound-error* \| *capture/capture-type-not-supported* \| *capture/unknown* Ƭ **CaptureError**: *capture/invalid-photo-format* \| *capture/encoder-error* \| *capture/muxer-error* \| *capture/recording-in-progress* \| *capture/no-recording-in-progress* \| *capture/file-io-error* \| *capture/create-temp-file-error* \| *capture/invalid-photo-codec* \| *capture/not-bound-error* \| *capture/capture-type-not-supported* \| *capture/unknown*
Defined in: [src/CameraError.ts:24](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/CameraError.ts#L24) Defined in: [src/CameraError.ts:24](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/CameraError.ts#L24)
___ ___
@ -33,7 +33,7 @@ ___
Ƭ **DeviceError**: *device/configuration-error* \| *device/no-device* \| *device/invalid-device* \| *device/torch-unavailable* \| *device/microphone-unavailable* \| *device/low-light-boost-not-supported* \| *device/focus-not-supported* \| *device/camera-not-available-on-simulator* Ƭ **DeviceError**: *device/configuration-error* \| *device/no-device* \| *device/invalid-device* \| *device/torch-unavailable* \| *device/microphone-unavailable* \| *device/low-light-boost-not-supported* \| *device/focus-not-supported* \| *device/camera-not-available-on-simulator*
Defined in: [src/CameraError.ts:8](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/CameraError.ts#L8) Defined in: [src/CameraError.ts:8](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/CameraError.ts#L8)
___ ___
@ -41,7 +41,7 @@ ___
Ƭ **FormatError**: *format/invalid-fps* \| *format/invalid-hdr* \| *format/invalid-low-light-boost* \| *format/invalid-format* \| *format/invalid-preset* Ƭ **FormatError**: *format/invalid-fps* \| *format/invalid-hdr* \| *format/invalid-low-light-boost* \| *format/invalid-format* \| *format/invalid-preset*
Defined in: [src/CameraError.ts:17](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/CameraError.ts#L17) Defined in: [src/CameraError.ts:17](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/CameraError.ts#L17)
___ ___
@ -49,7 +49,7 @@ ___
Ƭ **ParameterError**: *parameter/invalid-parameter* \| *parameter/unsupported-os* \| *parameter/unsupported-output* \| *parameter/unsupported-input* \| *parameter/invalid-combination* Ƭ **ParameterError**: *parameter/invalid-parameter* \| *parameter/unsupported-os* \| *parameter/unsupported-output* \| *parameter/unsupported-input* \| *parameter/invalid-combination*
Defined in: [src/CameraError.ts:2](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/CameraError.ts#L2) Defined in: [src/CameraError.ts:2](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/CameraError.ts#L2)
___ ___
@ -57,7 +57,7 @@ ___
Ƭ **PermissionError**: *permission/microphone-permission-denied* \| *permission/camera-permission-denied* Ƭ **PermissionError**: *permission/microphone-permission-denied* \| *permission/camera-permission-denied*
Defined in: [src/CameraError.ts:1](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/CameraError.ts#L1) Defined in: [src/CameraError.ts:1](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/CameraError.ts#L1)
___ ___
@ -65,7 +65,7 @@ ___
Ƭ **SessionError**: *session/camera-not-ready* \| *session/audio-session-setup-failed* Ƭ **SessionError**: *session/camera-not-ready* \| *session/audio-session-setup-failed*
Defined in: [src/CameraError.ts:23](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/CameraError.ts#L23) Defined in: [src/CameraError.ts:23](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/CameraError.ts#L23)
___ ___
@ -73,7 +73,7 @@ ___
Ƭ **SystemError**: *system/no-camera-manager* Ƭ **SystemError**: *system/no-camera-manager*
Defined in: [src/CameraError.ts:36](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/CameraError.ts#L36) Defined in: [src/CameraError.ts:36](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/CameraError.ts#L36)
___ ___
@ -81,7 +81,7 @@ ___
Ƭ **UnknownError**: *unknown/unknown* Ƭ **UnknownError**: *unknown/unknown*
Defined in: [src/CameraError.ts:37](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/CameraError.ts#L37) Defined in: [src/CameraError.ts:37](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/CameraError.ts#L37)
## Functions ## Functions
@ -97,7 +97,7 @@ Name | Type |
**Returns:** error is ErrorWithCause **Returns:** error is ErrorWithCause
Defined in: [src/CameraError.ts:127](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/CameraError.ts#L127) Defined in: [src/CameraError.ts:127](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/CameraError.ts#L127)
___ ___
@ -125,4 +125,4 @@ Name | Type | Description |
A `CameraRuntimeError` or `CameraCaptureError`, or the nativeError if it's not parsable A `CameraRuntimeError` or `CameraCaptureError`, or the nativeError if it's not parsable
Defined in: [src/CameraError.ts:153](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/CameraError.ts#L153) Defined in: [src/CameraError.ts:153](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/CameraError.ts#L153)

2
docs/docs/api/modules/cameraposition.md
View File

@ -25,4 +25,4 @@ Represents the camera device position.
#### Android only #### Android only
* `"external"`: The camera device is an external camera, and has no fixed facing relative to the device's screen. (Android only) * `"external"`: The camera device is an external camera, and has no fixed facing relative to the device's screen. (Android only)
Defined in: [src/CameraPosition.ts:13](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/CameraPosition.ts#L13) Defined in: [src/CameraPosition.ts:13](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/CameraPosition.ts#L13)

2
docs/docs/api/modules/camerapreset.md
View File

@ -29,4 +29,4 @@ Indicates the quality level or bit rate of the output.
* `"photo"`: Specifies capture settings suitable for high-resolution photo quality output. * `"photo"`: Specifies capture settings suitable for high-resolution photo quality output.
* `"vga-640x480"`: Specifies capture settings suitable for VGA quality (640 x 480 pixel) video output. * `"vga-640x480"`: Specifies capture settings suitable for VGA quality (640 x 480 pixel) video output.
Defined in: [src/CameraPreset.ts:17](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/CameraPreset.ts#L17) Defined in: [src/CameraPreset.ts:17](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/CameraPreset.ts#L17)

4
docs/docs/api/modules/code.md
View File

@ -16,7 +16,7 @@ hide_title: true
Represents a File in the local filesystem. Represents a File in the local filesystem.
Defined in: [src/Code.ts:27](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/Code.ts#L27) Defined in: [src/Code.ts:27](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/Code.ts#L27)
___ ___
@ -26,4 +26,4 @@ ___
Available code types Available code types
Defined in: [src/Code.ts:4](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/Code.ts#L4) Defined in: [src/Code.ts:4](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/Code.ts#L4)

4
docs/docs/api/modules/hooks_usecameradevices.md
View File

@ -29,7 +29,7 @@ return <Camera device={device} />
The best matching `CameraDevice`. The best matching `CameraDevice`.
Defined in: [src/hooks/useCameraDevices.ts:29](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/hooks/useCameraDevices.ts#L29) Defined in: [src/hooks/useCameraDevices.ts:29](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/hooks/useCameraDevices.ts#L29)
▸ **useCameraDevices**(`deviceType`: [*PhysicalCameraDeviceType*](cameradevice.md#physicalcameradevicetype) \| [*LogicalCameraDeviceType*](cameradevice.md#logicalcameradevicetype)): CameraDevices ▸ **useCameraDevices**(`deviceType`: [*PhysicalCameraDeviceType*](cameradevice.md#physicalcameradevicetype) \| [*LogicalCameraDeviceType*](cameradevice.md#logicalcameradevicetype)): CameraDevices
@ -54,4 +54,4 @@ Name | Type | Description |
A `CameraDevice` for the requested device type. A `CameraDevice` for the requested device type.
Defined in: [src/hooks/useCameraDevices.ts:44](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/hooks/useCameraDevices.ts#L44) Defined in: [src/hooks/useCameraDevices.ts:44](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/hooks/useCameraDevices.ts#L44)

2
docs/docs/api/modules/hooks_usecameraformat.md
View File

@ -29,4 +29,4 @@ Name | Type | Description |
The best matching format for the given camera device, or `undefined` if the camera device is `undefined`. The best matching format for the given camera device, or `undefined` if the camera device is `undefined`.
Defined in: [src/hooks/useCameraFormat.ts:16](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/hooks/useCameraFormat.ts#L16) Defined in: [src/hooks/useCameraFormat.ts:16](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/hooks/useCameraFormat.ts#L16)

86
docs/docs/api/modules/index.md
View File

@ -36,7 +36,7 @@ Indicates a format's autofocus system.
* `"contrast-detection"`: Indicates that autofocus is achieved by contrast detection. Contrast detection performs a focus scan to find the optimal position * `"contrast-detection"`: Indicates that autofocus is achieved by contrast detection. Contrast detection performs a focus scan to find the optimal position
* `"phase-detection"`: Indicates that autofocus is achieved by phase detection. Phase detection has the ability to achieve focus in many cases without a focus scan. Phase detection autofocus is typically less visually intrusive than contrast detection autofocus * `"phase-detection"`: Indicates that autofocus is achieved by phase detection. Phase detection has the ability to achieve focus in many cases without a focus scan. Phase detection autofocus is typically less visually intrusive than contrast detection autofocus
Defined in: [src/CameraDevice.ts:64](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/CameraDevice.ts#L64) Defined in: [src/CameraDevice.ts:64](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/CameraDevice.ts#L64)
___ ___
@ -46,7 +46,7 @@ ___
Represents a camera device discovered by the `Camera.getAvailableCameraDevices()` function Represents a camera device discovered by the `Camera.getAvailableCameraDevices()` function
Defined in: [src/CameraDevice.ts:159](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/CameraDevice.ts#L159) Defined in: [src/CameraDevice.ts:159](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/CameraDevice.ts#L159)
___ ___
@ -56,7 +56,7 @@ ___
A Camera Device's video format. Do not create instances of this type yourself, only use `Camera.getAvailableCameraDevices(...)`. A Camera Device's video format. Do not create instances of this type yourself, only use `Camera.getAvailableCameraDevices(...)`.
Defined in: [src/CameraDevice.ts:85](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/CameraDevice.ts#L85) Defined in: [src/CameraDevice.ts:85](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/CameraDevice.ts#L85)
___ ___
@ -73,7 +73,7 @@ Name | Type | Description |
`enableHighResolutionCapture`? | *boolean* | Indicates whether the photo render pipeline should be configured to deliver high resolution still images **`default`** false | `enableHighResolutionCapture`? | *boolean* | Indicates whether the photo render pipeline should be configured to deliver high resolution still images **`default`** false |
`enablePortraitEffectsMatteDelivery`? | *boolean* | A boolean specifying whether the photo render pipeline is prepared for portrait effects matte delivery. When enabling this, you must also set `enableDepthData` to `true`. **`platform`** iOS 12.0+ **`default`** false | `enablePortraitEffectsMatteDelivery`? | *boolean* | A boolean specifying whether the photo render pipeline is prepared for portrait effects matte delivery. When enabling this, you must also set `enableDepthData` to `true`. **`platform`** iOS 12.0+ **`default`** false |
Defined in: [src/Camera.tsx:73](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/Camera.tsx#L73) Defined in: [src/Camera.tsx:73](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/Camera.tsx#L73)
___ ___
@ -90,7 +90,7 @@ Name | Type | Description |
`torch`? | *off* \| *on* | Set the current torch mode. Note: The torch is only available on `"back"` cameras, and isn't supported by every phone. **`default`** "off" | `torch`? | *off* \| *on* | Set the current torch mode. Note: The torch is only available on `"back"` cameras, and isn't supported by every phone. **`default`** "off" |
`zoom`? | *number* | Specifies the zoom factor of the current camera, in percent. (`0.0` - `1.0`) **`default`** 0.0 | `zoom`? | *number* | Specifies the zoom factor of the current camera, in percent. (`0.0` - `1.0`) **`default`** 0.0 |
Defined in: [src/Camera.tsx:102](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/Camera.tsx#L102) Defined in: [src/Camera.tsx:102](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/Camera.tsx#L102)
___ ___
@ -105,7 +105,7 @@ Name | Type | Description |
`onError`? | (`error`: [*CameraRuntimeError*](../classes/cameraerror.cameraruntimeerror.md)) => *void* | Called when any kind of runtime error occured. | `onError`? | (`error`: [*CameraRuntimeError*](../classes/cameraerror.cameraruntimeerror.md)) => *void* | Called when any kind of runtime error occured. |
`onInitialized`? | () => *void* | Called when the camera was successfully initialized. | `onInitialized`? | () => *void* | Called when the camera was successfully initialized. |
Defined in: [src/Camera.tsx:133](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/Camera.tsx#L133) Defined in: [src/Camera.tsx:133](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/Camera.tsx#L133)
___ ___
@ -113,7 +113,7 @@ ___
Ƭ **CameraPermissionRequestResult**: *authorized* \| *denied* Ƭ **CameraPermissionRequestResult**: *authorized* \| *denied*
Defined in: [src/Camera.tsx:152](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/Camera.tsx#L152) Defined in: [src/Camera.tsx:152](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/Camera.tsx#L152)
___ ___
@ -121,7 +121,7 @@ ___
Ƭ **CameraPermissionStatus**: *authorized* \| *not-determined* \| *denied* \| *restricted* Ƭ **CameraPermissionStatus**: *authorized* \| *not-determined* \| *denied* \| *restricted*
Defined in: [src/Camera.tsx:151](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/Camera.tsx#L151) Defined in: [src/Camera.tsx:151](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/Camera.tsx#L151)
___ ___
@ -135,7 +135,7 @@ Available Photo Codec types used for taking a photo.
* `"jpeg"`: The JPEG (`jpeg`) video codec. _(iOS 11.0+)_ * `"jpeg"`: The JPEG (`jpeg`) video codec. _(iOS 11.0+)_
* `"hevc-alpha"`: The HEVC (`muxa`) video codec that supports an alpha channel. This constant is used to select the appropriate encoder, but is NOT used on the encoded content, which is backwards compatible and hence uses `"hvc1"` as its codec type. _(iOS 13.0+)_ * `"hevc-alpha"`: The HEVC (`muxa`) video codec that supports an alpha channel. This constant is used to select the appropriate encoder, but is NOT used on the encoded content, which is backwards compatible and hence uses `"hvc1"` as its codec type. _(iOS 13.0+)_
Defined in: [src/CameraCodec.ts:33](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/CameraCodec.ts#L33) Defined in: [src/CameraCodec.ts:33](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/CameraCodec.ts#L33)
___ ___
@ -154,7 +154,7 @@ Represents the camera device position.
#### Android only #### Android only
* `"external"`: The camera device is an external camera, and has no fixed facing relative to the device's screen. (Android only) * `"external"`: The camera device is an external camera, and has no fixed facing relative to the device's screen. (Android only)
Defined in: [src/CameraPosition.ts:13](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/CameraPosition.ts#L13) Defined in: [src/CameraPosition.ts:13](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/CameraPosition.ts#L13)
___ ___
@ -177,7 +177,7 @@ Indicates the quality level or bit rate of the output.
* `"photo"`: Specifies capture settings suitable for high-resolution photo quality output. * `"photo"`: Specifies capture settings suitable for high-resolution photo quality output.
* `"vga-640x480"`: Specifies capture settings suitable for VGA quality (640 x 480 pixel) video output. * `"vga-640x480"`: Specifies capture settings suitable for VGA quality (640 x 480 pixel) video output.
Defined in: [src/CameraPreset.ts:17](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/CameraPreset.ts#L17) Defined in: [src/CameraPreset.ts:17](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/CameraPreset.ts#L17)
___ ___
@ -185,7 +185,7 @@ ___
Ƭ **CameraProps**: CameraPresetProps \| CameraFormatProps & CameraScannerPropsNever \| [*CameraScannerProps*](camera.md#camerascannerprops) & [*CameraDeviceProps*](camera.md#cameradeviceprops) & [*CameraDynamicProps*](camera.md#cameradynamicprops) & [*CameraEventProps*](camera.md#cameraeventprops) & ViewProps Ƭ **CameraProps**: CameraPresetProps \| CameraFormatProps & CameraScannerPropsNever \| [*CameraScannerProps*](camera.md#camerascannerprops) & [*CameraDeviceProps*](camera.md#cameradeviceprops) & [*CameraDynamicProps*](camera.md#cameradynamicprops) & [*CameraEventProps*](camera.md#cameraeventprops) & ViewProps
Defined in: [src/Camera.tsx:144](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/Camera.tsx#L144) Defined in: [src/Camera.tsx:144](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/Camera.tsx#L144)
___ ___
@ -193,7 +193,7 @@ ___
Ƭ **CameraScannerProps**: *Modify*<CameraScannerPropsNever, { `onCodeScanned`: (`codes`: [*Code*](code.md#code)[]) => *void* ; `scannableCodes`: [*CodeType*](code.md#codetype)[] }\> Ƭ **CameraScannerProps**: *Modify*<CameraScannerPropsNever, { `onCodeScanned`: (`codes`: [*Code*](code.md#code)[]) => *void* ; `scannableCodes`: [*CodeType*](code.md#codetype)[] }\>
Defined in: [src/Camera.tsx:65](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/Camera.tsx#L65) Defined in: [src/Camera.tsx:65](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/Camera.tsx#L65)
___ ___
@ -213,7 +213,7 @@ Available Video Codec types used for recording a video.
* `"pro-res-422-proxy"`: The Apple ProRes 422 Proxy (`apco`) video codec. _(iOS 13.0+)_ * `"pro-res-422-proxy"`: The Apple ProRes 422 Proxy (`apco`) video codec. _(iOS 13.0+)_
* `"hevc-alpha"`: The HEVC (`muxa`) video codec that supports an alpha channel. This constant is used to select the appropriate encoder, but is NOT used on the encoded content, which is backwards compatible and hence uses `"hvc1"` as its codec type. _(iOS 13.0+)_ * `"hevc-alpha"`: The HEVC (`muxa`) video codec that supports an alpha channel. This constant is used to select the appropriate encoder, but is NOT used on the encoded content, which is backwards compatible and hence uses `"hvc1"` as its codec type. _(iOS 13.0+)_
Defined in: [src/CameraCodec.ts:14](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/CameraCodec.ts#L14) Defined in: [src/CameraCodec.ts:14](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/CameraCodec.ts#L14)
___ ___
@ -221,7 +221,7 @@ ___
Ƭ **CaptureError**: *capture/invalid-photo-format* \| *capture/encoder-error* \| *capture/muxer-error* \| *capture/recording-in-progress* \| *capture/no-recording-in-progress* \| *capture/file-io-error* \| *capture/create-temp-file-error* \| *capture/invalid-photo-codec* \| *capture/not-bound-error* \| *capture/capture-type-not-supported* \| *capture/unknown* Ƭ **CaptureError**: *capture/invalid-photo-format* \| *capture/encoder-error* \| *capture/muxer-error* \| *capture/recording-in-progress* \| *capture/no-recording-in-progress* \| *capture/file-io-error* \| *capture/create-temp-file-error* \| *capture/invalid-photo-codec* \| *capture/not-bound-error* \| *capture/capture-type-not-supported* \| *capture/unknown*
Defined in: [src/CameraError.ts:24](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/CameraError.ts#L24) Defined in: [src/CameraError.ts:24](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/CameraError.ts#L24)
___ ___
@ -231,7 +231,7 @@ ___
Represents a File in the local filesystem. Represents a File in the local filesystem.
Defined in: [src/Code.ts:27](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/Code.ts#L27) Defined in: [src/Code.ts:27](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/Code.ts#L27)
___ ___
@ -241,7 +241,7 @@ ___
Available code types Available code types
Defined in: [src/Code.ts:4](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/Code.ts#L4) Defined in: [src/Code.ts:4](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/Code.ts#L4)
___ ___
@ -259,7 +259,7 @@ Indicates a format's color space.
#### The following colorspaces are available on Android: #### The following colorspaces are available on Android:
* `"yuv"`: The YCbCr color space. * `"yuv"`: The YCbCr color space.
Defined in: [src/CameraDevice.ts:55](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/CameraDevice.ts#L55) Defined in: [src/CameraDevice.ts:55](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/CameraDevice.ts#L55)
___ ___
@ -267,7 +267,7 @@ ___
Ƭ **DeviceError**: *device/configuration-error* \| *device/no-device* \| *device/invalid-device* \| *device/torch-unavailable* \| *device/microphone-unavailable* \| *device/low-light-boost-not-supported* \| *device/focus-not-supported* \| *device/camera-not-available-on-simulator* Ƭ **DeviceError**: *device/configuration-error* \| *device/no-device* \| *device/invalid-device* \| *device/torch-unavailable* \| *device/microphone-unavailable* \| *device/low-light-boost-not-supported* \| *device/focus-not-supported* \| *device/camera-not-available-on-simulator*
Defined in: [src/CameraError.ts:8](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/CameraError.ts#L8) Defined in: [src/CameraError.ts:8](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/CameraError.ts#L8)
___ ___
@ -275,7 +275,7 @@ ___
Ƭ **FormatError**: *format/invalid-fps* \| *format/invalid-hdr* \| *format/invalid-low-light-boost* \| *format/invalid-format* \| *format/invalid-preset* Ƭ **FormatError**: *format/invalid-fps* \| *format/invalid-hdr* \| *format/invalid-low-light-boost* \| *format/invalid-format* \| *format/invalid-preset*
Defined in: [src/CameraError.ts:17](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/CameraError.ts#L17) Defined in: [src/CameraError.ts:17](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/CameraError.ts#L17)
___ ___
@ -283,7 +283,7 @@ ___
Ƭ **FrameRateRange**: *Readonly*<{ `maxFrameRate`: *number* ; `minFrameRate`: *number* }\> Ƭ **FrameRateRange**: *Readonly*<{ `maxFrameRate`: *number* ; `minFrameRate`: *number* }\>
Defined in: [src/CameraDevice.ts:77](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/CameraDevice.ts#L77) Defined in: [src/CameraDevice.ts:77](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/CameraDevice.ts#L77)
___ ___
@ -298,7 +298,7 @@ Indentifiers for a logical camera (Combinations of multiple physical cameras to
* `"triple-camera"`: A device that consists of three cameras of fixed focal length, one ultrawide angle, one wide angle, and one telephoto. * `"triple-camera"`: A device that consists of three cameras of fixed focal length, one ultrawide angle, one wide angle, and one telephoto.
* `"true-depth-camera"`: A combination of cameras and other sensors that creates a capture device capable of photo, video, and depth capture. * `"true-depth-camera"`: A combination of cameras and other sensors that creates a capture device capable of photo, video, and depth capture.
Defined in: [src/CameraDevice.ts:20](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/CameraDevice.ts#L20) Defined in: [src/CameraDevice.ts:20](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/CameraDevice.ts#L20)
___ ___
@ -306,7 +306,7 @@ ___
Ƭ **ParameterError**: *parameter/invalid-parameter* \| *parameter/unsupported-os* \| *parameter/unsupported-output* \| *parameter/unsupported-input* \| *parameter/invalid-combination* Ƭ **ParameterError**: *parameter/invalid-parameter* \| *parameter/unsupported-os* \| *parameter/unsupported-output* \| *parameter/unsupported-input* \| *parameter/invalid-combination*
Defined in: [src/CameraError.ts:2](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/CameraError.ts#L2) Defined in: [src/CameraError.ts:2](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/CameraError.ts#L2)
___ ___
@ -314,7 +314,7 @@ ___
Ƭ **PermissionError**: *permission/microphone-permission-denied* \| *permission/camera-permission-denied* Ƭ **PermissionError**: *permission/microphone-permission-denied* \| *permission/camera-permission-denied*
Defined in: [src/CameraError.ts:1](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/CameraError.ts#L1) Defined in: [src/CameraError.ts:1](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/CameraError.ts#L1)
___ ___
@ -324,7 +324,7 @@ ___
Represents a Photo taken by the Camera written to the local filesystem. Represents a Photo taken by the Camera written to the local filesystem.
Defined in: [src/PhotoFile.ts:68](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/PhotoFile.ts#L68) Defined in: [src/PhotoFile.ts:68](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/PhotoFile.ts#L68)
___ ___
@ -338,7 +338,7 @@ Indentifiers for a physical camera (one that actually exists on the back/front o
* `"wide-angle-camera"`: A built-in wide-angle camera. (focal length between 24mm and 35mm) * `"wide-angle-camera"`: A built-in wide-angle camera. (focal length between 24mm and 35mm)
* `"telephoto-camera"`: A built-in camera device with a longer focal length than a wide-angle camera. (focal length between above 85mm) * `"telephoto-camera"`: A built-in camera device with a longer focal length than a wide-angle camera. (focal length between above 85mm)
Defined in: [src/CameraDevice.ts:10](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/CameraDevice.ts#L10) Defined in: [src/CameraDevice.ts:10](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/CameraDevice.ts#L10)
___ ___
@ -346,7 +346,7 @@ ___
Ƭ **SessionError**: *session/camera-not-ready* \| *session/audio-session-setup-failed* Ƭ **SessionError**: *session/camera-not-ready* \| *session/audio-session-setup-failed*
Defined in: [src/CameraError.ts:23](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/CameraError.ts#L23) Defined in: [src/CameraError.ts:23](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/CameraError.ts#L23)
___ ___
@ -363,7 +363,7 @@ Name | Type | Description |
`height` | *number* | Points in height. | `height` | *number* | Points in height. |
`width` | *number* | Points in width. | `width` | *number* | Points in width. |
Defined in: [src/utils/FormatFilter.ts:36](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/utils/FormatFilter.ts#L36) Defined in: [src/utils/FormatFilter.ts:36](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/utils/FormatFilter.ts#L36)
___ ___
@ -371,7 +371,7 @@ ___
Ƭ **SystemError**: *system/no-camera-manager* Ƭ **SystemError**: *system/no-camera-manager*
Defined in: [src/CameraError.ts:36](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/CameraError.ts#L36) Defined in: [src/CameraError.ts:36](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/CameraError.ts#L36)
___ ___
@ -381,7 +381,7 @@ ___
Represents a temporary file in the local filesystem. Represents a temporary file in the local filesystem.
Defined in: [src/TemporaryFile.ts:4](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/TemporaryFile.ts#L4) Defined in: [src/TemporaryFile.ts:4](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/TemporaryFile.ts#L4)
___ ___
@ -389,7 +389,7 @@ ___
Ƭ **UnknownError**: *unknown/unknown* Ƭ **UnknownError**: *unknown/unknown*
Defined in: [src/CameraError.ts:37](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/CameraError.ts#L37) Defined in: [src/CameraError.ts:37](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/CameraError.ts#L37)
___ ___
@ -399,7 +399,7 @@ ___
Represents a Video taken by the Camera written to the local filesystem. Represents a Video taken by the Camera written to the local filesystem.
Defined in: [src/VideoFile.ts:50](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/VideoFile.ts#L50) Defined in: [src/VideoFile.ts:50](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/VideoFile.ts#L50)
___ ___
@ -415,7 +415,7 @@ Indicates a format's supported video stabilization mode
* `"cinematic-extended"`: Indicates that the video should be stabilized using the extended cinematic stabilization algorithm. Enabling extended cinematic stabilization introduces longer latency into the video capture pipeline compared to the AVCaptureVideoStabilizationModeCinematic and consumes more memory, but yields improved stability. It is recommended to use identical or similar min and max frame durations in conjunction with this mode (iOS 13.0+) * `"cinematic-extended"`: Indicates that the video should be stabilized using the extended cinematic stabilization algorithm. Enabling extended cinematic stabilization introduces longer latency into the video capture pipeline compared to the AVCaptureVideoStabilizationModeCinematic and consumes more memory, but yields improved stability. It is recommended to use identical or similar min and max frame durations in conjunction with this mode (iOS 13.0+)
* `"auto"`: Indicates that the most appropriate video stabilization mode for the device and format should be chosen automatically * `"auto"`: Indicates that the most appropriate video stabilization mode for the device and format should be chosen automatically
Defined in: [src/CameraDevice.ts:75](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/CameraDevice.ts#L75) Defined in: [src/CameraDevice.ts:75](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/CameraDevice.ts#L75)
## Functions ## Functions
@ -443,7 +443,7 @@ Name | Type | Description |
A list of Camera Device Formats that match the given `viewSize`' aspect ratio _as close as possible_. A list of Camera Device Formats that match the given `viewSize`' aspect ratio _as close as possible_.
Defined in: [src/utils/FormatFilter.ts:92](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/utils/FormatFilter.ts#L92) Defined in: [src/utils/FormatFilter.ts:92](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/utils/FormatFilter.ts#L92)
___ ___
@ -470,7 +470,7 @@ Name | Type | Description |
**Returns:** *boolean* **Returns:** *boolean*
Defined in: [src/utils/FormatFilter.ts:137](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/utils/FormatFilter.ts#L137) Defined in: [src/utils/FormatFilter.ts:137](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/utils/FormatFilter.ts#L137)
___ ___
@ -486,7 +486,7 @@ Name | Type |
**Returns:** error is ErrorWithCause **Returns:** error is ErrorWithCause
Defined in: [src/CameraError.ts:127](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/CameraError.ts#L127) Defined in: [src/CameraError.ts:127](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/CameraError.ts#L127)
___ ___
@ -506,7 +506,7 @@ Name | Type |
**Returns:** *ultra-wide-angle-camera* \| *wide-angle-camera* \| *telephoto-camera* \| *dual-camera* \| *dual-wide-camera* \| *triple-camera* \| *true-depth-camera* **Returns:** *ultra-wide-angle-camera* \| *wide-angle-camera* \| *telephoto-camera* \| *dual-camera* \| *dual-wide-camera* \| *triple-camera* \| *true-depth-camera*
Defined in: [src/CameraDevice.ts:26](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/CameraDevice.ts#L26) Defined in: [src/CameraDevice.ts:26](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/CameraDevice.ts#L26)
___ ___
@ -537,7 +537,7 @@ Name | Type |
**Returns:** *number* **Returns:** *number*
Defined in: [src/utils/FormatFilter.ts:18](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/utils/FormatFilter.ts#L18) Defined in: [src/utils/FormatFilter.ts:18](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/utils/FormatFilter.ts#L18)
___ ___
@ -564,7 +564,7 @@ Name | Type |
**Returns:** *number* **Returns:** *number*
Defined in: [src/utils/FormatFilter.ts:112](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/utils/FormatFilter.ts#L112) Defined in: [src/utils/FormatFilter.ts:112](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/utils/FormatFilter.ts#L112)
___ ___
@ -592,7 +592,7 @@ Name | Type | Description |
A `CameraRuntimeError` or `CameraCaptureError`, or the nativeError if it's not parsable A `CameraRuntimeError` or `CameraCaptureError`, or the nativeError if it's not parsable
Defined in: [src/CameraError.ts:153](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/CameraError.ts#L153) Defined in: [src/CameraError.ts:153](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/CameraError.ts#L153)
___ ___
@ -615,7 +615,7 @@ return <Camera device={device} />
The best matching `CameraDevice`. The best matching `CameraDevice`.
Defined in: [src/hooks/useCameraDevices.ts:29](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/hooks/useCameraDevices.ts#L29) Defined in: [src/hooks/useCameraDevices.ts:29](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/hooks/useCameraDevices.ts#L29)
▸ **useCameraDevices**(`deviceType`: [*PhysicalCameraDeviceType*](cameradevice.md#physicalcameradevicetype) \| [*LogicalCameraDeviceType*](cameradevice.md#logicalcameradevicetype)): CameraDevices ▸ **useCameraDevices**(`deviceType`: [*PhysicalCameraDeviceType*](cameradevice.md#physicalcameradevicetype) \| [*LogicalCameraDeviceType*](cameradevice.md#logicalcameradevicetype)): CameraDevices
@ -640,7 +640,7 @@ Name | Type | Description |
A `CameraDevice` for the requested device type. A `CameraDevice` for the requested device type.
Defined in: [src/hooks/useCameraDevices.ts:44](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/hooks/useCameraDevices.ts#L44) Defined in: [src/hooks/useCameraDevices.ts:44](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/hooks/useCameraDevices.ts#L44)
___ ___
@ -663,4 +663,4 @@ Name | Type | Description |
The best matching format for the given camera device, or `undefined` if the camera device is `undefined`. The best matching format for the given camera device, or `undefined` if the camera device is `undefined`.
Defined in: [src/hooks/useCameraFormat.ts:16](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/hooks/useCameraFormat.ts#L16) Defined in: [src/hooks/useCameraFormat.ts:16](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/hooks/useCameraFormat.ts#L16)

2
docs/docs/api/modules/photofile.md
View File

@ -22,4 +22,4 @@ hide_title: true
Represents a Photo taken by the Camera written to the local filesystem. Represents a Photo taken by the Camera written to the local filesystem.
Defined in: [src/PhotoFile.ts:68](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/PhotoFile.ts#L68) Defined in: [src/PhotoFile.ts:68](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/PhotoFile.ts#L68)

2
docs/docs/api/modules/temporaryfile.md
View File

@ -16,4 +16,4 @@ hide_title: true
Represents a temporary file in the local filesystem. Represents a temporary file in the local filesystem.
Defined in: [src/TemporaryFile.ts:4](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/TemporaryFile.ts#L4) Defined in: [src/TemporaryFile.ts:4](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/TemporaryFile.ts#L4)

10
docs/docs/api/modules/utils_formatfilter.md
View File

@ -23,7 +23,7 @@ Name | Type | Description |
`height` | *number* | Points in height. | `height` | *number* | Points in height. |
`width` | *number* | Points in width. | `width` | *number* | Points in width. |
Defined in: [src/utils/FormatFilter.ts:36](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/utils/FormatFilter.ts#L36) Defined in: [src/utils/FormatFilter.ts:36](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/utils/FormatFilter.ts#L36)
## Functions ## Functions
@ -51,7 +51,7 @@ Name | Type | Description |
A list of Camera Device Formats that match the given `viewSize`' aspect ratio _as close as possible_. A list of Camera Device Formats that match the given `viewSize`' aspect ratio _as close as possible_.
Defined in: [src/utils/FormatFilter.ts:92](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/utils/FormatFilter.ts#L92) Defined in: [src/utils/FormatFilter.ts:92](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/utils/FormatFilter.ts#L92)
___ ___
@ -78,7 +78,7 @@ Name | Type | Description |
**Returns:** *boolean* **Returns:** *boolean*
Defined in: [src/utils/FormatFilter.ts:137](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/utils/FormatFilter.ts#L137) Defined in: [src/utils/FormatFilter.ts:137](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/utils/FormatFilter.ts#L137)
___ ___
@ -109,7 +109,7 @@ Name | Type |
**Returns:** *number* **Returns:** *number*
Defined in: [src/utils/FormatFilter.ts:18](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/utils/FormatFilter.ts#L18) Defined in: [src/utils/FormatFilter.ts:18](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/utils/FormatFilter.ts#L18)
___ ___
@ -136,4 +136,4 @@ Name | Type |
**Returns:** *number* **Returns:** *number*
Defined in: [src/utils/FormatFilter.ts:112](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/utils/FormatFilter.ts#L112) Defined in: [src/utils/FormatFilter.ts:112](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/utils/FormatFilter.ts#L112)

2
docs/docs/api/modules/videofile.md
View File

@ -22,4 +22,4 @@ hide_title: true
Represents a Video taken by the Camera written to the local filesystem. Represents a Video taken by the Camera written to the local filesystem.
Defined in: [src/VideoFile.ts:50](https://github.com/cuvent/react-native-vision-camera/blob/daa3c48/src/VideoFile.ts#L50) Defined in: [src/VideoFile.ts:50](https://github.com/cuvent/react-native-vision-camera/blob/919aa3d/src/VideoFile.ts#L50)

2
docs/package.json
View File

@ -35,6 +35,6 @@
"docusaurus-plugin-typedoc": "^0.10.0", "docusaurus-plugin-typedoc": "^0.10.0",
"typedoc": "^0.20.28", "typedoc": "^0.20.28",
"typedoc-plugin-markdown": "^3.6.0", "typedoc-plugin-markdown": "^3.6.0",
"typescript": "^4.2.2" "typescript": "^4.1.5"
} }
} }

8
docs/yarn.lock
View File

@ -9760,10 +9760,10 @@ typedoc@^0.20.28:
shiki "^0.9.2" shiki "^0.9.2"
typedoc-default-themes "^0.12.7" typedoc-default-themes "^0.12.7"
typescript@^4.2.2: typescript@^4.1.5:
version "4.2.2" version "4.1.5"
resolved "https://registry.yarnpkg.com/typescript/-/typescript-4.2.2.tgz#1450f020618f872db0ea17317d16d8da8ddb8c4c" resolved "https://registry.yarnpkg.com/typescript/-/typescript-4.1.5.tgz#123a3b214aaff3be32926f0d8f1f6e704eb89a72"
integrity sha512-tbb+NVrLfnsJy3M59lsDgrzWIflR4d4TIUjz+heUnHZwdF7YsrMTKoRERiIvI2lvBG95dfpLxB21WZhys1bgaQ== integrity sha512-6OSu9PTIzmn9TCDiovULTnET6BgXtDYL4Gg4szY+cGsc3JP1dQL8qvE8kShTRx1NIw4Q9IBHlwODjkjWEtMUyA==
ua-parser-js@^0.7.18: ua-parser-js@^0.7.18:
version "0.7.24" version "0.7.24"