CameraViewProps

interface CameraViewProps extends CameraProps, Pick

Props for the Camera component.

Extends CameraProps (the options for the underlying useCamera hook) with PreviewView-specific options and convenience props for gesture handling and animated values.

Properties

constraints?

optional constraints: Constraint[]

Constraints (e.g. { fps: 60 }) that the Camera pipeline will try to match when configuring the CameraSession.

See

CameraSessionConnection.constraints

Inherited from

CameraProps.constraints

device

device: 
  | CameraDevice
  | CameraPosition

The CameraDevice to open, or a CameraPosition (e.g. 'back') to auto-pick a matching device via getCameraDevice(...).

See

CameraSessionConnection.input

Inherited from

CameraProps.device

enableDistortionCorrection?

iOS

optional enableDistortionCorrection: boolean

If true, geometric distortion at the edges (e.g. on ultra-wide-angle cameras) is corrected, at the cost of a small amount of field of view.

See

CameraControllerConfiguration.enableDistortionCorrection

Default

true

Inherited from

CameraProps.enableDistortionCorrection

enableLowLightBoost?

optional enableLowLightBoost: boolean

If true, the Camera pipeline may extend exposure times (effectively dropping frame rate) in low-light scenes to receive more light.

See

CameraControllerConfiguration.enableLowLightBoost

Default

false

Inherited from

CameraProps.enableLowLightBoost

enableNativeTapToFocusGesture?

optional enableNativeTapToFocusGesture: boolean

Enables (or disables) the native tap-to-focus gesture.

Default

false

enableNativeZoomGesture?

optional enableNativeZoomGesture: boolean

Enables (or disables) the native pinch-to-zoom gesture.

Throws

If this property is enabled and zoom is not undefined.

Default

false

enableSmoothAutoFocus?

iOS

optional enableSmoothAutoFocus: boolean

If true, auto-focus transitions are performed slower and smoother to appear less intrusive in video recordings.

See

CameraControllerConfiguration.enableSmoothAutoFocus

Default

false

Inherited from

CameraProps.enableSmoothAutoFocus

exposure?

optional exposure: 
  | number
| SharedValue<number>

Sets the exposureBias value.

You can also manually set the exposure bias via setExposureBias(...).

Note

This property can be animated via Reanimated by passing a SharedValue.

Default

getInitialExposureBias()?

optional getInitialExposureBias: () => number | undefined

A getter for the initial exposure bias to apply when the CameraController is created. Later, the exposure bias can be adjusted via CameraController.setExposureBias(...).

See

CameraSessionConnection.initialExposureBias

Inherited from

CameraProps.getInitialExposureBias

getInitialZoom()?

optional getInitialZoom: () => number | undefined

A getter for the initial zoom value to apply when the CameraController is created. Later, the zoom can be adjusted via CameraController.setZoom(...).

See

CameraSessionConnection.initialZoom

Inherited from

CameraProps.getInitialZoom

implementationMode?

Android

optional implementationMode: PreviewImplementationMode

Sets the PreviewImplementationMode for the PreviewView.

Default

'performance'

Inherited from

PreviewViewProps.implementationMode

isActive

isActive: boolean

Starts the CameraSession when set to true, and stops it when set back to false.

See

Inherited from

CameraProps.isActive

mirrorMode?

optional mirrorMode: MirrorMode

Sets whether the CameraOutputs are mirrored along the vertical axis. 'auto' mirrors automatically on selfie cameras.

See

CameraOutputConfiguration.mirrorMode

Default

'auto'

Inherited from

CameraProps.mirrorMode

onConfigured()?

optional onConfigured: () => void

Called whenever the CameraSession has been configured with new connections via configure(...) and connections to the individual outputs are formed.

This is a good place to check output capabilities, such as CameraVideoOutput.getSupportedVideoCodecs()

Inherited from

CameraProps.onConfigured

onError()?

optional onError: (error: Error) => void

Called whenever the CameraSession has encountered an error.

See

CameraSession.addOnErrorListener

Inherited from

CameraProps.onError

onInterruptionEnded()?

optional onInterruptionEnded: () => void

Called when a previous interruption has ended and the CameraSession is running uninterrupted again.

optional onInterruptionStarted: (interruption: InterruptionReason) => void

Called whenever the CameraSession has encountered an interruption of the given InterruptionReason. Interruptions are temporarily.

optional onPreviewStarted: () => void

Called when the Camera's Preview received its first Frame.

onPreviewStopped()?

optional onPreviewStopped: () => void

Called when the Camera's Preview stopped streaming Frames.

onSessionConfigSelected()?

optional onSessionConfigSelected: (config: CameraSessionConfig) => void

Called once the given constraints have been fully resolved into a concrete CameraSessionConfig.

optional onStarted: () => void

Called when the CameraSession has been started.

optional onStopped: () => void

Called when the CameraSession has been stopped.

optional onSubjectAreaChanged: () => void

Called when the subject area substantially changes, e.g. when the user pans away from a scene that was previously in focus.

This is a good point to reset any locked AE/AF/AWB focus states back to continuously auto-focus.

optional orientationSource: OrientationSource | "custom"

Set a desired OrientationSource for automatically applying CameraOrientation to all outputs, or 'custom' if you prefer to manually specify CameraOrientation yourself.

optional outputs: CameraOutput[]

The CameraOutputs the device will stream into.

optional ref: Ref<CameraRef>

See

CameraRef

resizeMode?

optional resizeMode: PreviewResizeMode

Sets the PreviewResizeMode for the PreviewView.

Default

'cover'

Inherited from

PreviewViewProps.resizeMode

torchMode?

optional torchMode: TorchMode

Sets the torchMode value.

Default

'off'

zoom?

optional zoom: 
  | number
| SharedValue<number>

Sets the zoom value.

You can also manually set zoom via setZoom(...).

Note

This property can be animated via Reanimated by passing a SharedValue.

Throws

If this property is set and enableNativeZoomGesture is enabled.

On this page