ReactNative SDK Reference / VitalSignEnginePlugin

Interface: VitalSignEnginePlugin

The main interface of the Vital Sign Plugin.

Methods

configure()

configure(config): void

Call this method to configure the plugin.

Parameters

• config: VitalSignEngineConfig

The object with configuration settings

Returns

void

---

getHealth()

getHealth(options): Promise<GetHealthResult>

When the scanning session started, client must call this method with a frequency of atleast 20Hz.

Parameters

• options: GetHealthOptions

Contains the required informations for processing.

Returns

Promise<GetHealthResult>

---

isReady()

isReady(): Promise<boolean>

Call this method to check if the plugin is ready to start.

Returns

Promise<boolean>

---

start()

start(): Promise<void>

Call this method to start a scanning session.

Returns

Promise<void>

---

stop()

stop(): Promise<void>

Call this method to stop the scanning session.

Returns

Promise<void>

---

waitUntilReady()

waitUntilReady(): Promise<void>

Call this method to wait until the plugn is ready.

Returns

Promise<void>