TypeScript SDK Reference / ScanConditions

Interface: ScanConditions

Defines the required conditions for a scan.

Properties

centered

centered: boolean

True if the face position requirement is fulfilled.

---

distance

distance: boolean

True if the distance requirement is fulfilled.

---

distanceCondition

distanceCondition: DistanceCondition

Describe the distance of the face

---

facePositionCondition

facePositionCondition: FacePositionCondition

Describe the position of the face

---

fps

fps: number

Frame per second

---

frameRate

frameRate: boolean

True if the frame rate requirement is fulfilled.

---

lighting

lighting: boolean

True if the ligithing requirement is fulfilled.

---

movement

movement: boolean

True if the face stability requirement is fulfilled.

---

serverReady

serverReady: boolean

True if the server is ready.