Skip to content

Commit e6d7373

Browse files
authored
Update README.md
1 parent 71c478f commit e6d7373

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

qractivity/README.md

+25
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,12 @@ Say hi to QRActivity! A customizable, pre-built activity ready to launch and rea
1010
* **Fast:** You can expect it to lauch, read the QR and return the result within a second
1111
* **Customizable:** Restrict image picker usage, autofocus interval, toggle fullscreen and more
1212

13+
## Demo Video
14+
Click on the thumbnail below to watch demo video
15+
16+
<a href="https://youtu.be/lKSWgqqBhls" target="_blank"><img src="../img/thumbnail-qractivity.png"
17+
alt="Loading thumbnail, please wait..." width="85%" border="10" /></a>
18+
1319
## Installation
1420

1521
### Gradle
@@ -84,6 +90,25 @@ startActivityForResult(
8490
}
8591
```
8692

93+
## Methods and functions
94+
95+
### Building
96+
97+
```java
98+
setImagePickerEnabled(boolean imagePickerEnabled) // enables/disables the use of image picker for reading QRs from image files
99+
setFullScreen(boolean fullScreen) // hides the status bar in QRActivity if true
100+
setAutoFocusInterval(long interval) // sets the auto focus interval in QR scanner
101+
setFocusOnTouchEnabled(boolean focusOnTouch) // decides if QR scanner should focus on tap (may not work on all devices)
102+
build() // builds the QR scanner and returns as an Intent (required)
103+
```
104+
105+
### Getting the result
106+
107+
```java
108+
String qrData = data.getStringExtra("qrData"); // getting scanned QR data
109+
String error = data.getStringExtra("error"); // getting the error message (in case one occurs)
110+
```
111+
87112
## Release History
88113

89114
* 0.1.0

0 commit comments

Comments
 (0)