React SDK Reference / VitalSignCameraCreationProps
Interface: VitalSignCameraCreationProps
Defines the properties for creating the vital sign camera component.
Extended by
Properties
ageEstimationConfig?
optionalageEstimationConfig:AgeEstimationConfig
The configuration for age estimation.
checkBrightness?
optionalcheckBrightness:boolean
False to disable brightness check.
conditionCheckerConfig?
optionalconditionCheckerConfig:ConditionCheckerConfig
The configuration for condition checking.
config?
optionalconfig:VitalSignEngineConfig
The config of the vital sign engine.
customConditionRange?
optionalcustomConditionRange:CustomConditionRange
The customized range of scanning conditions.
Deprecated
This property is deprecated and will be removed in a future version. Use ConditionCheckerConfig instead.
device?
optionaldevice:string
The device ID of the camera.
disableAgeEstimation?
optionaldisableAgeEstimation:boolean
True if age estimation is disabled.
enableBeautyAnalysis?
optionalenableBeautyAnalysis:boolean
True if beauty analysis is enabled, default is false. Note: Age estimation will also be enabled if beauty analysis is enabled.
faceApiModelPath?
optionalfaceApiModelPath:string
The path of the Face API models.
faceDetectionModelLocation?
optionalfaceDetectionModelLocation:FaceDetectionModelLocation
The location of the face detection model.
faceDetectionRegion?
optionalfaceDetectionRegion:FaceDetectionRegion
The region of the face detection.
faceDetectionSamplingInterval?
optionalfaceDetectionSamplingInterval: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.
faceDetectorType?
optionalfaceDetectorType:FaceDetectorType
The type of the face detector.
frameGrabberConfig?
optionalframeGrabberConfig:FrameGrabberConfig
The configuration for frame grabbing.
isActive
isActive:
boolean
True if the camera is activated.
maxFaceDetectionFps?
optionalmaxFaceDetectionFps:number
Maximum face detection rate.
maxFps?
optionalmaxFps:number
Maximum camera capturing rate.
onCameraDevicesUpdated()?
optionalonCameraDevicesUpdated: (event) =>void
The call back function that observes the camera devices updated event.
Parameters
event
Returns
void
onError()?
optionalonError: (error) =>void
The call back function that observes errors.
Parameters
error
unknown
Returns
void
onInitialized()?
optionalonInitialized: () =>void
The call back function that observes the initialized event.
Returns
void
onPrecisionModeUpdated()?
optionalonPrecisionModeUpdated: (event) =>void
The call back function that observes the precision mode updated event.
Parameters
event
Returns
void
onPrecisionModeWillUpdate()?
optionalonPrecisionModeWillUpdate: (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
Returns
void
onTransformUpdated()?
optionalonTransformUpdated: (transform) =>void
The call back function that observes the transform updated event.
Parameters
transform
Returns
void
onVideoFrameProcessed()?
optionalonVideoFrameProcessed: (event) =>void
The call back function that observes the video frame processed event.
Parameters
event
Returns
void
onVideoSettingsUpdated()?
optionalonVideoSettingsUpdated: (event) =>void
The call back function that observes the video settings updated event.
Parameters
event
Returns
void
precisionMode?
optionalprecisionMode:PrecisionMode
Precision mode
preferredCamera?
optionalpreferredCamera:string
The device id of the preferred camera.
presetFormat?
optionalpresetFormat:PresetFormat
The preset camera resolution.
sdkCredentials?
optionalsdkCredentials:SdkCredentials
The SDK credentials for accessing the API.
userInfo
userInfo:
UserInfo
The info of the user doing the scan.
visualizationOptions?
optionalvisualizationOptions:VisualizationOptions
The options for enabling visualization such as bounding box or face mesh.