Scan Setup

The SDK provides your application with a list of captured finger images, a related quality assessment, and some other finger specific data. More about the data structure can be found in BcmFingerImage.

There are additional callbacks, which are listed in IBSdkFlowDelegate.

No further user interface is displayed after a successful or failed scan, and no further action is taken from the SDK side. It is your application's responsibility to implement an appropriate response to a scan.

Example

You may follow along by building your own custom scan delegate on this page, or inspect the ready-made Sample App project shipped with this documentation.

Scan Flow Delegate

Firstly, ensure that the SDK is installed and configured .

Next, implement the IBcmFlowDelegate interface. The delegate enables communication from the scan Fragment (BcmScanFragment) to your application.

A typical place to implement the delegate would be the Activity, which is responsible for presenting the Scan Fragment. You can either inherit from the SDK Scan Activity and set the flowDelegate or set the flowDelegate on the Fragment level, if you use the BcmScanFragment. See below.

Set the flowDelegate at the Scan Activity level (BcmScanActivity)

In the following, we assume that the current Activity implements IBcmFlowDelegate:

Kotlin:

class YourBcmScanActivity : BcmScanActivity(), IBcmFlowDelegate {

    /**
     * Set config take place here
     */
    init {
        flowDelegate = this
    }

}

Java:

public class YourBcmScanActivity extends BcmScanActivity implements IBcmFlowDelegate {

    // Instance initialization block

    /**
     * Set config take place here
     */ {
        setFlowDelegate(this);
    }

}

Set the flowDelegate at the Scan Fragment level (BcmScanFragment)

In the following, we assume that the current Activity (this) implements IBcmFlowDelegate:

Kotlin:

val scanFragment = BcmScanFragment(
    BcmGlobalConfig(),
    BcmScanConfig(),
    this)

supportFragmentManager.beginTransaction().replace(
    R.id.content_frame,
    scanFragment)
    .addToBackStack("BcmScan")
    .commitAllowingStateLoss()

Java:

BcmScanFragment _scanFragment=new BcmScanFragment(
    new BcmGlobalConfig(),
    new BcmScanConfig(),
    this);

    getSupportFragmentManager().beginTransaction().replace(
    R.id.content_frame,
    scanFragment)
    .addToBackStack("BcmScan")
    .commitAllowingStateLoss()

See Also

The Biocapture SDK's scan Activity and Fragment offers many customization options. For example, you may wish to add a close button to enable the user to cancel the scan, listen for additional delegate events, or modify the Fragment's look to match your brand.

  • BcmScanActivity for the Activity configuration options, including view extension options for user cancellation or opening an application menu.
  • IBcmFlowDelegate for additional delegate events.
  • Camera configuration allows you to configure camera specific parameters.
  • Branding for asset and color scheme customization.

results matching ""

    No results matching ""