CameraViewProps

interface CameraViewProps extends CameraProps, Pick

Properties

cameraExtension?

optional cameraExtension: CameraExtension

Inherited from

CameraProps.cameraExtension

colorSpace?

optional colorSpace: ColorSpace | "auto"

Inherited from

CameraProps.colorSpace

depthFormat?

optional depthFormat: CameraFormat | null

Inherited from

CameraProps.depthFormat

device

device: 
  | CameraPosition
  | CameraDevice

Inherited from

CameraProps.device

enableDistortionCorrection?

optional enableDistortionCorrection: boolean

Inherited from

CameraProps.enableDistortionCorrection

enableLowLightBoost?

optional enableLowLightBoost: boolean

Inherited from

CameraProps.enableLowLightBoost

enableMultiCamSupport?

optional enableMultiCamSupport: boolean

Inherited from

CameraProps.enableMultiCamSupport

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?

optional enableSmoothAutoFocus: boolean

Inherited from

CameraProps.enableSmoothAutoFocus

enableVideoHDR?

optional enableVideoHDR: boolean

Inherited from

CameraProps.enableVideoHDR

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

format?

optional format: CameraFormat

Inherited from

CameraProps.format

fps?

optional fps: Range

Inherited from

CameraProps.fps

getInitialExposureBias()?

optional getInitialExposureBias: () => number | undefined

Inherited from

CameraProps.getInitialExposureBias

getInitialZoom()?

optional getInitialZoom: () => number | undefined

Inherited from

CameraProps.getInitialZoom

implementationMode?

Android

optional implementationMode: PreviewImplementationMode

Sets the PreviewImplementationMode for the PreviewView.

Default

'performance'

Inherited from

PreviewViewProps.implementationMode

isActive

isActive: boolean

Inherited from

CameraProps.isActive

mirrorMode?

optional mirrorMode: MirrorMode

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.

Inherited from

CameraProps.onError

onInterruptionEnded()?

optional onInterruptionEnded: () => void

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

Inherited from

CameraProps.onInterruptionEnded

onInterruptionStarted()?

optional onInterruptionStarted: (interruption: InterruptionReason) => void

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

Inherited from

CameraProps.onInterruptionStarted

onPreviewStarted()?

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.

onStarted()?

optional onStarted: () => void

Called when the CameraSession has been started.

Inherited from

CameraProps.onStarted

onStopped()?

optional onStopped: () => void

Called when the CameraSession has been stopped.

Inherited from

CameraProps.onStopped

orientationSource?

optional orientationSource: OrientationSource | "custom"

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

Inherited from

CameraProps.orientationSource

outputs?

optional outputs: CameraOutput[]

Inherited from

CameraProps.outputs

ref?

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'

videoStabilizationMode?

optional videoStabilizationMode: VideoStabilizationMode

Inherited from

CameraProps.videoStabilizationMode

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