036856aed5
* Move everything into package * Remove .DS_Store * Move scripts and eslintrc to package * Create CODE_OF_CONDUCT.md * fix some links * Update all links (I think) * Update generated docs * Update notice-yarn-changes.yml * Update validate-android.yml * Update validate-cpp.yml * Delete notice-yarn-changes.yml * Update validate-cpp.yml * Update validate-cpp.yml * Update validate-js.yml * Update validate-cpp.yml * Update validate-cpp.yml * wrong c++ style * Revert "wrong c++ style" This reverts commit 55a3575589c6f13f8b05134d83384f55e0601ab2.
11 KiB
| id | title | sidebar_position | custom_edit_url |
|---|---|---|---|
| CameraProps | CameraProps | 0 | null |
Hierarchy
-
ViewProps↳
CameraProps
Properties
audio
• Optional audio: boolean
Enables audio capture for video recordings (see "Recording Videos")
Defined in
device
• device: CameraDevice
The Camera Device to use.
See the Camera Devices section in the documentation for more information about Camera Devices.
Example
const devices = useCameraDevices('wide-angle-camera')
const device = devices.back
return (
<Camera
device={device}
isActive={true}
style={StyleSheet.absoluteFill}
/>
)
Defined in
enableDepthData
• Optional enableDepthData: boolean
Also captures data from depth-perception sensors. (e.g. disparity maps)
Default
false
Defined in
enableFpsGraph
• Optional enableFpsGraph: boolean
If true, show a debug view to display the FPS of the Camera session.
This is useful for debugging your Frame Processor's speed.
Default
false
Defined in
enableHighQualityPhotos
• Optional enableHighQualityPhotos: boolean
Indicates whether the Camera should prepare the photo pipeline to provide maximum quality photos.
This enables:
- High Resolution Capture (
isHighResolutionCaptureEnabled) - Virtual Device fusion for greater detail (
isVirtualDeviceConstituentPhotoDeliveryEnabled) - Dual Device fusion for greater detail (
isDualCameraDualPhotoDeliveryEnabled) - Sets the maximum quality prioritization to
.quality(maxPhotoQualityPrioritization)
Default
false
Defined in
enablePortraitEffectsMatteDelivery
• Optional 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
enableZoomGesture
• Optional enableZoomGesture: boolean
Enables or disables the native pinch to zoom gesture.
If you want to implement a custom zoom gesture, see the Zooming with Reanimated documentation.
Default
false
Defined in
format
• Optional format: CameraDeviceFormat
Selects a given format. By default, the best matching format is chosen.
Defined in
fps
• Optional fps: number
Specify the frames per second this camera should use. Make sure the given format includes a frame rate range with the given fps.
Requires format to be set.
Defined in
frameProcessor
• Optional frameProcessor: FrameProcessor
A worklet which will be called for every frame the Camera "sees".
See the Frame Processors documentation for more information
Example
const frameProcessor = useFrameProcessor((frame) => {
'worklet'
const qrCodes = scanQRCodes(frame)
console.log(`Detected QR Codes: ${qrCodes}`)
}, [])
return <Camera {...cameraProps} frameProcessor={frameProcessor} />
Defined in
hdr
• Optional hdr: boolean
Enables or disables HDR on this camera device. Make sure the given format supports HDR mode.
Requires format to be set.
Defined in
isActive
• isActive: boolean
Whether the Camera should actively stream video frames, or not. See the documentation about the isActive prop for more information.
This can be compared to a Video component, where isActive specifies whether the video is paused or not.
Note: If you fully unmount the
<Camera>component instead of usingisActive={false}, the Camera will take a bit longer to start again. In return, it will use less resources since the Camera will be completely destroyed when unmounted.
Defined in
lowLightBoost
• Optional lowLightBoost: boolean
Enables or disables low-light boost on this camera device. Make sure the given format supports low-light boost.
Requires format to be set.
Defined in
onError
• Optional onError: (error: CameraRuntimeError) => void
Type declaration
▸ (error): void
Called when any kind of runtime error occured.
Parameters
| Name | Type |
|---|---|
error |
CameraRuntimeError |
Returns
void
Defined in
onInitialized
• Optional onInitialized: () => void
Type declaration
▸ (): void
Called when the camera was successfully initialized.
Returns
void
Defined in
orientation
• Optional orientation: Orientation
Represents the orientation of all Camera Outputs (Photo, Video, and Frame Processor). If this value is not set, the device orientation is used.
Defined in
photo
• Optional photo: boolean
Enables photo capture with the takePhoto function (see "Taking Photos")
Defined in
pixelFormat
• Optional pixelFormat: "yuv" | "rgb" | "native"
Specifies the pixel format for the video pipeline.
Frames from a Frame Processor will be streamed in the pixel format specified here.
While native and yuv are the most efficient formats, some ML models (such as MLKit Barcode detection) require input Frames to be in RGB colorspace, otherwise they just output nonsense.
native: The hardware native GPU buffer format. This is the most efficient format. (PRIVATEon Android, sometimes YUV on iOS)yuv: The YUV (Y'CbCr 4:2:0 or NV21, 8-bit) format, either video- or full-range, depending on hardware capabilities. This is the second most efficient format.rgb: The RGB (RGB, RGBA or ABGRA, 8-bit) format. This is least efficient and requires explicit conversion.
Default
native
Defined in
torch
• Optional 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"
Defined in
video
• Optional video: boolean
Enables video capture with the startRecording function (see "Recording Videos")
Note: If both the photo and video properties are enabled at the same time and the device is running at a hardwareLevel of 'legacy' or 'limited', VisionCamera might use a lower resolution for video capture due to hardware constraints.
Defined in
videoStabilizationMode
• Optional videoStabilizationMode: VideoStabilizationMode
Specifies the video stabilization mode to use.
Requires a format to be set that contains the given videoStabilizationMode.
Defined in
zoom
• Optional zoom: number
Specifies the zoom factor of the current camera, in "factor"/scale.
This value ranges from minZoom (e.g. 1) to maxZoom (e.g. 128). It is recommended to set this value
to the CameraDevice's neutralZoom per default and let the user zoom out to the fish-eye (ultra-wide) camera
on demand (if available)
Note: Linearly increasing this value always appears logarithmic to the user.
Default
1.0