Specs
Badges/Featured In
Show some
❤️
Android library which makes use of Google's Mobile Vision API to enable reading QR Code.
The library is built for simplicity and ease of use. It not only eliminates most boilerplate code for dealing with setting up QR Code reading , but also provides an easy and simple API to retrieve information from QR Code quickly.
Requires Google Play Services
Changelog
Starting with 1.0.4, Changes exist in the releases tab.
#Integration QREader is available in the Jcenter, so getting it as simple as adding it as a dependency
-
For gradle version < 4.0
compile 'com.github.nisrulz:qreader:{latest version}' -
For gradle 4.0+
implementation 'com.github.nisrulz:qreader:{latest version}'
where {latest version} corresponds to published version in 
Usage Docs
Steps
- Add a
SurfaceViewto your layout
<SurfaceView android:id="@+id/camera_view" android:layout_width="match_parent" android:layout_height="match_parent" android:layout_above="@+id/info" />
- Setup
SurfaceViewandQREaderinonCreate()
// QREader
private SurfaceView mySurfaceView;
private QREader qrEader;
..
@Override
protected void onCreate(final Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
..
..
// Setup SurfaceView
// -----------------
mySurfaceView = (SurfaceView) findViewById(R.id.camera_view);
// Init QREader
// ------------
qrEader = new QREader.Builder(this, mySurfaceView, new QRDataListener() {
@Override
public void onDetected(final String data) {
Log.d("QREader", "Value : " + data);
text.post(new Runnable() {
@Override
public void run() {
text.setText(data);
}
});
}
}).facing(QREader.BACK_CAM)
.enableAutofocus(true)
.height(mySurfaceView.getHeight())
.width(mySurfaceView.getWidth())
.build();
}
- Initialize and Start in
onResume()
@Override
protected void onResume() {
super.onResume();
// Init and Start with SurfaceView
// -------------------------------
qrEader.initAndStart(mySurfaceView);
}
- Cleanup in
onPause()
@Override
protected void onPause() {
super.onPause();
// Cleanup in onPause()
// --------------------
qrEader.releaseAndCleanup();
}
- Some provided utility functions which you can use
-
To check if the camera is running
boolean isCameraRunning = qrEader.isCameraRunning()
-
To stop
QREaderqrEader.stop(); -
To start
QREaderqrEader.start();
Check the included sample app for a working example.
Pull Requests
I welcome and encourage all pull requests. It usually will take me within 24-48 hours to respond to any issue or request. Here are some basic rules to follow to ensure timely addition of your request:
- Match coding style (braces, spacing, etc.) This is best achieved using CMD+Option+L (Reformat code) on Mac (not sure for Windows) with Android Studio defaults.
- If its a feature, bugfix, or anything please only change code to what you specify.
- Please keep PR titles easy to read and descriptive of changes, this will make them easier to merge :)
- Pull requests must be made against
developbranch. Any other branch (unless specified by the maintainers) will get rejected. - Check for existing issues first, before filing an issue.
- Have fun!
Created & Maintained By
If you found this library helpful or you learned something from the source code and want to thank me, consider buying me a cup of
☕
- PayPal
- Bitcoin Address: 13PjuJcfVW2Ad81fawqwLtku4bZLv1AxCL
3 Dec 6, 2022
1.4k Dec 31, 2022
0 Mar 14, 2022
12 Oct 8, 2022
62 Dec 29, 2022
251 Jan 6, 2023
5 Dec 26, 2022
389 Sep 25, 2022
9 Nov 2, 2022
181 Dec 28, 2022
1 Oct 15, 2022
10 Nov 27, 2022
59 Jan 4, 2023
17 Dec 29, 2022
3 Nov 14, 2022
2 Apr 28, 2022
17 Dec 23, 2022
5 Dec 7, 2022
2 Apr 22, 2022