Skip to content

ReactNative SDK Reference / CameraDevice

Interface: CameraDevice

Represents a camera device discovered by the VitalSignCamera.getAvailableCameraDevices() function

Properties

devices

devices: PhysicalCameraDeviceType[]

The physical devices this CameraDevice contains.

  • If this camera device is a logical camera (combination of multiple physical cameras), there are multiple cameras in this array.
  • If this camera device is a physical camera, there is only a single element in this array.

You can check if the camera is a logical multi-camera by using the isMultiCam property.


formats

formats: CameraDeviceFormat[]

All available formats for this camera device. Use this to find the best format for your use case and set it to the Camera's Camera's .format property.

See the Camera Formats documentation for more information about Camera Formats.


hasFlash

hasFlash: boolean

Specifies whether this camera supports enabling flash for photo capture.


hasTorch

hasTorch: boolean

Specifies whether this camera supports continuously enabling the flash to act like a torch (flash with video capture)


id

id: string

The native ID of the camera device instance.


isMultiCam

isMultiCam: boolean

A property indicating whether the device is a virtual multi-camera consisting of multiple combined physical cameras.

Examples:

  • The Dual Camera, which supports seamlessly switching between a wide and telephoto camera while zooming and generating depth data from the disparities between the different points of view of the physical cameras.
  • The TrueDepth Camera, which generates depth data from disparities between a YUV camera and an Infrared camera pointed in the same direction.

maxZoom

maxZoom: number

Maximum available zoom factor (e.g. 128)


minZoom

minZoom: number

Minimum available zoom factor (e.g. 1)


name

name: string

A friendly localized name describing the camera.


neutralZoom

neutralZoom: number

The zoom factor where the camera is "neutral".

  • For single-physical cameras this property is always 1.0.
  • For multi cameras this property is a value between minZoom and maxZoom, where the camera is in wide-angle mode and hasn't switched to the ultra-wide-angle ("fish-eye") or telephoto camera yet.

Use this value as an initial value for the zoom property if you implement custom zoom. (e.g. reanimated shared value should be initially set to this value)

Example

ts
const device = ...

const zoom = useSharedValue(device.neutralZoom) // <-- initial value so it doesn't start at ultra-wide
const cameraProps = useAnimatedProps(() => ({
  zoom: zoom.value
}))

position

position: CameraPosition

Specifies the physical position of this camera. (back or front)


supportsDepthCapture

supportsDepthCapture: boolean

Whether this camera supports taking photos with depth data.

! Work in Progress !


supportsLowLightBoost

supportsLowLightBoost: boolean

Whether this camera device supports low light boost.


supportsParallelVideoProcessing

supportsParallelVideoProcessing: boolean

Whether this camera device supports using Video Recordings (video={true}) and Frame Processors (frameProcessor={...}) at the same time. See "The supportsParallelVideoProcessing prop" for more information.

If this property is false, you can only enable video or add a frameProcessor, but not both.


supportsRawCapture

supportsRawCapture: boolean

Whether this camera supports taking photos in RAW format

! Work in Progress !