TypeScript SDK Reference / GetHealthOptions

Interface: GetHealthOptions

The information needed for the getHealth function to process a video frame. This interface contains all the data required for the vital sign engine to analyze a single frame and update the scanning progress.

See

getHealth

Properties

faceBox?

optional faceBox: NormalizedFacebox

Normalized bounding box coordinates of the detected face.

---

images?

optional images: object

Images of different regions of interest (ROI) extracted from the face.

chest?

optional chest: ROI

chin?

optional chin: ROI

face?

optional face: ROI

forehead?

optional forehead: ROI

glabella?

optional glabella: ROI

leftCheek?

optional leftCheek: ROI

leftLowerCheek?

optional leftLowerCheek: ROI

leftUpperCheek?

optional leftUpperCheek: ROI

neck?

optional neck: ROI

rightCheek?

optional rightCheek: ROI

rightLowerCheek?

optional rightLowerCheek: ROI

rightUpperCheek?

optional rightUpperCheek: ROI

---

landmarks

landmarks: NormalizedLandmark[]

Array of normalized facial landmark coordinates.

---

userInfo

userInfo: UserInfo

Information about the user being scanned, including demographics and health history.

---

videoFrameInfo

videoFrameInfo: VideoFrameInfo

Metadata about the video frame being processed.