Barcode scanner library for Android, based on the ZXing decoder
Barcode scanning library for Android, using ZXing for decoding.
The project is loosely based on the ZXing Android Barcode Scanner application, but is not affiliated with the official ZXing project.
Features:
A sample application is available in Releases.
By default, Android SDK 24+ is required because of
zxing:core3.4.0. To support SDK 14+, see Older SDK versions.
From version 4.x, only Android SDK 24+ is supported by default, and androidx is required.
Add the following to your
build.gradlefile:
repositories { mavenCentral() }dependencies { implementation 'com.journeyapps:zxing-android-embedded:4.2.0' implementation 'androidx.appcompat:appcompat:1.0.2' }
android { buildToolsVersion '28.0.3' // Older versions may give compile errors }
For Android SDK versions < 24, you can downgrade
zxing:coreto 3.3.0 or earlier for Android 14+ support:
repositories { mavenCentral() }dependencies { implementation('com.journeyapps:zxing-android-embedded:4.2.0') { transitive = false } implementation 'androidx.appcompat:appcompat:1.0.2' implementation 'com.google.zxing:core:3.3.0' }
android { buildToolsVersion '28.0.3' }
You'll also need this in your Android manifest:
No guarantees are made on support for older SDK versions - you'll have to test to make sure it's compatible.
Hardware acceleration is required since TextureView is used.
Make sure it is enabled in your manifest file:
Launch the intent with the default options: ``
java new IntentIntegrator(this).initiateScan(); //this` is the current Activity
// Get the results: @Override protected void onActivityResult(int requestCode, int resultCode, Intent data) { IntentResult result = IntentIntegrator.parseActivityResult(requestCode, resultCode, data); if(result != null) { if(result.getContents() == null) { Toast.makeText(this, "Cancelled", Toast.LENGTHLONG).show(); } else { Toast.makeText(this, "Scanned: " + result.getContents(), Toast.LENGTHLONG).show(); } } else { super.onActivityResult(requestCode, resultCode, data); } } ```
Use from a Fragment: ``
java IntentIntegrator.forFragment(this).initiateScan(); //this` is the current Fragment
// If you're using the support library, use IntentIntegrator.forSupportFragment(this) instead. ```
Customize options:
java IntentIntegrator integrator = new IntentIntegrator(this); integrator.setDesiredBarcodeFormats(IntentIntegrator.ONE_D_CODE_TYPES); integrator.setPrompt("Scan a barcode"); integrator.setCameraId(0); // Use a specific camera of the device integrator.setBeepEnabled(false); integrator.setBarcodeImageEnabled(true); integrator.initiateScan();
See IntentIntegrator for more options.
While this is not the primary purpose of this library, it does include basic support for generating some barcode types:
try { BarcodeEncoder barcodeEncoder = new BarcodeEncoder(); Bitmap bitmap = barcodeEncoder.encodeBitmap("content", BarcodeFormat.QR_CODE, 400, 400); ImageView imageViewQrCode = (ImageView) findViewById(R.id.qrCode); imageViewQrCode.setImageBitmap(bitmap); } catch(Exception e) {}
No customization of the image is currently supported, including changing colors or padding. If you require more customization, copy and modify the source for the encoder.
To change the orientation, specify the orientation in your
AndroidManifest.xmland let the
ManifestMergerto update the Activity's definition.
Sample:
IntentIntegrator integrator = new IntentIntegrator(this); integrator.setOrientationLocked(false); integrator.initiateScan();
See EMBEDDING.
For more advanced options, look at the Sample Application, and browse the source code of the library.
This is considered advanced usage, and is not well-documented or supported.
The camera permission is required for barcode scanning to function. It is automatically included as part of the library. On Android 6 it is requested at runtime when the barcode scanner is first opened.
When using BarcodeView directly (instead of via IntentIntegrator / CaptureActivity), you have to request the permission manually before calling
BarcodeView#resume(), otherwise the camera will fail to open.
./gradlew assemble
To deploy the artifacts the your local Maven repository:
./gradlew publishToMavenLocal
You can then use your local version by specifying in your
build.gradlefile:
repositories { mavenLocal() }
JourneyApps - Creating business solutions with mobile apps. Fast.
Licensed under the Apache License 2.0
Copyright (C) 2012-2018 ZXing authors, Journey MobileLicensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.