TypeScript SDK Reference / VitalSignEngineConfig
Interface: VitalSignEngineConfig
Defining the object for configuring the plugin.
See
configure
Extends
Properties
apiKey?
apiKey?:
string
Optional. The API key
Inherited from
RemoteHealthAnalyzerConfig.apiKey
blinkDetectorConfig?
blinkDetectorConfig?:
BlinkDetectorConfig
Optional. The config of the BlinkDetector.
blinkDetectorType?
blinkDetectorType?:
BlinkDetectorType
Optional. The type of blink detector. Default is dummy (No detection).
dataCollectionDuration?
dataCollectionDuration?:
number
Optional. The duration in seconds of collecting face data. Default is 25.
dataSendingDuration?
dataSendingDuration?:
number
Optional. The duration in seconds of sending face data to backend. Default is 5.
dataSendingRate?
dataSendingRate?:
number
Optional. The rate in Hz of sending face data to backend. Default is 0.3.
dataWindowDuration?
dataWindowDuration?:
number
Optional. The window duration in seconds of face data. Default is 15.
Inherited from
RemoteHealthAnalyzerConfig.dataWindowDuration
enableChestROI?
enableChestROI?:
boolean
Optional. The flag to enable the chest ROI. Default is false. If true, the chest ROI will be enabled.
enableSavingRequest?
enableSavingRequest?:
boolean
Optional. True if enabling saving request.
Inherited from
RemoteHealthAnalyzerConfig.enableSavingRequest
faceLostTimeout?
faceLostTimeout?:
number
Optional. The timeout of face lost detection in seconds
httpCall?
httpCall?: (
input,init?) =>Promise<Response>
Parameters
• input: RequestInfo | URL
• init?: RequestInit
Returns
Promise<Response>
Inherited from
RemoteHealthAnalyzerConfig.httpCall
pixelDataType?
pixelDataType?:
PixelDataType
Optional. The pixel format used for the pixel extractor. Default is RGB1x1
serverId?
serverId?:
ServerId
Optional. The ID of the backend server.