Observables: Data Collection

This page describes RxJS observables for collecting quality analysis results, final selfie images and technical information about LIQA status.

qualityStatus$: Observable<StatusData>

The qualityStatus$ (RxJS) Observable returns details of quality status of the current frame.

• In real time process (during video) qualityStatus$ returns information about current processed frame.

• After taking photo, qualityStatus$ returns information about final image quality. N.B.! This option is available since 5.4.0 version.

Property	Description
imageIsOkay: boolean	This parameter indicates an overall status of image quality: True: all parameters are okay, image quality is good enough False: some issues observed, the image quality is not good
faceDetection: boolean	This parameter indicates the face detection status: True: face is successfully detected False: face is not detected
facePosition: string	This parameter indicates the status or the observed problems with the positioning of a face in a frame. It can be expressed as one of four values: 'ok': face position is good 'too far': face is too far from the camera. For envMode?: "user" The user needs to bring the device closer to his / her own face For envMode?: "environment" (available from 5.3.0) The user needs to bring the device closer to patient face 'too close': face is too close to the camera. For envMode?: "user" The user needs to move the device further a little bit from his / her own face For envMode?: "environment" (available from 5.3.0) The user needs to move the device further a little bit from patient face 'out of frame': face is partially out of frame. The user needs to position his / her face fully on a frame 'not in center': face is not located in the center of frame. The user needs to position his / her face in the center of frame
faceRotation: string	This parameter indicates the status or the observed problems with head rotation. It can be expressed as one of seven values: 'ok': face is directed straight to the camera 'turned right': (yaw) head is turned to the right. The user needs to turn his / her head left to fix the issue 'turned left': (yaw) head is turned to the left. The user needs to turn his / her head right to fix the issue 'inclined right': (roll) head is inclined to the right. The user needs to incline his / her head to the left to fix the issue 'inclined left': (roll) head is inclined to the left. The user needs to incline his / her head to the right to fix the issue 'tilted down': (pitch) head is tilted down too much. The user needs to raise his / her head to fix the issue 'tilted up': (pitch) head is tilted up too much. The user needs to lower his / her head to fix the issue (See the illustration below)
faceIllumination: string	This parameter indicates the status or the observed problems with face illumination. It can be expressed as one of four values: 'ok': illumination of the face is good 'too dark': some areas of the face are too dark. The user needs to increase the light intensity 'too light': some areas of the face are too light. The user needs to diminish the light intensity 'too much contrast': dark and light areas. The user needs to fix the light distribution across the face to make the overall face illumination more uniform

Head rotation angles illustration

faceRotation status and LIQA outputs

See the Integration Guideline and Stream results parsing for a usage example of an observable.

events$: Observable<number>

The events$ (RxJS) Observable returns status of important LIQA statuses.

Code	Trigger event description	Additional information
0	Loading AI models	Percentage 0% as int
10	Initializing AI models	Percentage 10% as int
80	Initializing modules	Percentage 80% as int
90	Starting camera	Percentage 90% as int
success	LIQA succesfully started camera	Percentage 100% as int
-10	Unexpected error occured during LIQA loading	Code of error as int
-80	No access to camera granted (user declined access / access to camera is blocked by device / browser)	Code of error as int
-90	Unexpected error occured during LIQA execution	Code of error as int

See the Parsing guidelines for example of events parsing.

selfieImage$: Observable<string>

The selfieImage$ (RxJS) Observable returns base64 code of photo.

See the Integration Guideline and Selfie capturing results parsing for a usage example of an observable.

selfieLandmarks$: Observable<Array<number>>

The selfieLandmarks$ (RxJS) Observable returns an array of 53 points (vertices) with (X, Y, depth) coordinates, aligned in pixels with a returned selfie image.

Landmarks (facial key points) map with indices

See the Integration Guideline and Selfie capturing results parsing for a usage example of an observable.