React SDK Reference / VitalSignCameraProps

Interface: VitalSignCameraProps

Props for the VitalSignCamera React component. Extends VitalSignCameraCreationProps with React-specific callback props.

Extends

• VitalSignCameraCreationProps

Properties

ageEstimationConfig?

optional ageEstimationConfig: AgeEstimationConfig

The configuration for age estimation.

Inherited from

VitalSignCameraCreationProps.ageEstimationConfig

---

checkBrightness?

optional checkBrightness: boolean

False to disable brightness check.

Inherited from

VitalSignCameraCreationProps.checkBrightness

---

conditionCheckerConfig?

optional conditionCheckerConfig: ConditionCheckerConfig

The configuration for condition checking.

Inherited from

VitalSignCameraCreationProps.conditionCheckerConfig

---

config?

optional config: VitalSignEngineConfig

The config of the vital sign engine.

Inherited from

VitalSignCameraCreationProps.config

---

customConditionRange?

optional customConditionRange: CustomConditionRange

The customized range of scanning conditions.

Deprecated

This property is deprecated and will be removed in a future version. Use ConditionCheckerConfig instead.

Inherited from

VitalSignCameraCreationProps.customConditionRange

---

device?

optional device: string

The device ID of the camera.

Inherited from

VitalSignCameraCreationProps.device

---

disableAgeEstimation?

optional disableAgeEstimation: boolean

True if age estimation is disabled.

Inherited from

VitalSignCameraCreationProps.disableAgeEstimation

---

enableBeautyAnalysis?

optional enableBeautyAnalysis: boolean

True if beauty analysis is enabled, default is false. Note: Age estimation will also be enabled if beauty analysis is enabled.

Inherited from

VitalSignCameraCreationProps.enableBeautyAnalysis

---

faceApiModelPath?

optional faceApiModelPath: string

The path of the Face API models.

Inherited from

VitalSignCameraCreationProps.faceApiModelPath

---

faceDetectionModelLocation?

optional faceDetectionModelLocation: FaceDetectionModelLocation

The location of the face detection model.

Inherited from

VitalSignCameraCreationProps.faceDetectionModelLocation

---

faceDetectionRegion?

optional faceDetectionRegion: FaceDetectionRegion

The region of the face detection.

Inherited from

VitalSignCameraCreationProps.faceDetectionRegion

---

faceDetectionSamplingInterval?

optional faceDetectionSamplingInterval: number

The time interval in milliseconds of sampling face detection result. Default is 2000ms. If it is undefined, the face detection result will be sampled at the same rate as the face detection rate.

Inherited from

VitalSignCameraCreationProps.faceDetectionSamplingInterval

---

faceDetectorType?

optional faceDetectorType: FaceDetectorType

The type of the face detector.

Inherited from

VitalSignCameraCreationProps.faceDetectorType

---

frameGrabberConfig?

optional frameGrabberConfig: FrameGrabberConfig

The configuration for frame grabbing.

Inherited from

VitalSignCameraCreationProps.frameGrabberConfig

---

isActive

isActive: boolean

True if the camera is activated.

Inherited from

VitalSignCameraCreationProps.isActive

---

maxFaceDetectionFps?

optional maxFaceDetectionFps: number

Maximum face detection rate.

Inherited from

VitalSignCameraCreationProps.maxFaceDetectionFps

---

maxFps?

optional maxFps: number

Maximum camera capturing rate.

Inherited from

VitalSignCameraCreationProps.maxFps

---

onCameraDevicesUpdated()?

optional onCameraDevicesUpdated: (event) => void

The call back function that observes the camera devices updated event.

Parameters

event

CameraDevicesUpdatedEvent

Returns

void

Inherited from

VitalSignCameraCreationProps.onCameraDevicesUpdated

---

onCreated()?

optional onCreated: (instance) => void

Callback fired when the VitalSignCamera instance is created. Provides access to the camera instance for programmatic control.

Parameters

instance

VitalSignCameraInstance

The created VitalSignCamera instance

Returns

void

---

onError()?

optional onError: (error) => void

The call back function that observes errors.

Parameters

error

unknown

Returns

void

Inherited from

VitalSignCameraCreationProps.onError

---

onInitialized()?

optional onInitialized: () => void

The call back function that observes the initialized event.

Returns

void

Inherited from

VitalSignCameraCreationProps.onInitialized

---

onPrecisionModeUpdated()?

optional onPrecisionModeUpdated: (event) => void

The call back function that observes the precision mode updated event.

Parameters

event

PrecisionModeUpdatedEvent

Returns

void

Inherited from

VitalSignCameraCreationProps.onPrecisionModeUpdated

---

onPrecisionModeWillUpdate()?

optional onPrecisionModeWillUpdate: (event) => void

The call back function that observes the precision mode will update event. The function should call the response function with 'proceed' to proceed with the update, or 'wait' to wait.

Parameters

event

PrecisionModeWillUpdateEvent

Returns

void

Inherited from

VitalSignCameraCreationProps.onPrecisionModeWillUpdate

---

onTransformUpdated()?

optional onTransformUpdated: (transform) => void

The call back function that observes the transform updated event.

Parameters

transform

TransformXStyle

Returns

void

Inherited from

VitalSignCameraCreationProps.onTransformUpdated

---

onVideoFrameProcessed()?

optional onVideoFrameProcessed: (event) => void

The call back function that observes the video frame processed event.

Parameters

event

VideoFrameProcessedEvent

Returns

void

Inherited from

VitalSignCameraCreationProps.onVideoFrameProcessed

---

onVideoSettingsUpdated()?

optional onVideoSettingsUpdated: (event) => void

The call back function that observes the video settings updated event.

Parameters

event

VideoSettingsUpdatedEvent

Returns

void

Inherited from

VitalSignCameraCreationProps.onVideoSettingsUpdated

---

precisionMode?

optional precisionMode: PrecisionMode

Precision mode

Inherited from

VitalSignCameraCreationProps.precisionMode

---

preferredCamera?

optional preferredCamera: string

The device id of the preferred camera.

Inherited from

VitalSignCameraCreationProps.preferredCamera

---

presetFormat?

optional presetFormat: PresetFormat

The preset camera resolution.

Inherited from

VitalSignCameraCreationProps.presetFormat

---

sdkCredentials?

optional sdkCredentials: SdkCredentials

The SDK credentials for accessing the API.

Inherited from

VitalSignCameraCreationProps.sdkCredentials

---

userInfo

userInfo: UserInfo

The info of the user doing the scan.

Inherited from

VitalSignCameraCreationProps.userInfo

---

visualizationOptions?

optional visualizationOptions: VisualizationOptions

The options for enabling visualization such as bounding box or face mesh.

Inherited from

VitalSignCameraCreationProps.visualizationOptions