TypeScript SDK Reference / VitalSignEngineConfig

Interface: VitalSignEngineConfig

Configuration object for the Vital Sign Engine. Defines all parameters for controlling the vital sign analysis process, including timing, data collection, and processing options.

See

configure

Extends

• RemoteHealthAnalyzerConfig

Properties

apiKey?

optional apiKey: string

API key for authenticating requests to the backend.

Inherited from

RemoteHealthAnalyzerConfig.apiKey

---

blinkDetectorConfig?

optional blinkDetectorConfig: BlinkDetectorConfig

Configuration for the blink detector.

---

blinkDetectorType?

optional blinkDetectorType: BlinkDetectorType

Type of blink detector to use. Default is dummy (no detection).

---

chestPixelDataType?

optional chestPixelDataType: PixelDataType

Pixel format for the chest pixel extractor. Default is GGG1x1.

---

dataCollectionDuration?

optional dataCollectionDuration: number

Duration in seconds for collecting face data before analysis. Default is 25.

---

dataSendingDuration?

optional dataSendingDuration: number

Duration in seconds for sending collected data to backend. Default is 5.

---

dataSendingRate?

optional dataSendingRate: number

Rate in Hz for sending face data to backend. Default is 0.3.

---

dataWindowDuration?

optional dataWindowDuration: number

Duration in seconds of face data to collect in a sliding window. Default is 15.

Inherited from

RemoteHealthAnalyzerConfig.dataWindowDuration

---

enableChestROI?

optional enableChestROI: boolean

Deprecated

Use enabledROIs instead. Flag to enable chest ROI.

---

enabledROIs?

optional enabledROIs: PixelROI[]

List of enabled regions of interest (ROIs) for data extraction.

---

enableSavingRequest?

optional enableSavingRequest: boolean

Whether to enable saving of requests for debugging purposes.

Inherited from

RemoteHealthAnalyzerConfig.enableSavingRequest

---

faceLostTimeout?

optional faceLostTimeout: number

Timeout in seconds for face lost detection.

---

httpCall()?

optional httpCall: {(input, init?): Promise<Response>; (input, init?): Promise<Response>; }

Custom HTTP function to use instead of the built-in fetch.

Call Signature

(input, init?): Promise<Response>

MDN Reference

Parameters

input

URL | RequestInfo

init?

RequestInit

Returns

Promise<Response>

Call Signature

(input, init?): Promise<Response>

MDN Reference

Parameters

input

URL | RequestInfo

init?

RequestInit

Returns

Promise<Response>

Inherited from

RemoteHealthAnalyzerConfig.httpCall

---

landmarksSampleRate?

optional landmarksSampleRate: number

Sample rate in FPS for facial landmarks sent to backend. Default is 10.

Inherited from

RemoteHealthAnalyzerConfig.landmarksSampleRate

---

pixelDataType?

optional pixelDataType: PixelDataType

Pixel format for the main pixel extractor. Default is RGB1x1.

---

serverId?

optional serverId: ServerId

The ID of the backend server to use for analysis.

Inherited from

RemoteHealthAnalyzerConfig.serverId

---

serverUrl?

optional serverUrl: string

Custom URL of the backend server. If not provided, uses default URL for serverId.

Inherited from

RemoteHealthAnalyzerConfig.serverUrl