React SDK Reference / VitalSignEngineConfig

Interface: VitalSignEngineConfig

Defining the object for configuring the plugin.

See

configure

Extends

• RemoteHealthAnalyzerConfig

Properties

apiKey?

optional apiKey: string

Optional. The API key

Inherited from

RemoteHealthAnalyzerConfig.apiKey

---

blinkDetectorConfig?

optional blinkDetectorConfig: BlinkDetectorConfig

Optional. The config of the BlinkDetector.

---

blinkDetectorType?

optional blinkDetectorType: BlinkDetectorType

Optional. The type of blink detector. Default is dummy (No detection).

---

chestPixelDataType?

optional chestPixelDataType: PixelDataType

Optional. The pixel format used for the chest pixel extractor. Default is GGG1x1

---

dataCollectionDuration?

optional dataCollectionDuration: number

Optional. The duration in seconds of collecting face data. Default is 25.

---

dataSendingDuration?

optional dataSendingDuration: number

Optional. The duration in seconds of sending face data to backend. Default is 5.

---

dataSendingRate?

optional dataSendingRate: number

Optional. The rate in Hz of sending face data to backend. Default is 0.3.

---

dataWindowDuration?

optional dataWindowDuration: number

Optional. The window duration in seconds of face data. Default is 15.

Inherited from

RemoteHealthAnalyzerConfig.dataWindowDuration

---

enableChestROI?

optional enableChestROI: boolean

(Deprecated) Optional. The flag to enable the chest ROI. Default is true.

---

enabledROIs?

optional enabledROIs: PixelROI[]

Optional. The list of enabled ROIs. Defaults are face and chest.

---

enableSavingRequest?

optional enableSavingRequest: boolean

Optional. True if enabling saving request.

Inherited from

RemoteHealthAnalyzerConfig.enableSavingRequest

---

faceLostTimeout?

optional faceLostTimeout: number

Optional. The timeout of face lost detection in seconds

---

httpCall()?

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

Call Signature

(input, init?): Promise<Response>

MDN Reference

Parameters

input

RequestInfo | URL

init?

RequestInit

Returns

Promise<Response>

Call Signature

(input, init?): Promise<Response>

MDN Reference

Parameters

input

string | Request | URL

init?

RequestInit

Returns

Promise<Response>

Inherited from

RemoteHealthAnalyzerConfig.httpCall

---

landmarksSampleRate?

optional landmarksSampleRate: number

Optional. The sample rate in fps of facial landmarks to be sent to backend. Default is 10.

Inherited from

RemoteHealthAnalyzerConfig.landmarksSampleRate

---

pixelDataType?

optional pixelDataType: PixelDataType

Optional. The pixel format used for the pixel extractor. Default is RGB1x1

---

serverId?

optional serverId: ServerId

Optional. The ID of the backend server.

Inherited from

RemoteHealthAnalyzerConfig.serverId

---

serverUrl?

optional serverUrl: string

Optional. The URL of the backend server. If not provided, the plugin will use the default URL defined by the serverId.

Inherited from

RemoteHealthAnalyzerConfig.serverUrl