4.4. The Scanner activity

The simplest way to start using enioka Scan in an activity is simply to inherit from the ScannerCompatActivity class. This class implements the ScannerClient interface and handles the scanner service bindings and life cycle. It also exposes a default UI to print scan results, status messages and some buttons to manually control the scanner device from the app.

Most of its methods are protected and can be overridden if needed. Mainly, methods from the ScannerClient interface should be replaced with your own to adapt the way scan results are handled by your application.

By default, the activity will use the default search options to initiate scanner search. There are two ways to change these options: override the getServiceInitExtras() method, and passing the search options as extras to the intent starting the activity. In case both are used, the method is applied first, then intent extras.

This page will describe attributes and methods specific to this activity, disregarding overrides. For most users, it is recommended to only change the value of attributes or interface methods, as overriding class methods may cause unexpected side-effects. For example, using a custom layout only requires changing the corresponding layout ID attributes.

4.4.1. ScannerCompatActivity attributes

boolean laserModeOnly = false

If true, the activity will not switch to using the camera, even if no other scanners are available.

boolean enableScan = true

If false, the activity will behave like a standard AppCompatActivity.

boolean goToCamera = false

If true, the activity will directly switch to using the camera. This boolean is automatically set to true if the scanner service finds no scanner after the first search.

boolean useBluetooth = true

If true, the activity will check that the application has bluetooth permissions before starting the service. This does not affect scanner search options.

int layoutIdLaser = R.layout.activity_main

The layout used by the activity when using regular scanner devices. May be replaced with your own.

HashMap<String, Integer> cameraResources = null;

The hashmap containing the IDs of the views used by the camera scanner. May be replaced with your own.

If the camera SDK is included, it will be set to a map containing the following values:

  • layout_id_camera: The ID of the layout containing the camera view. Defaults to R.layout.activity_main_alt.

  • camera_view_id: The ID of the CameraBarcodeScanView inside the layout_id_camera layout. Defaults to R.id.cameraScanView.

  • scanner_toggle_view_id: The ID of the optional ImageButton on which to press to toggle the zxing/zbar camera scan library. Defaults to R.id.scannerSwitchZxing.

  • scanner_toggle_pause_id: The ID of the optional toggle button on which to press to pause/unpause the scanner. Defaults to R.id.scannerSwitchPause.

  • card_last_scan_id: The ID of the card view that displays the last scan. Defaults to R.id.cardCameraLastScan.

  • constraint_layout_id: The ID of the constraint layout inside the camera layout. Defaults to R.id.constraintLayoutMainActivity.

  • scanner_flashlight_id: The ID of the optional ImageButton on which to press to toggle the flashlight/illumination. Defaults to R.id.scannerFlashlight.

  • scanner_bt_provider_logs: The ID of the optional ImageButton on which to press to manually access available providers logs. Defaults to R.id.scannerBtProviderLogs.

int cameraToggleId = R.id.scannerBtCamera

The ID of the optional MaterialButton on which to press to manually switch to camera mode.

int flashlightViewId = R.id.scannerFlashlight

The ID of the optional MaterialButton on which to press to toggle the flashlight/illumination.

int providerLogOpenViewId = R.id.scannerBtProviderLogs;

The ID of the optional MaterialButton on which to press to launch the manual provider logs dialog.

ManualInputFragment manualInputFragment;

An optional fragment allowing to input a value with the soft keyboard (for cases when scanners do not work).

List<ManualInputItem> autocompletionItems = new ArrayList<>()

Auto completion items for manual input (with manualInputFragment).

int threshold = 5

How many characters should be entered before auto-completion starts.

ScannerServiceApi scannerService;

The instance of the bound scanner service, can be used to access service methods but should not be replaced.

Initialized by the onStart() and onResume() methods.

boolean hasCameraScannerSdk = false;

If true, the camera SDK is included in the application.

CameraScanner cameraScannerProvider = null;

The optional instance of the camera scanner provider, is set if the camera SDK is included. Can be used to access some methods of CameraBarcodeScanViewScanner. Should not be replaced.

CameraBarcodeScanViewScanner is a simple provider-less implementation of the Scanner interface.

Initialized by the initCamera() method.

int scannerStatusCardViewId = R.id.scannerCardLastScan;

The ID of the optional card view that displays the last scan.

int providerNameText = R.id.scannerProviderText;

The ID of the optional text view that displays the name of the active provider.

int providerStatusCardViewId = R.id.scannerProviderStatusCard;

The ID of the optional card view that contains the status of the active provider.

int providerStatusText = R.id.scannerProviderStatusText;

The ID of the optional text view that displays the status of the active provider.

boolean loggingEnabled = false;

If true, the activity will log all scanner service events to the define log file.

boolean allowCameraFallback = false;

If true, the activity will switch to camera mode if no scanner is found after the first search.

int openLinkId = R.id.openLink;

The ID of the of the optional button on which to press to open a link when a QRCode URL is scanned.

Set<BarcodeType> enabledSymbologies = null;

The set of enabled barcode symbologies, send through the intent extras. If not set, the default symbologies will be used.

4.4.2. ScannerCompatActivity methods

getServiceInitExtras() → Bundle
Returns:

The search options that will be used when starting the service. These options may be overriden by intent extras when launching the activity.

initCamera() → void

Switches the activity to camera mode. After this method is called, goToCamera is set to true.

buildBarcodeText(String barcodeType, String barcodeData) → String

Builds the text to display in the last scan card. By default, it will display the barcode type and data, with an HTML formatting.

Returns:

The formatted text.

anyScannerSupportsIllumination() → boolean

Checks whether any available scanner supports Illumination.

anyScannerHasIlluminationOn() → boolean

Checks whether any available scanner has Illumination toggled on.

displayOpenLinkButton(String url) → void

Displays and binds the open link button to the given URL.

writeResultToLog(Barcode data) → void

Writes the barcode data to the log file, if log path file is defined.

See also