ReactNative SDK Reference / VitalSignEngineConfig

Interface: VitalSignEngineConfig

Defining the object for configuring the plugin.

See

configure

Properties

apiKey?

apiKey?: string

Optional. The API key

---

blinkDetectorType?

blinkDetectorType?: BlinkDetectorType

Optional. The type of blink detector to use. Default is "dummy", which means no blink detector.

---

chestPixelsExtractorType?

chestPixelsExtractorType?: PixelDataType

Optional. The type of chest pixels extractor to use.

---

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.

---

debugMode?

debugMode?: boolean

Optional. If set to true, the plugin send debug information to the backend server.

---

facePixelsExtractorType?

facePixelsExtractorType?: PixelDataType

Optional. The type of face pixels extractor to use. Default is "rgb1x1".

---

serverId?

serverId?: ServerId

Optional. The ID of the backend server.