TypeScript SDK Reference / VitalSignEnginePlugin
Interface: VitalSignEnginePlugin
The main interface of the Vital Sign Engine Plugin. This interface defines the contract for vital sign analysis engines, providing methods to configure, start, and monitor the scanning process.
Methods
configure()
configure(
config):void
Configure the plugin with the provided settings.
Parameters
config
Returns
void
getHealth()
getHealth(
options):GetHealthResult
Process a video frame and update scanning progress. Must be called at least 20Hz during scanning.
Parameters
options
Returns
isReady()
isReady():
Promise<boolean>
Check if the plugin is ready to start scanning.
Returns
Promise<boolean>
sendHealthReport()
sendHealthReport(
healthReport,emailTemplate,source):Promise<void>
Parameters
email
string[]
healthReport
string
emailTemplate
source
string
Returns
Promise<void>
Deprecated
Send health report via email. For backward compatibility only.
start()
start():
Promise<void>
Start a new scanning session.
Returns
Promise<void>
stop()
stop():
Promise<void>
Stop the current scanning session.
Returns
Promise<void>
waitUntilReady()
waitUntilReady():
Promise<void>
Wait until the plugin is fully initialized and ready.
Returns
Promise<void>