Skip to content

Repository files navigation

Code Scanner

DownloadAndroid ArsenalAPICodacy Badge

Code scanner library for Android, based on ZXing

Features

  • Auto focus and flash light control
  • Portrait and landscape screen orientations
  • Back and front facing cameras
  • Customizable viewfinder
  • Kotlin friendly
  • Touch focus

Supported formats

1D product1D industrial2D
UPC-ACode 39QR Code
UPC-ECode 93Data Matrix
EAN-8Code 128Aztec
EAN-13CodabarPDF 417
ITFMaxiCode
RSS-14
RSS-Expanded

Usage (sample)

Add dependency:

dependencies {
implementation 'com.budiyev.android:code-scanner:2.1.0'
}

Add camera permission to AndroidManifest.xml (Don't forget about dynamic permissions on API >= 23):

<uses-permissionandroid:name="android.permission.CAMERA"/>

Define a view in your layout file:

<?xml version="1.0" encoding="utf-8"?>
<FrameLayoutxmlns:android="http://schemas.android.com/apk/res/android"xmlns:app="http://schemas.android.com/apk/res-auto"android:layout_width="match_parent"android:layout_height="match_parent">
<com.budiyev.android.codescanner.CodeScannerView
android:id="@+id/scanner_view"android:layout_width="match_parent"android:layout_height="match_parent"app:autoFocusButtonColor="@android:color/white"app:autoFocusButtonVisible="true"app:flashButtonColor="@android:color/white"app:flashButtonVisible="true"app:frameColor="@android:color/white"app:frameCornersSize="50dp"app:frameCornersRadius="0dp"app:frameAspectRatioWidth="1"app:frameAspectRatioHeight="1"app:frameSize="0.75"app:frameThickness="2dp"app:maskColor="#77000000"/>
</FrameLayout>

And add following code to your activity:

Kotlin

classMainActivity : AppCompatActivity() {
privatelateinitvar codeScanner:CodeScanneroverridefunonCreate(savedInstanceState:Bundle?) {
super.onCreate(savedInstanceState)
setContentView(R.layout.activity_main)
val scannerView = findViewById<CodeScannerView>(R.id.scanner_view)
codeScanner =CodeScanner(this, scannerView)
// Parameters (default values)
codeScanner.camera =CodeScanner.CAMERA_BACK// or CAMERA_FRONT or specific camera id
codeScanner.formats =CodeScanner.ALL_FORMATS// list of type BarcodeFormat,// ex. listOf(BarcodeFormat.QR_CODE)
codeScanner.autoFocusMode =AutoFocusMode.SAFE// or CONTINUOUS
codeScanner.scanMode =ScanMode.SINGLE// or CONTINUOUS or PREVIEW
codeScanner.isAutoFocusEnabled =true// Whether to enable auto focus or not
codeScanner.isFlashEnabled =false// Whether to enable flash or not// Callbacks
codeScanner.decodeCallback =DecodeCallback {
runOnUiThread {
Toast.makeText(this, "Scan result: ${it.text}", Toast.LENGTH_LONG).show()
}
}
codeScanner.errorCallback =ErrorCallback { // or ErrorCallback.SUPPRESS
runOnUiThread {
Toast.makeText(this, "Camera initialization error: ${it.message}",
Toast.LENGTH_LONG).show()
}
}
scannerView.setOnClickListener {
codeScanner.startPreview()
}
}
overridefunonResume() {
super.onResume()
codeScanner.startPreview()
}
overridefunonPause() {
codeScanner.releaseResources()
super.onPause()
}
}

Java

publicclassMainActivityextendsAppCompatActivity {
privateCodeScannermCodeScanner;
@OverrideprotectedvoidonCreate(BundlesavedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
CodeScannerViewscannerView = findViewById(R.id.scanner_view);
mCodeScanner = newCodeScanner(this, scannerView);
mCodeScanner.setDecodeCallback(newDecodeCallback() {
@OverridepublicvoidonDecoded(@NonNullfinalResultresult) {
runOnUiThread(newRunnable() {
@Overridepublicvoidrun() {
Toast.makeText(MainActivity.this, result.getText(), Toast.LENGTH_SHORT).show();
}
});
}
});
scannerView.setOnClickListener(newView.OnClickListener() {
@OverridepublicvoidonClick(Viewview) {
mCodeScanner.startPreview();
}
}); }
@OverrideprotectedvoidonResume() {
super.onResume();
mCodeScanner.startPreview();
}
@OverrideprotectedvoidonPause() {
mCodeScanner.releaseResources();
super.onPause();
}
}

or fragment:

Kotlin

classMainFragment : Fragment() {
privatelateinitvar codeScanner:CodeScanneroverridefunonCreateView(inflater:LayoutInflater, container:ViewGroup?, savedInstanceState:Bundle?): View? {
return inflater.inflate(R.layout.fragment_main, container, false)
}
overridefunonViewCreated(view:View, savedInstanceState:Bundle?) {
val scannerView = view.findViewById<CodeScannerView>(R.id.scanner_view)
val activity = requireActivity()
codeScanner =CodeScanner(activity, scannerView)
codeScanner.decodeCallback =DecodeCallback {
activity.runOnUiThread {
Toast.makeText(activity, it.text, Toast.LENGTH_LONG).show()
}
}
scannerView.setOnClickListener {
codeScanner.startPreview()
}
}
overridefunonResume() {
super.onResume()
codeScanner.startPreview()
}
overridefunonPause() {
codeScanner.releaseResources()
super.onPause()
}
}

Java

publicclassMainFragmentextendsFragment {
privateCodeScannermCodeScanner;
@Nullable@OverridepublicViewonCreateView(LayoutInflaterinflater, @NullableViewGroupcontainer,
@NullableBundlesavedInstanceState) {
finalActivityactivity = getActivity();
Viewroot = inflater.inflate(R.layout.fragment_main, container, false);
CodeScannerViewscannerView = root.findViewById(R.id.scanner_view);
mCodeScanner = newCodeScanner(activity, scannerView);
mCodeScanner.setDecodeCallback(newDecodeCallback() {
@OverridepublicvoidonDecoded(@NonNullfinalResultresult) {
activity.runOnUiThread(newRunnable() {
@Overridepublicvoidrun() {
Toast.makeText(activity, result.getText(), Toast.LENGTH_SHORT).show();
}
});
}
});
scannerView.setOnClickListener(newView.OnClickListener() {
@OverridepublicvoidonClick(Viewview) {
mCodeScanner.startPreview();
}
}); returnroot;
}
@OverridepublicvoidonResume() {
super.onResume();
mCodeScanner.startPreview();
}
@OverridepublicvoidonPause() {
mCodeScanner.releaseResources();
super.onPause();
}
}

Preview

Preview screenshot

About

Code scanner library for Android, based on ZXing

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages