Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision Next revision Both sides next revision | ||
|
en:configuration_api [2020/02/19 14:35] yjjung [BS2FaceConfig] |
en:configuration_api [2020/04/29 14:12] sypark1 |
||
|---|---|---|---|
| Line 123: | Line 123: | ||
| ==== BS2SystemConfig ==== | ==== BS2SystemConfig ==== | ||
| - | [[BS2_SetSystemConfig]] must be called after calling [[BS2_GetSystemConfig]] and completing necessary settings except for tamperOn. \\ | ||
| <code cpp> | <code cpp> | ||
| typedef struct { | typedef struct { | ||
| Line 153: | Line 152: | ||
| Reserved variable. \\ \\ | Reserved variable. \\ \\ | ||
| **5. //deviceLocked//** \\ | **5. //deviceLocked//** \\ | ||
| - | Decides whether to show lock screen in stand-by mode. \\ \\ | + | Indicates the current locked state of the device. (Read only filed) \\ \\ |
| **6. //useInterphone//** \\ | **6. //useInterphone//** \\ | ||
| Decides whether to use intercom. \\ \\ | Decides whether to use intercom. \\ \\ | ||
| Line 1577: | Line 1576: | ||
| } BS2FaceConfig; | } BS2FaceConfig; | ||
| </code> | </code> | ||
| - | 1. **//securityLevel//** \\ | + | **1. //securityLevel//** \\ |
| Face authentication security level. This is used across the system. . \\ | Face authentication security level. This is used across the system. . \\ | ||
| <WRAP group 50%> | <WRAP group 50%> | ||
| Line 1585: | Line 1584: | ||
| |2 |Most highly secure | | |2 |Most highly secure | | ||
| </WRAP> | </WRAP> | ||
| - | 2. **//lightCondition//** \\ | + | **2. //lightCondition//** \\ |
| Configuration of the light condition.\\ | Configuration of the light condition.\\ | ||
| <WRAP group 50%> | <WRAP group 50%> | ||
| Line 1593: | Line 1592: | ||
| |2 |Automatic | | |2 |Automatic | | ||
| </WRAP> | </WRAP> | ||
| - | 3. **//enrollThreshold//** \\ | + | **3. //enrollThreshold//** \\ |
| - | Threshold of face enrollment.\\ | + | Threshold of face enrollment. It determines how much movement of pose is allowed when enrolling the face. \\ |
| <WRAP group 50%> | <WRAP group 50%> | ||
| ^Value ^Description ^ | ^Value ^Description ^ | ||
| - | |0 |THRESHOLD_0 | | + | |0 |THRESHOLD_0 (Most strict) | |
| |1 |THRESHOLD_1 | | |1 |THRESHOLD_1 | | ||
| |2 |THRESHOLD_2 | | |2 |THRESHOLD_2 | | ||
| Line 1606: | Line 1605: | ||
| |7 |THRESHOLD_7 | | |7 |THRESHOLD_7 | | ||
| |8 |THRESHOLD_8 | | |8 |THRESHOLD_8 | | ||
| - | |9 |THRESHOLD_9 | | + | |9 |THRESHOLD_9 (Least strict) | |
| </WRAP> | </WRAP> | ||
| - | 4. **//detectSensitivity//** \\ | + | **4. //detectSensitivity//** \\ |
| Configuration of sensitivity on detecting the face. \\ | Configuration of sensitivity on detecting the face. \\ | ||
| <WRAP group 50%> | <WRAP group 50%> | ||
| Line 1617: | Line 1616: | ||
| |3 |High | | |3 |High | | ||
| </WRAP> | </WRAP> | ||
| - | 5. **//enrollTimeout//** \\ | + | **5. //enrollTimeout//** \\ |
| Timeout period of face scanning which is 60 seconds by default.\\ \\ | Timeout period of face scanning which is 60 seconds by default.\\ \\ | ||
| - | 6. **//lfdLevel//** \\ | + | **6. //lfdLevel//** \\ |
| [+ V2.6.3] Configuration for the LFD(Live Face Detection - fake face detection) sensitivity. \\ | [+ V2.6.3] Configuration for the LFD(Live Face Detection - fake face detection) sensitivity. \\ | ||
| <WRAP group 50%> | <WRAP group 50%> | ||
| Line 1628: | Line 1627: | ||
| |3 |Most Strict | | |3 |Most Strict | | ||
| </WRAP> | </WRAP> | ||
| - | 7. **//quickEnrollment//** \\ | + | **7. //quickEnrollment//** \\ |
| [+ V2.6.3] Quick face enrollment process. \\ | [+ V2.6.3] Quick face enrollment process. \\ | ||
| True - Face enrollment process with a single step.\\ | True - Face enrollment process with a single step.\\ | ||
| False - Face enrollment rpcoess with 3 steps.\\ | False - Face enrollment rpcoess with 3 steps.\\ | ||
| Please use false if you want to enroll with a high quality of face templates. \\ \\ | Please use false if you want to enroll with a high quality of face templates. \\ \\ | ||
| - | 8. //previewOption// \\ | + | **8. //previewOption//** \\ |
| [+ V2.6.3] IR camera preview option when you authenticate with face. \\ | [+ V2.6.3] IR camera preview option when you authenticate with face. \\ | ||
| + | Only used to ''FaceLite''. \\ | ||
| <WRAP group 50%> | <WRAP group 50%> | ||
| ^Value ^Description ^ | ^Value ^Description ^ | ||
| Line 1641: | Line 1641: | ||
| |2 |Preview of all stages on authentication | | |2 |Preview of all stages on authentication | | ||
| </WRAP> | </WRAP> | ||
| - | 9. //checkDuplicate// \\ | + | **9. //checkDuplicate//** \\ |
| [+ V2.6.4] Check whether the scanned face is duplicated in the device. \\ \\ | [+ V2.6.4] Check whether the scanned face is duplicated in the device. \\ \\ | ||
| - | 10. //reserved// \\ | + | **10. //reserved//** \\ |
| Reserved space. \\ \\ | Reserved space. \\ \\ | ||
| - | 11. //reserved2// \\ | + | **11. //reserved2//** \\ |
| Reserved space. \\ \\ | Reserved space. \\ \\ | ||
| ==== BS2Rs485ConfigEX ==== | ==== BS2Rs485ConfigEX ==== | ||