ScanBarCode
Definition:
ScanBarCode(timeout, reserved)
Description:
Scan a bar code or Quick Response (QR) Code.
Platforms:
All
Parameters:
timeout - required
On the Android Platform this parameter allows you to specify a timeout in seconds to wait for a response.
On the Apple, Windows Desktop and Windows Universal Platforms you must specify a value here but the value entered is ignored. On Apple and Windows Universal Platforms there is no timeout. On the Windows Desktop Platform the timeout is fixed at 30 seconds.
reserved - required
Must be an empty string, "".
Note, however, that if you experience problems with scanning bar codes or reading QR codes on iOS devices, you can try setting this parameter to "ZXingVer2" instead.
Returns:
String containing the bar code read or empty string, "", if scan failed.
Notes:
The device must have an internal camera or web cam which will be used to scan the bar code or Quick Response code.
Android Platform
On Android devices, this Method requires the free ZXing bar code scanner software available from Google Play. If this software isn't already installed, you will be directed to the Google Play store to download it.
When this Method is called the scanning software will automatically be loaded. This uses the device's camera and displays a rectangle in the middle of the screen with a red line through the middle. Position the red line over the code keeping it within the rectangle and wait for the software to indicate it has read the code successfully.
iOS Platform
On iOS devices, free ZXing bar code scanner software is included when you install either the standard Digitise Apps Client or a Standalone App. This software is used to read the bar code or QR code.
When this Method is called, the scanning software will automatically be loaded. This uses the device's camera and displays a rectangle in the middle of the screen with a red line through the middle. Position the red line over the code keeping it within the rectangle and wait for the software to indicate it has read the code successfully.
Windows Desktop Platform
On Windows devices no additional software is required. The device's camera will be loaded automatically and the user points the camera at the code. You may need to adjust the distance between the device and the code to ensure the code is in focus within the device's camera window. If the code can be read, the code will be displayed and the user will be asked to confirm that it has been read correctly.