Manage sensor, engine, and store adapters

BioClient.Web provides biometric capabilities through its sensors, engines, and stores.

  • A biometric sensor is a capture device, which captures a biometric sample, such as a fingerprint reader or camera to capture a facial image.
  • A biometric engine is a software library, which extracts biometric features from biometric samples, and which compares features with each other, to establish the identity of a person.
  • A biometric store is a software product, which stores identities and their biometric samples and features

BioClient configuration allows multiple sensor, engine, and store adapters to be present in configuration and to be used, but only one adapter per adapter type can be the default, current adapter.

BioClient.Web offers these verbs to manage adapters and their configuration:

get-info

This method returns information about the current adapter of a given adapter type.

Usage

Call the Javascript method bioClient.get_info(). This method is defined bioclient-plugin.js and calls build_get_info to build the BioClient.Web command, and calls got_info to process the response. See The BioClient Javascript plugin for information on how to use and customise the BioClient Javascript plugin.

Event handlers

The JS method bc_addButtonEvents defines event handlers for this method for all buttons and anchors of class get-info. It is recommended to use these event handlers.

Input parameters

Parameter Type Value Remark
command string get-info The command to be executed.
adapter AdapterTypes The adapter type.
infotype string sensor engine store Obsolete. Represents the adapter type.
name string The unique name of the identity to be verified.
type BiometricType The biometric type of features selected for verification, or captured before verification.
subtype BiometricSubtype The biometric subtype of features selected for verification, or captured before verification.
featureClass int? The class of features to extract, or to select from the current record. If null, all features are selected.
featureOptions string Options used by the feature extractor.

Output parameters

Parameter Type Value Remark
command string get-info The command which was executed.
status string Success The success or failure status.
adapter AdapterTypes The adapter type.
infotype string sensor engine store The adapter type. Obsolete.
unique string The unique name of the currently selected adapter.
info string The unique name of the currently selected adapter. Obsolete.

get-standard-property

This method returns the value of a standard, built-in adapter property.

Usage

Call the Javascript method bioClient.get_standard_property(). This method is defined bioclient-plugin.js and calls build_get_standard_property to build the BioClient.Web command, and calls got_standard_property to process the response. See The BioClient Javascript plugin for information on how to use and customise the BioClient Javascript plugin.

Event handlers

The JS method bc_addButtonEvents defines event handlers for this method for all buttons and anchors of class get-standard-property. It is recommended to use these event handlers.

Input parameters

Parameter Type Value Remark
command string get-standard-property The command to be executed.
adapter AdapterTypes The adapter type.
property string sensor-timeout etc The name of the standard property to be retrieved.

Output parameters

Parameter Type Value Remark
command string get-standard-property The command which was executed.
status string Success The success or failure status.
adapter AdapterTypes The adapter type.
property string sensor-timeout etc The name of the standard property retrieved.
value string The value of the standard property retrieved.

get-custom-property

This method returns the value of a custom, adapter-specific adapter property.

Usage

Call the Javascript method bioClient.get_custom_property(). This method is defined bioclient-plugin.js and calls build_get_custom_property to build the BioClient.Web command, and calls got_custom_property to process the response. See The BioClient Javascript plugin for information on how to use and customise the BioClient Javascript plugin.

Event handlers

The JS method bc_addButtonEvents defines event handlers for this method for all buttons and anchors of class get-custom-property. It is recommended to use these event handlers.

Input parameters

Parameter Type Value Remark
command string get-custom-property The command to be executed.
adapter AdapterTypes The adapter type.
property string The name of the custom property to be retrieved.

Output parameters

Parameter Type Value Remark
command string get-custom-property The command which was executed.
status string Success The success or failure status.
adapter AdapterTypes The adapter type.
property string The name of the custom property retrieved.
value string The value of the custom property retrieved.

controller-reload

This method re-reloads the biometric controller. It reloads adapters from configuration.

Usage

Call the Javascript method bioClient.controller_reload(). This method is defined bioclient-plugin.js and calls build_controller_reload to build the BioClient.Web command, and calls controller_reloaded to process the response. See The BioClient Javascript plugin for information on how to use and customise the BioClient Javascript plugin.

Event handlers

The JS method bc_addButtonEvents defines event handlers for this method for all buttons and anchors of class controller-reload. It is recommended to use these event handlers.

Input parameters

Parameter Type Value Remark
command string controller-reload The command to be executed.

