Config: Settings
This page contains information about the configuration of LIQA settings.
Last updated
This page contains information about the configuration of LIQA settings.
Last updated
[DEPRECATED] For version after 5.3.0 and before 5.6.3:
[DEPRECATED] For version before 5.3.0:
[DEPRECATED] For versions before 5.1.0:
Parameter name
Description
includeBeardArea?: boolean
This parameter allows the illumination estimation on the jaw and chin areas to be switched on/off. It is recommended to setincludeBeardArea: true if you allow/expect users to have a beard or mustache
includeHairsArea?: boolean
This parameter allows the illumination estimation on the forehead areas to be switched on/off. It is recommended to setincludeHairsArea: true if you allow/expect users to have their forehead covered by hairs or some objects (e.g., cloth covering the head)
facePosition?: string
This parameter allows to setup the expected location of face on image. Set "close" to check that face is in range 15-25 cm from camera. Set "far" to request user to place camera at leat 35-40 cm from face. The exact distance depends on camera settings (FOV, default zoom).
showOverlay?: boolean
This parameter allows the default LIQA user interface (UI) with visual feedback about the head position to be switched on/off.
showIlluminationPoints?: boolean
This parameter allows the LIQA visual feedback about the illumination distribution of the face to be switched on/off. It is strongly recommended that this be kept on as it is quite informative.
imageFormat?: string
This parameter sets up the format and compression of the final image. These characteristics will slightly influence the time of image collection and visual quality. Simultaneously, they will have a strong impact on the final image file weight and file uploading time to the backend of your service.
The available settings are:
"png" - lossless format but the largest file weight
"jpeg-100" - no compression JPEG, medium file weight
"jpeg-75" - 25% compression JPEG, suitable file weight
"jpeg-50" - 50% compression JPEG (some compression artifacts may appear) but minimal file weight
autoSelfieCapture?: boolean
This parameter allows an auto-capturing of selfie image.
When all flags are okay, a three-second timer is started. LIQA start showing an overlay with a countdown instead of the face points. At the end of the timer, LIQA takes a selfie by itself.
predictLandmarks?: boolean
This parameter allows landmarks (facial key points) prediction on the resulting selfie image.
This parameter allows to choose what cameras should LIQA use: frontal (selfie) or back (portrait). The available settings are:
"user" - (default) frontal camera mode;
"environment" - back camera mode with switching between them
This parameter allows to turn on and off the countdown before image is captured. When turned off, the image will be captured in ~0.5s after approval, and there will be no UI elements of a countdown.
This parameter allows defining your own timespan of the countdown before the selfie is captured. Countdown allows your user to finish all actions and improves the stability of a good-quality image.
The default countdown is 2.4 seconds
The allowed range is [0.5, 5] seconds. If set to less than 0.5 seconds, the countdown timer is set to 0.5. If set to more than 5 seconds, the countdown timer is set to 5 seconds.
Currently under development, not available now.
envMode?: string
not available before 5.3.0
useCountdown?: boolean
not available before 5.6.3
countdownMaxTimeSeconds?: float
not available before 5.6.3