ravi8x / Barcode-Reader

Android barcode reader using google vision library
BSD 3-Clause "New" or "Revised" License
294 stars 183 forks source link
android android-library androidhive barcode-scanner barcodes google-vision-api

Barcode Reader - Google Mobile Vision

Android Barcode Reader library using Google Mobile Vision. This library is built on top of google mobile vision sample adding improvements and fixing few bugs.

Download Example

Demo

How to Use

  1. Include the barcode reader dependency in app's build.gradle

    dependencies {
    // google mobile vision
    implementation 'com.google.android.gms:play-services-vision:11.0.2'
    
    // barcode reader
    implementation 'info.androidhive:barcode-reader:1.1.5'
    }
  2. Add the barcode reader fragment to your activity

    <fragment
        android:id="@+id/barcode_fragment"
        android:name="info.androidhive.barcode.BarcodeReader"
        android:layout_width="match_parent"
        android:layout_height="match_parent"
        app:auto_focus="true"
        app:use_flash="false" />
  3. Implement your activity from BarcodeReader.BarcodeReaderListener and override the necessary methods.

    public class MainActivity extends AppCompatActivity implements BarcodeReader.BarcodeReaderListener {
    
    private BarcodeReader barcodeReader;
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        barcodeReader = (BarcodeReader) getSupportFragmentManager().findFragmentById(R.id.barcode_fragment);
    }
    
    @Override
    public void onScanned(Barcode barcode) {
        // play beep sound
        barcodeReader.playBeep();
    }
    
    @Override
    public void onScannedMultiple(List<Barcode> list) {
    
    }
    
    @Override
    public void onBitmapScanned(SparseArray<Barcode> sparseArray) {
    
    }
    
    @Override
    public void onScanError(String s) {
    
    }
    
    @Override
    public void onCameraPermissionDenied() {
            Toast.makeText(getApplicationContext(), "Camera permission denied!", Toast.LENGTH_LONG).show();
    }
    }

Adding Barcode Reader in Fragment

In fragment the barcode reader can be added easily but the scanner listener barcodeReader.setListener() has to be set manually.

Check the example fragment code in BarcodeFragment.java and BarcodeFragmentTestActivity.java

https://github.com/ravi8x/Barcode-Reader/tree/master/example/src/main/java/info/androidhive/barcodereader

Adding Scanner Overlay Scanning Indicator

The overlay animation indicator displays a horizontal line animating from top to bottom. This will be useful to to show some cool animation to indicate scanning progress.

To use it, add the info.androidhive.barcode.ScannerOverlay on top of barcode reader fragment using Relative or Frame layout.

<?xml version="1.0" encoding="utf-8"?>
<RelativeLayout ...>

    <fragment
        android:id="@+id/barcode_fragment"
        android:name="info.androidhive.barcode.BarcodeReader"
        android:layout_width="match_parent"
        android:layout_height="match_parent"
        app:auto_focus="true"
        app:use_flash="false" />

    <info.androidhive.barcode.ScannerOverlay
        android:layout_width="match_parent"
        android:layout_height="match_parent"
        android:background="#44000000"
        app:line_color="#7323DC"
        app:line_speed="6"
        app:line_width="4"
        app:square_height="200"
        app:square_width="200"/>

</RelativeLayout>

Additional Options

XML attribute for Barcode Reader

auto_focus - boolean, turn on/off auto focus. Default is true

use_flash - boolean, turn on/off flash. Default is false

XML attribute for Scanner Overlay Indicator

square_width - Width of transparent square

square_height - Height of transparent square

line_color - Horizontal line color

line_speed - Horizontal line animation speed


JAVA Methods

You can play the beep sound when the barcode is scanned. This code is usually called in onScanned() callback.

@Override
    public void onScanned(final Barcode barcode) {
        Log.e(TAG, "onScanned: " + barcode.displayValue);
        barcodeReader.playBeep();
        });
    }

You can change the default beep sound by passing the file name. You beep file should be in project's assets folder.

barcodeReader.setBeepSoundFile("shutter.mp3");

The scanning can be paused by calling pauseScanning() method.

barcodeReader.pauseScanning();

The scanning can be resumed by calling resumeScanning() method.

barcodeReader.resumeScanning();

Know Issues