Output parameters

Parameter Type Value Remark
command string controller-reload The command which was executed.
status string Success The success or failure status.

controller-reinit

This method re-initialises the biometric controller. It removes the current biometric controller, instantiates, initialises, and loads a new biometric controller. This sets the ciometric controller to its initial state.

Usage

Call the Javascript method bioClient.controller_reinit(). This method is defined bioclient-plugin.js and calls build_controller_reinit to build the BioClient.Web command, and calls controller_reinited to process the response. See The BioClient Javascript plugin for information on how to use and customise the BioClient Javascript plugin.

Event handlers

The JS method bc_addButtonEvents defines event handlers for this method for all buttons and anchors of class controller-reinit. It is recommended to use these event handlers.

Input parameters

Parameter Type Value Remark
command string controller-reinit The command to be executed.

Output parameters

Parameter Type Value Remark
command string controller-reinit The command which was executed.
status string Success The success or failure status.

get-adapters

This method returns a sequence of available adapters for the adapter type.

Usage

Call the Javascript method bioClient.get_adapters(). This method is defined bioclient-plugin.js and calls build_get_adapters to build the BioClient.Web command, and calls got_adapters to process the response. See The BioClient Javascript plugin for information on how to use and customise the BioClient Javascript plugin.

Event handlers

The JS method bc_addButtonEvents defines event handlers for this method for all buttons and anchors of class get-adapters. It is recommended to use these event handlers.

Remarks

This method returns all available adapters of the requested adapter type. The type is returned, but uses the friendly adapter type name in lower case. The current, default adapter is not changed.

Input parameters

Parameter Type Value Remark
command string get-adapters The command to be executed.
adapter AdapterTypes Sensor, Store The adapter type.

Output parameters

Parameter Type Value Remark
command string get-adapters The command which was executed.
status string Success The success or failure status.
adapter AdapterTypes Sensor, Store The adapter type.
type AdapterTypes The adapter type. Obsolete.
uniques [ string ] An array of unique adapter names.

select-adapter

This method selects an adapter as default adapter for the adapter type.

Usage

Call the Javascript method bioClient.select_adapter(). This method is defined bioclient-plugin.js and calls build_select_adapter to build the BioClient.Web command, and calls selected_adapter to process the response. See The BioClient Javascript plugin for information on how to use and customise the BioClient Javascript plugin.

Event handlers

The JS method bc_addButtonEvents defines event handlers for this method for all buttons and anchors of class select-adapter. It is recommended to use these event handlers.

Remarks

This method sets the current, default adapters of the requested adapter type.

Input parameters

Parameter Type Value Remark
command string select-adapter The command to be executed.
adapter AdapterTypes Sensor, Store The adapter type.
unique string The unique name of the adapter to set as the new current, default adapter.

Output parameters

Parameter Type Value Remark
command string select-adapter The command which was executed.
status string Success The success or failure status.
adapter AdapterTypes Sensor, Store The adapter type.
type AdapterTypes The adapter type. Obsolete.
unique string The unique adapter name of the adapter which was set as the new current, default adapter.

sensor-dispose

This method disposes of the current sensor. This method can be used to free up a sensor for another application, depending on the implementation of the sensor adapter.

Usage

Call the Javascript method bioClient.sensor_dispose(). This method is defined bioclient-plugin.js and calls build_sensor_dispose to build the BioClient.Web command, and calls sensor_disposed to process the response. See The BioClient Javascript plugin for information on how to use and customise the BioClient Javascript plugin.

Event handlers

No default event handlers are defined for this command.

Input parameters

Parameter Type Value Remark
command string sensor-dispose The command to be executed.

Output parameters

Parameter Type Value Remark
command string sensor-dispose The command which was executed.
status string Success The success or failure status.

sensor-reinstate

This method reinstantes the last sensor.

Usage

Call the Javascript method bioClient.sensor_reinstate(). This method is defined bioclient-plugin.js and calls build_sensor_reinstate to build the BioClient.Web command, and calls sensor_reinstated to process the response. See The BioClient Javascript plugin for information on how to use and customise the BioClient Javascript plugin.

Event handlers

No default event handlers are defined for this command.

Input parameters

Parameter Type Value Remark
command string sensor-reinstate The command to be executed.

Output parameters

Parameter Type Value Remark
command string sensor-reinstate The command which was executed.
status string Success The success or failure status.

References