public final class BarcodeReader extends Object implements Parcelable
Any number of BarcodeReader
objects can be created, and
each will maintain its own properties and will operate independently from
other BarcodeReader
objects.
Permission required: "com.honeywell.decode.permission.DECODE"
BarcodeReader
objects may exist, only one can
hold a claim to the scanner at a time. The last BarcodeReader
to call claim()
will receive the claim, causing the previous owner's
claim to be released. release()
can be called to voluntarily release
the scanner claim. When no BarcodeReader
holds a scanner claim, the
application profile properties will be applied. Therefore, voluntarily
releasing the scanner is required if the behavior of application profiles
is desired.
When the BarcodeReader
holds the scanner claim, you can control
the scanner via aim(boolean)
, light(boolean)
and
decode(boolean)
, and can receive bar code data asynchronously.
If the BarcodeReader
does not hold the scanner claim,
ScannerNotClaimedException
will be thrown.
Whether or not the BarcodeReader
holds the scanner claim, you may
get and set BarcodeReader
properties.
Note, however, that properties will only be applied when the scanner is claimed.
If properties are set prior to calling claim()
, those properties will be
applied as soon as claim()
is called.
BarcodeReadEvent
when a bar code label has been
successfully decoded. This event will contain all information pertaining to this
successful decode.
In order to receive BarcodeReadEvent
notifications, the client must call
addBarcodeListener(BarcodeListener)
. The supplied
BarcodeReader.BarcodeListener
will be notified each time an event occurs,
by calling BarcodeReader.BarcodeListener.onBarcodeEvent(BarcodeReadEvent)
.
BarcodeReader.BarcodeListener.onBarcodeEvent(BarcodeReadEvent)
will be
called on a non-UI thread, which will not be able to interact with your application's UI
components. On the Android platform, Activity
can be used post any desired UI updates that need to be made on the UI thread from the
callback thread.
TriggerStateChangeEvent
when the scan trigger has
been pressed or released. This event will contain all information pertaining to this
trigger state change.
Important Note: TriggerStateChangeEvent
notifications only occurs when
PROPERTY_TRIGGER_CONTROL_MODE
has been set to
TRIGGER_CONTROL_MODE_CLIENT_CONTROL
via
setProperty(String, String)
In order to receive these event notifications, the client must call
addTriggerListener(TriggerListener)
. The supplied
BarcodeReader.TriggerListener
will be notified each time an event occurs,
by calling BarcodeReader.TriggerListener.onTriggerEvent(TriggerStateChangeEvent)
.
BarcodeReader.TriggerListener.onTriggerEvent(TriggerStateChangeEvent)
will
be called on a non-UI thread, which will not be able to interact with your application's UI
components. On the Android platform, Activity
can be used post any desired UI updates that need to be made on the UI thread from the
callback thread.
The following is a code snippet where the Activity allows the scanner service to handle the
scan trigger. The Activity uses AidcManager.createBarcodeReader()
to create
a BarcodeReader
, and registers a BarcodeReader.BarcodeListener
for receiving
bar code notifications. In the callback, the client must use
Activity
to safely post UI updates to the main
thread.
import com.honeywell.aidc.*; public class MainActivity extends Activity implements BarcodeReader.BarcodeListener { private AidcManager manager; private BarcodeReader reader; @Override public void onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState); // create the AidcManager providing a Context and an // CreatedCallback implementation. AidcManager.create(this, new AidcManager.CreatedCallback() { @Override public void onCreated(AidcManager aidcManager) { manager = aidcManager; // use the manager to create a BarcodeReader with a session // associated with the internal imager. reader = manager.createBarcodeReader(); try { // apply settings reader.setProperty(BarcodeReader.PROPERTY_CODE_39_ENABLED, false); reader.setProperty(BarcodeReader.PROPERTY_DATAMATRIX_ENABLED, true); // set the trigger mode to automatic control reader.setProperty(BarcodeReader.PROPERTY_TRIGGER_CONTROL_MODE, BarcodeReader.TRIGGER_CONTROL_MODE_AUTO_CONTROL); } catch (UnsupportedPropertyException e) { Toast.makeText(MainActivity.this, "Failed to apply properties", Toast.LENGTH_SHORT).show(); } // register bar code event listener reader.addBarcodeListener(MainActivity.this); } }); } @Override public void onResume() { super.onResume(); if (reader != null) { try { reader.claim(); } catch (ScannerUnavailableException e) { e.printStackTrace(); Toast.makeText(this, "Scanner unavailable", Toast.LENGTH_SHORT).show(); } } } @Override public void onPause() { super.onPause(); if (reader != null) { // release the scanner claim so we don't get any scanner // notifications while paused. reader.release(); } } @Override public void onDestroy() { super.onDestroy(); if (reader != null) { // unregister barcode event listener reader.removeBarcodeListener(this); // close BarcodeReader to clean up resources. // once closed, the object can no longer be used. reader.close(); } if (manager != null) { // close AidcManager to disconnect from the scanner service. // once closed, the object can no longer be used. manager.close(); } } @Override public void onBarcodeEvent(final BarcodeReadEvent event) { runOnUiThread(new Runnable() { @Override public void run() { String barcodeData = event.getBarcodeData(); String timestamp = event.getTimestamp(); // update UI to reflect the data } }); } @Override public void onFailureEvent(final BarcodeFailureEvent event) { runOnUiThread(new Runnable() { @Override public void run() { Toast.makeText(MainActivity.this, "Barcode read failed", Toast.LENGTH_SHORT).show(); } }); } }
If the client application needs to manage the scan trigger handling itself, the
BarcodeReader
can be configured to emit scan trigger events when the scan
trigger state changes. These events can be handled by the Activity by registering
a BarcodeReader.TriggerListener
. To enable client controlled trigger mode,
call setProperty(String, String)
, setting
PROPERTY_TRIGGER_CONTROL_MODE
to
TRIGGER_CONTROL_MODE_CLIENT_CONTROL
.
The following is a modified code snippet that demonstrates this.
import com.honeywell.aidc.*; public class MainActivity extends Activity implements BarcodeReader.BarcodeListener, BarcodeReader.TriggerListener { private AidcManager manager; private BarcodeReader reader; private boolean triggerState = false; @Override public void onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState); // create the AidcManager providing a Context and an // CreatedCallback implementation. AidcManager.create(this, new AidcManager.CreatedCallback() { @Override public void onCreated(AidcManager aidcManager) { manager = aidcManager; // use the manager to create a BarcodeReader with a session // associated with the internal imager. reader = manager.createBarcodeReader(); try { // apply settings reader.setProperty(BarcodeReader.PROPERTY_CODE_39_ENABLED, false); reader.setProperty(BarcodeReader.PROPERTY_DATAMATRIX_ENABLED, true); // set the trigger mode to client control reader.setProperty(BarcodeReader.PROPERTY_TRIGGER_CONTROL_MODE, BarcodeReader.TRIGGER_CONTROL_MODE_CLIENT_CONTROL); } catch (UnsupportedPropertyException e) { Toast.makeText(MainActivity.this, "Failed to apply properties", Toast.LENGTH_SHORT).show(); } // register bar code event listener reader.addBarcodeListener(MainActivity.this); // register trigger state change listener reader.addTriggerListener(MainActivity.this); } }); } @Override public void onResume() { super.onResume(); if (reader != null) { try { reader.claim(); } catch (ScannerUnavailableException e) { e.printStackTrace(); Toast.makeText(this, "Scanner unavailable", Toast.LENGTH_SHORT).show(); } } } @Override public void onPause() { super.onPause(); if (reader != null) { // release the scanner claim so we don't get any scanner // notifications while paused. reader.release(); } } @Override public void onDestroy() { super.onDestroy(); if (reader != null) { // unregister barcode event listener reader.removeBarcodeListener(this); // unregister trigger state change listener reader.removeTriggerListener(this); // close BarcodeReader to clean up resources. // once closed, the object can no longer be used. reader.close(); } if (manager != null) { // close AidcManager to disconnect from the scanner service. // once closed, the object can no longer be used. manager.close(); } } @Override public void onBarcodeEvent(final BarcodeReadEvent event) { runOnUiThread(new Runnable() { @Override public void run() { String barcodeData = event.getBarcodeData(); String timestamp = event.getTimestamp(); // update UI to reflect the data } }); // reset the trigger state triggerState = false; } @Override public void onFailureEvent(final BarcodeFailureEvent event) { runOnUiThread(new Runnable() { @Override public void run() { Toast.makeText(MainActivity.this, "Barcode read failed", Toast.LENGTH_SHORT).show(); } }); } // these events can be used to implement custom trigger modes if the automatic // behavior provided by the scanner service is insufficient for your application. // the following code demonstrates a "toggle" mode implementation, where the state // of the scanner changes each time the scan trigger is pressed. @Override public void onTriggerEvent(TriggerStateChangeEvent event) { try { // only handle trigger presses if (event.getState()) { // turn on/off aimer, illumination and decoding reader.aim(!triggerState); reader.light(!triggerState); reader.decode(!triggerState); triggerState = !triggerState; } } catch (ScannerNotClaimedException e) { e.printStackTrace(); Toast.makeText(MainActivity.this, "Scanner is not claimed", Toast.LENGTH_SHORT).show(); } catch (ScannerUnavailableException e) { e.printStackTrace(); Toast.makeText(MainActivity.this, "Scanner unavailable", Toast.LENGTH_SHORT).show(); } } }
Modifier and Type | Class and Description |
---|---|
static interface |
BarcodeReader.BarcodeListener
Used in conjunction with
addBarcodeListener(BarcodeListener) . |
static interface |
BarcodeReader.TriggerListener
Used in conjunction with
addTriggerListener(TriggerListener) . |
Parcelable.ClassLoaderCreator<T>, Parcelable.Creator<T>
Modifier and Type | Field and Description |
---|---|
static String |
BAD_READ_NOTIFICATION |
static String |
CODABAR_CHECK_DIGIT_MODE_CHECK
Checksum check is performed.
|
static String |
CODABAR_CHECK_DIGIT_MODE_CHECK_AND_STRIP
Checksum check is performed and the checksum digit is stripped from the
result string.
|
static String |
CODABAR_CHECK_DIGIT_MODE_NO_CHECK
No checksum checking is performed.
|
static String |
CODE_11_CHECK_DIGIT_MODE_DOUBLE_DIGIT_CHECK
Two checksum digits checked.
|
static String |
CODE_11_CHECK_DIGIT_MODE_DOUBLE_DIGIT_CHECK_AND_STRIP
Two checksum digits checked and stripped from the result string.
|
static String |
CODE_11_CHECK_DIGIT_MODE_SINGLE_DIGIT_CHECK
One checksum digit checked.
|
static String |
CODE_11_CHECK_DIGIT_MODE_SINGLE_DIGIT_CHECK_AND_STRIP
One checksum digit checked and stripped from the result string.
|
static String |
CODE_39_CHECK_DIGIT_MODE_CHECK
Checksum check is performed.
|
static String |
CODE_39_CHECK_DIGIT_MODE_CHECK_AND_STRIP
Checksum check is performed and the checksum digit is stripped from the
result string.
|
static String |
CODE_39_CHECK_DIGIT_MODE_NO_CHECK
No checksum checking is performed.
|
static Parcelable.Creator<BarcodeReader> |
CREATOR |
static String |
DATA_PROCESSOR_SYMBOLOGY_ID_AIM
Indicates that the AIM symbology identifier will be added.
|
static String |
DATA_PROCESSOR_SYMBOLOGY_ID_HONEYWELL
Indicates that the honeywell proprietary symbology identifier will be added.
|
static String |
DATA_PROCESSOR_SYMBOLOGY_ID_NONE
Indicates that no data related to the symbology will be added.
|
static String |
GOOD_READ_NOTIFICATION |
static String |
IMAGER_EXPOSURE_MODE_AUTO_EXPOSURE
Software automatically updates exposure to improve image quality.
|
static String |
IMAGER_EXPOSURE_MODE_AUTO_SENSOR
Image sensor controls the exposure automatically.
|
static String |
IMAGER_EXPOSURE_MODE_CONTEXT_SENSITIVE
Software automatically updates exposure to improve image quality of bar
codes.
|
static String |
IMAGER_EXPOSURE_MODE_FIXED
Exposure does not change automatically.
|
static String |
IMAGER_SAMPLE_METHOD_CENTER
Image quality determined by center of image.
|
static String |
IMAGER_SAMPLE_METHOD_CENTER_WEIGHTED
Image quality determined by entire image but weighted toward center of
image.
|
static String |
IMAGER_SAMPLE_METHOD_UNIFORM
Image quality determined by entire image.
|
static String |
INTERLEAVED_25_CHECK_DIGIT_MODE_CHECK
Checksum check is performed.
|
static String |
INTERLEAVED_25_CHECK_DIGIT_MODE_CHECK_AND_STRIP
Checksum check is performed and the checksum digit is stripped from the
result string.
|
static String |
INTERLEAVED_25_CHECK_DIGIT_MODE_NO_CHECK
No checksum checking is performed.
|
static String |
MSI_CHECK_DIGIT_MODE_DOUBLE_MOD_10_CHECK
Two mod 10 checksum digits checked.
|
static String |
MSI_CHECK_DIGIT_MODE_DOUBLE_MOD_10_CHECK_AND_STRIP
Two mod 10 checksum digits checked and stripped from the result string.
|
static String |
MSI_CHECK_DIGIT_MODE_NO_CHECK
No checksum checking is performed.
|
static String |
MSI_CHECK_DIGIT_MODE_SINGLE_MOD_10_CHECK
One mod 10 checksum digit checked.
|
static String |
MSI_CHECK_DIGIT_MODE_SINGLE_MOD_10_CHECK_AND_STRIP
One mod 10 checksum digit checked and stripped from the result string.
|
static String |
MSI_CHECK_DIGIT_MODE_SINGLE_MOD_11_PLUS_MOD_10_CHECK
One mod 11 checksum digit plus one mod 10 checksum digit checked.
|
static String |
MSI_CHECK_DIGIT_MODE_SINGLE_MOD_11_PLUS_MOD_10_CHECK_AND_STRIP
One mod 11 checksum digit plus one mod 10 checksum digit checked and
stripped from the result string.
|
static String |
POSTAL_2D_MODE_AUSTRALIA
Enable Australia Post.
|
static String |
POSTAL_2D_MODE_BPO
Enable Royal Mail 4 State Customer Code (British Post Office).
|
static String |
POSTAL_2D_MODE_CANADA
Enable Canada Post.
|
static String |
POSTAL_2D_MODE_DUTCH
Enable Dutch Post (KIX Code).
|
static String |
POSTAL_2D_MODE_INFOMAIL
Enable Royal Mail InfoMail.
|
static String |
POSTAL_2D_MODE_INFOMAIL_AND_BPO
Enable Infomail and Royal Mail 4 State Customer Code (British Post
Office).
|
static String |
POSTAL_2D_MODE_JAPAN
Enable Japan Post.
|
static String |
POSTAL_2D_MODE_NONE
No 2D postal symbologies enabled.
|
static String |
POSTAL_2D_MODE_PLANET
Enable Planet.
|
static String |
POSTAL_2D_MODE_PLANET_AND_POSTNET
Enable Planet and Postnet.
|
static String |
POSTAL_2D_MODE_PLANET_AND_POSTNET_AND_UPU
Enable Planet, Postnet and UPU 4 State Customer Code.
|
static String |
POSTAL_2D_MODE_PLANET_AND_POSTNET_AND_UPU_AND_USPS
Enable Planet, Postnet, UPU 4 State Customer Code and USPS 4 State
Customer Code.
|
static String |
POSTAL_2D_MODE_PLANET_AND_POSTNET_AND_UPU_AND_USPS_PLUS_BNB
Enable Planet, Postnet, UPU 4 State Customer Code and USPS 4 State
Customer Code with B and B fields.
|
static String |
POSTAL_2D_MODE_PLANET_AND_POSTNET_AND_UPU_PLUS_BNB
Enable Planet, Postnet and UPU 4 State Customer Code with B and B fields.
|
static String |
POSTAL_2D_MODE_PLANET_AND_POSTNET_AND_USPS
Enable Planet, Postnet and USPS 4 State Customer Code.
|
static String |
POSTAL_2D_MODE_PLANET_AND_POSTNET_AND_USPS_PLUS_BNB
Enable Planet, Postnet and USPS 4 State Customer Code with B and B
fields.
|
static String |
POSTAL_2D_MODE_PLANET_AND_POSTNET_PLUS_BNB
Enable Planet and Postnet with B and B fields.
|
static String |
POSTAL_2D_MODE_PLANET_AND_UPU
Enable Planet and UPU 4 State Customer Code.
|
static String |
POSTAL_2D_MODE_PLANET_AND_UPU_AND_USPS
Enable Planet, UPU 4 State Customer Code and USPS 4 State Customer Code.
|
static String |
POSTAL_2D_MODE_PLANET_AND_USPS
Enable Planet and USPS 4 State Customer Code.
|
static String |
POSTAL_2D_MODE_POSTNET
Enable Postnet.
|
static String |
POSTAL_2D_MODE_POSTNET_AND_UPU
Enable Postnet and UPU 4 State Customer Code.
|
static String |
POSTAL_2D_MODE_POSTNET_AND_UPU_AND_USPS
Enable Postnet, UPU 4 State Customer Code and USPS 4 Customer Code.
|
static String |
POSTAL_2D_MODE_POSTNET_AND_UPU_AND_USPS_PLUS_BNB
Enable Postnet, UPU 4 State Customer Code and USPS 4 State Customer Code
with B and B fields.
|
static String |
POSTAL_2D_MODE_POSTNET_AND_UPU_PLUS_BNB
Enable Postnet and UPU 4 State Customer Code with B and B fields.
|
static String |
POSTAL_2D_MODE_POSTNET_AND_USPS
Enable Planet and USPS 4 State Customer Code.
|
static String |
POSTAL_2D_MODE_POSTNET_AND_USPS_PLUS_BNB
Enable Postnet and USPS 4 State Customer Code with B and B fields.
|
static String |
POSTAL_2D_MODE_POSTNET_PLUS_BNB
Enable Postnet with B and B fields.
|
static String |
POSTAL_2D_MODE_UPU
Enable UPU 4 State Customer Code.
|
static String |
POSTAL_2D_MODE_UPU_AND_USPS
Enable UPU and USPS 4 State Customer Code.
|
static String |
POSTAL_2D_MODE_USPS
Enable USPS 4 for State Customer Code.
|
static String |
POSTAL_OCR_MODE_INVERSE
Enable inverse video OCR mode
|
static String |
POSTAL_OCR_MODE_NORMAL
Enable normal video OCR mode
|
static String |
POSTAL_OCR_MODE_NORMAL_AND_INVERSE
Enable normal and inverse video OCR mode
|
static String |
POSTAL_OCR_MODE_OFF
Disable OCR Mode
|
static String |
PROPERTY_AZTEC_ENABLED
Enable or disable Aztec.
|
static String |
PROPERTY_AZTEC_MAXIMUM_LENGTH
Maximum code length for decoding.
|
static String |
PROPERTY_AZTEC_MINIMUM_LENGTH
Minimum code length for decoding.
|
static String |
PROPERTY_CENTER_DECODE
Enable scanning only near the aimer center.
|
static String |
PROPERTY_CHINA_POST_ENABLED
Enable or disable China Post.
|
static String |
PROPERTY_CHINA_POST_MAXIMUM_LENGTH
Maximum code length for decoding.
|
static String |
PROPERTY_CHINA_POST_MINIMUM_LENGTH
Minimum code length for decoding.
|
static String |
PROPERTY_CODABAR_CHECK_DIGIT_MODE
Check digit mode for Codabar bar codes.
|
static String |
PROPERTY_CODABAR_CONCAT_ENABLED
Enable or disable concatenation.
|
static String |
PROPERTY_CODABAR_ENABLED
Enable or disable Codabar.
|
static String |
PROPERTY_CODABAR_MAXIMUM_LENGTH
Maximum code length for decoding.
|
static String |
PROPERTY_CODABAR_MINIMUM_LENGTH
Minimum code length for decoding.
|
static String |
PROPERTY_CODABAR_START_STOP_TRANSMIT_ENABLED
Enable or disable the start/stop transmission for Codabar.
|
static String |
PROPERTY_CODABLOCK_A_ENABLED
Enable or disable Codablock-A.
|
static String |
PROPERTY_CODABLOCK_A_MAXIMUM_LENGTH
Maximum code length for decoding.
|
static String |
PROPERTY_CODABLOCK_A_MINIMUM_LENGTH
Minimum code length for decoding.
|
static String |
PROPERTY_CODABLOCK_F_ENABLED
Enable or disable Codablock-F.
|
static String |
PROPERTY_CODABLOCK_F_MAXIMUM_LENGTH
Maximum code length for decoding.
|
static String |
PROPERTY_CODABLOCK_F_MINIMUM_LENGTH
Minimum code length for decoding.
|
static String |
PROPERTY_CODE_11_CHECK_DIGIT_MODE
Check digit mode for Code 11 bar codes.
|
static String |
PROPERTY_CODE_11_ENABLED
Enable or disable Code 11.
|
static String |
PROPERTY_CODE_11_MAXIMUM_LENGTH
Maximum code length for decoding.
|
static String |
PROPERTY_CODE_11_MINIMUM_LENGTH
Minimum code length for decoding.
|
static String |
PROPERTY_CODE_128_ENABLED
Enable or disable Code 128.
|
static String |
PROPERTY_CODE_128_MAXIMUM_LENGTH
Maximum code length for decoding.
|
static String |
PROPERTY_CODE_128_MINIMUM_LENGTH
Minimum code length for decoding.
|
static String |
PROPERTY_CODE_39_BASE_32_ENABLED
Enable or disable Base 32 Conversion for Code 39.
|
static String |
PROPERTY_CODE_39_CHECK_DIGIT_MODE
Check digit mode for Code 39.
|
static String |
PROPERTY_CODE_39_ENABLED
Enable or disable Code 39.
|
static String |
PROPERTY_CODE_39_FULL_ASCII_ENABLED
Enable or disable full ASCII.
|
static String |
PROPERTY_CODE_39_MAXIMUM_LENGTH
Maximum code length for decoding.
|
static String |
PROPERTY_CODE_39_MINIMUM_LENGTH
Minimum code length for decoding.
|
static String |
PROPERTY_CODE_39_START_STOP_TRANSMIT_ENABLED
Enable or disable the start/stop transmission for Code 39.
|
static String |
PROPERTY_CODE_93_ENABLED
Enable or disable Code 93.
|
static String |
PROPERTY_CODE_93_MAXIMUM_LENGTH
Maximum code length for decoding.
|
static String |
PROPERTY_CODE_93_MINIMUM_LENGTH
Minimum code length for decoding.
|
static String |
PROPERTY_COMPOSITE_ENABLED
Enable or disable Composite Code.
|
static String |
PROPERTY_COMPOSITE_MAXIMUM_LENGTH
Maximum code length for decoding.
|
static String |
PROPERTY_COMPOSITE_MINIMUM_LENGTH
Minimum code length for decoding.
|
static String |
PROPERTY_DATA_PROCESSOR_CHARSET
The charset used to interpret the bar code byte data.
|
static String |
PROPERTY_DATA_PROCESSOR_LAUNCH_BROWSER
Indicates if scanning bar codes containing URLs will open the internet
browser.
|
static String |
PROPERTY_DATA_PROCESSOR_LAUNCH_EZ_CONFIG
Indicates if scanning bar codes generated by EZ Config for Mobility will
launch EZ Config on the mobile computer to apply settings.
|
static String |
PROPERTY_DATA_PROCESSOR_PREFIX
Data added to the beginning of the bar code data.
|
static String |
PROPERTY_DATA_PROCESSOR_SCAN_TO_INTENT
Indicates if bar codes starting with "//" will attempt to open an
application.
|
static String |
PROPERTY_DATA_PROCESSOR_SUFFIX
Data added to the end of the bar code data.
|
static String |
PROPERTY_DATA_PROCESSOR_SYMBOLOGY_PREFIX
Data added to the beginning of the bar code data to indicate the symbology.
|
static String |
PROPERTY_DATAMATRIX_ENABLED
Enable or disable Datamatrix.
|
static String |
PROPERTY_DATAMATRIX_MAXIMUM_LENGTH
Maximum code length for decoding.
|
static String |
PROPERTY_DATAMATRIX_MINIMUM_LENGTH
Minimum code length for decoding.
|
static String |
PROPERTY_DECODE_WINDOW_BOTTOM
Sets the bottom edge of the scan window within the scanner's overall image window.
|
static String |
PROPERTY_DECODE_WINDOW_LEFT
Sets the left edge of the scan window within the scanner's overall image window.
|
static String |
PROPERTY_DECODE_WINDOW_RIGHT
Sets the right edge of the scan window within the scanner's overall image window.
|
static String |
PROPERTY_DECODE_WINDOW_TOP
Sets the top edge of the scan window within the scanner's overall image window.
|
static String |
PROPERTY_EAN_13_ADDENDA_REQUIRED_ENABLED
Enable or disable the requirement for add-on 2 or add-on 5 to be enabled.
|
static String |
PROPERTY_EAN_13_ADDENDA_SEPARATOR_ENABLED
Enable or disable adding a space separation between the bar code data and
the add-on characters in the decode result.
|
static String |
PROPERTY_EAN_13_CHECK_DIGIT_TRANSMIT_ENABLED
Enable or disable check digit transmission.
|
static String |
PROPERTY_EAN_13_ENABLED
Enable or disable EAN-13.
|
static String |
PROPERTY_EAN_13_FIVE_CHAR_ADDENDA_ENABLED
Enable or disable add-on 5 for.
|
static String |
PROPERTY_EAN_13_TWO_CHAR_ADDENDA_ENABLED
Enable or disable add-on 2.
|
static String |
PROPERTY_EAN_8_ADDENDA_REQUIRED_ENABLED
Enable or disable the requirement for add-on 2 or add-on 5 to be enabled.
|
static String |
PROPERTY_EAN_8_ADDENDA_SEPARATOR_ENABLED
Enable or disable adding a space separation between the bar code data and
the add-on characters in the decode result.
|
static String |
PROPERTY_EAN_8_CHECK_DIGIT_TRANSMIT_ENABLED
Enable or disable check digit transmission.
|
static String |
PROPERTY_EAN_8_ENABLED
Enable or disable EAN-8.
|
static String |
PROPERTY_EAN_8_FIVE_CHAR_ADDENDA_ENABLED
Enable or disable add-on 5 for.
|
static String |
PROPERTY_EAN_8_TWO_CHAR_ADDENDA_ENABLED
Enable or disable add-on 2.
|
static String |
PROPERTY_GROUP_DATA_PROCESSING
Identifies the data procession group of properties.
|
static String |
PROPERTY_GROUP_IMAGER
Identifies the imager group of properties.
|
static String |
PROPERTY_GROUP_NOTIFICATION
Identifies the notification group of properties.
|
static String |
PROPERTY_GROUP_SYMBOLOGY
Identifies the symbology group of properties.
|
static String |
PROPERTY_GROUP_TRIGGER
Identifies the trigger group of properties.
|
static String |
PROPERTY_GS1_128_ENABLED
Enable or disable GS1 128.
|
static String |
PROPERTY_GS1_128_MAXIMUM_LENGTH
Maximum code length for decoding.
|
static String |
PROPERTY_GS1_128_MINIMUM_LENGTH
Minimum code length for decoding.
|
static String |
PROPERTY_HAX_XIN_ENABLED
Enable or disable Han Xin.
|
static String |
PROPERTY_HAX_XIN_MAXIMUM_LENGTH
Maximum code length for decoding.
|
static String |
PROPERTY_HAX_XIN_MINIMUM_LENGTH
Minimum code length for decoding.
|
static String |
PROPERTY_IATA_25_ENABLED
Enable or disable IATA 2 of 5.
|
static String |
PROPERTY_IATA_25_MAXIMUM_LENGTH
Maximum code length for decoding.
|
static String |
PROPERTY_IATA_25_MINIMUM_LENGTH
Minimum code length for decoding.
|
static String |
PROPERTY_IMAGER_EXPOSURE
Imager exposure.
|
static String |
PROPERTY_IMAGER_EXPOSURE_MODE
If and how exposure is automatically updated to improve image quality.
|
static String |
PROPERTY_IMAGER_GAIN
Sensitivity of image sensor when using fixed exposure.
|
static String |
PROPERTY_IMAGER_LIGHT_INTENSITY
Imager illumination intensity.
|
static String |
PROPERTY_IMAGER_MAXIMUM_EXPOSURE
Maximum exposure time in microseconds when using automatic exposure.
|
static String |
PROPERTY_IMAGER_MAXIMUM_GAIN
Maximum sensitivity of image sensor when using automatic exposure.
|
static String |
PROPERTY_IMAGER_REJECTION_LIMIT
Maximum number of images to reject because the aren't close enough to
TARGET_VALUE.
|
static String |
PROPERTY_IMAGER_SAMPLE_METHOD
How image quality is determined by software controlled exposure modes.
|
static String |
PROPERTY_IMAGER_TARGET_ACCEPTABLE_OFFSET
Acceptable difference from TARGET_VALUE of images.
|
static String |
PROPERTY_IMAGER_TARGET_PERCENTILE
Target percentile of target value for the Automatic Exposure mode.
|
static String |
PROPERTY_IMAGER_TARGET_VALUE
Target calculated value of image during automated exposure control.
|
static String |
PROPERTY_INTERLEAVED_25_CHECK_DIGIT_MODE
Check digit mode for Interleaved 2 of 5 bar codes.
|
static String |
PROPERTY_INTERLEAVED_25_ENABLED
Enable or disable Interleaved 2 of 5.
|
static String |
PROPERTY_INTERLEAVED_25_MAXIMUM_LENGTH
Maximum code length for decoding.
|
static String |
PROPERTY_INTERLEAVED_25_MINIMUM_LENGTH
Minimum code length for decoding.
|
static String |
PROPERTY_ISBT_128_ENABLED
Enable or disable ISBT 128.
|
static String |
PROPERTY_KOREAN_POST_ENABLED
Enable or disable Korean Post.
|
static String |
PROPERTY_KOREAN_POST_MAXIMUM_LENGTH
Maximum code length for decoding.
|
static String |
PROPERTY_KOREAN_POST_MINIMUM_LENGTH
Minimum code length for decoding.
|
static String |
PROPERTY_MATRIX_25_ENABLED
Enable or disable Matrix 2 of 5.
|
static String |
PROPERTY_MATRIX_25_MAXIMUM_LENGTH
Maximum code length for decoding.
|
static String |
PROPERTY_MATRIX_25_MINIMUM_LENGTH
Minimum code length for decoding.
|
static String |
PROPERTY_MAXICODE_ENABLED
Enable or disable Maxicode.
|
static String |
PROPERTY_MAXICODE_MAXIMUM_LENGTH
Maximum code length for decoding.
|
static String |
PROPERTY_MAXICODE_MINIMUM_LENGTH
Minimum code length for decoding.
|
static String |
PROPERTY_MICRO_PDF_417_ENABLED
Enable or disable Micro PDF-417.
|
static String |
PROPERTY_MICRO_PDF_417_MAXIMUM_LENGTH
Maximum code length for decoding.
|
static String |
PROPERTY_MICRO_PDF_417_MINIMUM_LENGTH
Minimum code length for decoding.
|
static String |
PROPERTY_MSI_CHECK_DIGIT_MODE
Check digit mode for Interleaved 2 of 5 bar codes.
|
static String |
PROPERTY_MSI_ENABLED
Enable or disable MSI.
|
static String |
PROPERTY_MSI_MAXIMUM_LENGTH
Maximum code length for decoding.
|
static String |
PROPERTY_MSI_MINIMUM_LENGTH
Minimum code length for decoding.
|
static String |
PROPERTY_NOTIFICATION_BAD_READ_ENABLED
Bad Read Notification Enable/Disable.
|
static String |
PROPERTY_NOTIFICATION_GOOD_READ_ENABLED
Good Read Notification Enable/Disable.
|
static String |
PROPERTY_NOTIFICATION_VIBRATE_ENABLED
Vibration Enable/Disabled.
|
static String |
PROPERTY_OCR_ACTIVE_TEMPLATE
Bit field value that enables/disables multiple templates.
|
static String |
PROPERTY_OCR_MODE
Enable or disable OCR.
|
static String |
PROPERTY_OCR_TEMPLATE
Numeric sequence that defines the user OCR template.
|
static String |
PROPERTY_PDF_417_ENABLED
Enable or disable PDF-417.
|
static String |
PROPERTY_PDF_417_MAXIMUM_LENGTH
Maximum code length for decoding.
|
static String |
PROPERTY_PDF_417_MINIMUM_LENGTH
Minimum code length for decoding.
|
static String |
PROPERTY_POSTAL_2D_MODE
Enable one or more 2D postal symbologies.
|
static String |
PROPERTY_POSTAL_2D_PLANET_CHECK_DIGIT_TRANSMIT_ENABLED
Enable or disable check digit transmission.
|
static String |
PROPERTY_POSTAL_2D_POSTNET_CHECK_DIGIT_TRANSMIT_ENABLED
Enable or disable check digit transmission.
|
static String |
PROPERTY_QR_CODE_ENABLED
Enable or disable QR Code.
|
static String |
PROPERTY_QR_CODE_MAXIMUM_LENGTH
Maximum code length for decoding.
|
static String |
PROPERTY_QR_CODE_MINIMUM_LENGTH
Minimum code length for decoding.
|
static String |
PROPERTY_RSS_ENABLED
Enable or disable RSS.
|
static String |
PROPERTY_RSS_EXPANDED_ENABLED
Enable or disable RSS Expanded.
|
static String |
PROPERTY_RSS_EXPANDED_MAXIMUM_LENGTH
Maximum code length for decoding.
|
static String |
PROPERTY_RSS_EXPANDED_MINIMUM_LENGTH
Minimum code length for decoding.
|
static String |
PROPERTY_RSS_LIMITED_ENABLED
Enable or disable RSS Limited.
|
static String |
PROPERTY_STANDARD_25_ENABLED
Enable or disable Standard 2 of 5.
|
static String |
PROPERTY_STANDARD_25_MAXIMUM_LENGTH
Maximum code length for decoding.
|
static String |
PROPERTY_STANDARD_25_MINIMUM_LENGTH
Minimum code length for decoding.
|
static String |
PROPERTY_TELEPEN_ENABLED
Enable or disable Telepen.
|
static String |
PROPERTY_TELEPEN_MAXIMUM_LENGTH
Maximum code length for decoding.
|
static String |
PROPERTY_TELEPEN_MINIMUM_LENGTH
Minimum code length for decoding.
|
static String |
PROPERTY_TELEPEN_OLD_STYLE_ENABLED
Enable or disable old-style Telepen.
|
static String |
PROPERTY_TLC_39_ENABLED
Enable or disable TLC 39.
|
static String |
PROPERTY_TRIGGER_AUTO_MODE_TIMEOUT
Automatic trigger mode timeout.
|
static String |
PROPERTY_TRIGGER_CONTROL_MODE
Trigger control mode.
|
static String |
PROPERTY_TRIGGER_SCAN_DELAY
Trigger scan delay.
|
static String |
PROPERTY_TRIOPTIC_ENABLED
Enable or disable Trioptic.
|
static String |
PROPERTY_UPC_A_ADDENDA_REQUIRED_ENABLED
Enable or disable the requirement for add-on 2 or add-on 5 to be enabled.
|
static String |
PROPERTY_UPC_A_ADDENDA_SEPARATOR_ENABLED
Enable or disable adding a space separation between the bar code data and
the add-on characters in the decode result.
|
static String |
PROPERTY_UPC_A_CHECK_DIGIT_TRANSMIT_ENABLED
Enable or disable check digit transmission.
|
static String |
PROPERTY_UPC_A_COMBINE_COUPON_CODE_MODE_ENABLED
Enable or disable UPC-A Combined Coupon Code.
|
static String |
PROPERTY_UPC_A_COUPON_CODE_MODE_ENABLED
Enable or disable UPC-A Coupon Code.
|
static String |
PROPERTY_UPC_A_ENABLE
Enable or disable UPC-A.
|
static String |
PROPERTY_UPC_A_FIVE_CHAR_ADDENDA_ENABLED
Enable or disable add-on 5.
|
static String |
PROPERTY_UPC_A_NUMBER_SYSTEM_TRANSMIT_ENABLED
Enable or disable number system transmission.
|
static String |
PROPERTY_UPC_A_TRANSLATE_EAN13
Translate UPC-A to EAN13.
|
static String |
PROPERTY_UPC_A_TWO_CHAR_ADDENDA_ENABLED
Enable or disable add-on 2.
|
static String |
PROPERTY_UPC_E_ADDENDA_REQUIRED_ENABLED
Enable or disable the requirement for add-on 2 or add-on 5 to be enabled.
|
static String |
PROPERTY_UPC_E_ADDENDA_SEPARATOR_ENABLED
Enable or disable adding a space separation between the bar code data and
the add-on characters in the decode result.
|
static String |
PROPERTY_UPC_E_CHECK_DIGIT_TRANSMIT_ENABLED
Enable or disable check digit transmission.
|
static String |
PROPERTY_UPC_E_E1_ENABLED
Enable or disable UPC-E1.
|
static String |
PROPERTY_UPC_E_ENABLED
Enable or disable UPC-E0.
|
static String |
PROPERTY_UPC_E_EXPAND_TO_UPC_A
Enable or disable expanding a UPC-E barcode into a UPC-A standard code.
|
static String |
PROPERTY_UPC_E_FIVE_CHAR_ADDENDA_ENABLED
Enable or disable add-on 5 for.
|
static String |
PROPERTY_UPC_E_NUMBER_SYSTEM_TRANSMIT_ENABLED
Enable or disable number system transmission.
|
static String |
PROPERTY_UPC_E_TWO_CHAR_ADDENDA_ENABLED
Enable or disable add-on 2.
|
static String |
TRIGGER_CONTROL_MODE_AUTO_CONTROL
Automatic control.
|
static String |
TRIGGER_CONTROL_MODE_CLIENT_CONTROL
Client control.
|
static String |
TRIGGER_CONTROL_MODE_DISABLE
Disabled.
|
CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE
Modifier and Type | Method and Description |
---|---|
void |
addBarcodeListener(BarcodeReader.BarcodeListener listener)
Register a callback to be invoked when a bar code label has been
successfully decoded.
|
void |
addTriggerListener(BarcodeReader.TriggerListener listener)
Register a callback to be invoked when the scan trigger state
has changed.
|
void |
aim(boolean on)
Sets the aiming state of the scanner.
|
Bitmap |
captureImage()
Use the BarcodeReader to capture an image.
|
void |
claim()
Claims the scanner.
|
void |
close()
Closes the scanner and terminates the established session.
|
void |
decode(boolean on)
Sets the decoding state of the scanner.
|
int |
describeContents() |
Map<String,Object> |
getAllDefaultProperties()
Retrieves the map of all default properties.
|
Map<String,Object> |
getAllProperties()
Retrieves the map of all properties.
|
boolean |
getBooleanProperty(String name)
Retrieves a boolean property value
|
BarcodeReaderInfo |
getInfo() |
int |
getIntProperty(String name)
Retrieves an integer property value
|
Map<String,Object> |
getProperties(Set<String> names)
Retrieves a map of properties.
|
Signature |
getSignature(SignatureParameters parameters)
Retrieves the signature based on the last bar code scanned
|
String |
getStringProperty(String name)
Retrieves a string property value
|
void |
light(boolean on)
Sets the illumination state of the scanner.
|
void |
notify(String notification)
Use the BarcodeReader's built-in mechanism for notifying the user of events.
|
void |
release()
Releases the scanner claim.
|
void |
removeBarcodeListener(BarcodeReader.BarcodeListener listener)
Unregister a bar code callback.
|
void |
removeTriggerListener(BarcodeReader.TriggerListener listener)
Unregister a trigger state change callback.
|
void |
setProperties(Map<String,Object> properties)
Sets a map of properties.
|
void |
setProperty(String name,
boolean value)
Sets a boolean property.
|
void |
setProperty(String name,
int value)
Sets an integer property.
|
void |
setProperty(String name,
String value)
Sets a string or enum property.
|
void |
softwareTrigger(boolean state)
Sends a trigger up/down action
|
void |
startPropertyEditor(Context context)
Starts a settings activity that can configure the properties
of this
BarcodeReader |
void |
startPropertyEditor(Context context,
String propertyGroup,
String activityTitle)
Starts a settings activity that can configure the properties
of this
BarcodeReader |
void |
writeToParcel(Parcel dest,
int flags) |
public static final String PROPERTY_IMAGER_LIGHT_INTENSITY
public static final String PROPERTY_IMAGER_EXPOSURE
public static final String PROPERTY_IMAGER_GAIN
public static final String PROPERTY_IMAGER_MAXIMUM_EXPOSURE
public static final String PROPERTY_IMAGER_MAXIMUM_GAIN
public static final String PROPERTY_IMAGER_TARGET_VALUE
public static final String PROPERTY_IMAGER_TARGET_ACCEPTABLE_OFFSET
public static final String PROPERTY_IMAGER_REJECTION_LIMIT
public static final String PROPERTY_IMAGER_TARGET_PERCENTILE
public static final String PROPERTY_IMAGER_EXPOSURE_MODE
public static final String PROPERTY_IMAGER_SAMPLE_METHOD
public static final String IMAGER_EXPOSURE_MODE_FIXED
public static final String IMAGER_EXPOSURE_MODE_AUTO_SENSOR
public static final String IMAGER_EXPOSURE_MODE_AUTO_EXPOSURE
public static final String IMAGER_EXPOSURE_MODE_CONTEXT_SENSITIVE
public static final String IMAGER_SAMPLE_METHOD_UNIFORM
public static final String IMAGER_SAMPLE_METHOD_CENTER
public static final String IMAGER_SAMPLE_METHOD_CENTER_WEIGHTED
public static final String PROPERTY_NOTIFICATION_GOOD_READ_ENABLED
public static final String PROPERTY_NOTIFICATION_BAD_READ_ENABLED
public static final String PROPERTY_NOTIFICATION_VIBRATE_ENABLED
public static final String PROPERTY_TRIGGER_CONTROL_MODE
public static final String PROPERTY_TRIGGER_AUTO_MODE_TIMEOUT
PROPERTY_TRIGGER_CONTROL_MODE
is set to
TRIGGER_CONTROL_MODE_AUTO_CONTROL
The value is an integer (in seconds) indicating how long the scanner will remain on while the scan trigger is pressed. Once this timeout has expired, the scanner will automatically be turned off to save power.
public static final String TRIGGER_CONTROL_MODE_DISABLE
public static final String TRIGGER_CONTROL_MODE_AUTO_CONTROL
Turning the scanner on means turning on the aimer and illumination, and enabling decoding.
public static final String TRIGGER_CONTROL_MODE_CLIENT_CONTROL
public static final String PROPERTY_TRIGGER_SCAN_DELAY
public static final String PROPERTY_CODE_128_ENABLED
public static final String PROPERTY_CODE_128_MINIMUM_LENGTH
public static final String PROPERTY_CODE_128_MAXIMUM_LENGTH
public static final String PROPERTY_GS1_128_ENABLED
public static final String PROPERTY_GS1_128_MINIMUM_LENGTH
public static final String PROPERTY_GS1_128_MAXIMUM_LENGTH
public static final String PROPERTY_ISBT_128_ENABLED
public static final String PROPERTY_CODE_39_ENABLED
public static final String PROPERTY_CODE_39_MINIMUM_LENGTH
public static final String PROPERTY_CODE_39_MAXIMUM_LENGTH
public static final String PROPERTY_CODE_39_CHECK_DIGIT_MODE
public static final String PROPERTY_CODE_39_FULL_ASCII_ENABLED
public static final String PROPERTY_CODE_39_START_STOP_TRANSMIT_ENABLED
public static final String CODE_39_CHECK_DIGIT_MODE_NO_CHECK
public static final String CODE_39_CHECK_DIGIT_MODE_CHECK
public static final String CODE_39_CHECK_DIGIT_MODE_CHECK_AND_STRIP
public static final String PROPERTY_CODE_39_BASE_32_ENABLED
public static final String PROPERTY_DATAMATRIX_ENABLED
public static final String PROPERTY_DATAMATRIX_MINIMUM_LENGTH
public static final String PROPERTY_DATAMATRIX_MAXIMUM_LENGTH
public static final String PROPERTY_UPC_A_ENABLE
public static final String PROPERTY_UPC_A_TRANSLATE_EAN13
public static final String PROPERTY_UPC_A_COUPON_CODE_MODE_ENABLED
public static final String PROPERTY_UPC_A_COMBINE_COUPON_CODE_MODE_ENABLED
public static final String PROPERTY_UPC_A_CHECK_DIGIT_TRANSMIT_ENABLED
public static final String PROPERTY_UPC_A_NUMBER_SYSTEM_TRANSMIT_ENABLED
public static final String PROPERTY_UPC_A_TWO_CHAR_ADDENDA_ENABLED
public static final String PROPERTY_UPC_A_FIVE_CHAR_ADDENDA_ENABLED
public static final String PROPERTY_UPC_A_ADDENDA_REQUIRED_ENABLED
public static final String PROPERTY_UPC_A_ADDENDA_SEPARATOR_ENABLED
public static final String PROPERTY_UPC_E_ENABLED
public static final String PROPERTY_UPC_E_E1_ENABLED
public static final String PROPERTY_UPC_E_EXPAND_TO_UPC_A
public static final String PROPERTY_UPC_E_CHECK_DIGIT_TRANSMIT_ENABLED
public static final String PROPERTY_UPC_E_NUMBER_SYSTEM_TRANSMIT_ENABLED
public static final String PROPERTY_UPC_E_TWO_CHAR_ADDENDA_ENABLED
public static final String PROPERTY_UPC_E_FIVE_CHAR_ADDENDA_ENABLED
public static final String PROPERTY_UPC_E_ADDENDA_REQUIRED_ENABLED
public static final String PROPERTY_UPC_E_ADDENDA_SEPARATOR_ENABLED
public static final String PROPERTY_EAN_8_ENABLED
public static final String PROPERTY_EAN_8_CHECK_DIGIT_TRANSMIT_ENABLED
public static final String PROPERTY_EAN_8_TWO_CHAR_ADDENDA_ENABLED
public static final String PROPERTY_EAN_8_FIVE_CHAR_ADDENDA_ENABLED
public static final String PROPERTY_EAN_8_ADDENDA_REQUIRED_ENABLED
public static final String PROPERTY_EAN_8_ADDENDA_SEPARATOR_ENABLED
public static final String PROPERTY_EAN_13_ENABLED
public static final String PROPERTY_EAN_13_CHECK_DIGIT_TRANSMIT_ENABLED
public static final String PROPERTY_EAN_13_TWO_CHAR_ADDENDA_ENABLED
public static final String PROPERTY_EAN_13_FIVE_CHAR_ADDENDA_ENABLED
public static final String PROPERTY_EAN_13_ADDENDA_REQUIRED_ENABLED
public static final String PROPERTY_EAN_13_ADDENDA_SEPARATOR_ENABLED
public static final String PROPERTY_AZTEC_ENABLED
public static final String PROPERTY_AZTEC_MINIMUM_LENGTH
public static final String PROPERTY_AZTEC_MAXIMUM_LENGTH
public static final String PROPERTY_CHINA_POST_ENABLED
public static final String PROPERTY_CHINA_POST_MINIMUM_LENGTH
public static final String PROPERTY_CHINA_POST_MAXIMUM_LENGTH
public static final String PROPERTY_CODABAR_ENABLED
public static final String PROPERTY_CODABAR_MINIMUM_LENGTH
public static final String PROPERTY_CODABAR_MAXIMUM_LENGTH
public static final String PROPERTY_CODABAR_START_STOP_TRANSMIT_ENABLED
public static final String PROPERTY_CODABAR_CHECK_DIGIT_MODE
public static final String PROPERTY_CODABAR_CONCAT_ENABLED
public static final String CODABAR_CHECK_DIGIT_MODE_NO_CHECK
public static final String CODABAR_CHECK_DIGIT_MODE_CHECK
public static final String CODABAR_CHECK_DIGIT_MODE_CHECK_AND_STRIP
public static final String PROPERTY_CODABLOCK_A_ENABLED
public static final String PROPERTY_CODABLOCK_A_MINIMUM_LENGTH
public static final String PROPERTY_CODABLOCK_A_MAXIMUM_LENGTH
public static final String PROPERTY_CODABLOCK_F_ENABLED
public static final String PROPERTY_CODABLOCK_F_MINIMUM_LENGTH
public static final String PROPERTY_CODABLOCK_F_MAXIMUM_LENGTH
public static final String PROPERTY_CODE_11_ENABLED
public static final String PROPERTY_CODE_11_MINIMUM_LENGTH
public static final String PROPERTY_CODE_11_MAXIMUM_LENGTH
public static final String PROPERTY_CODE_11_CHECK_DIGIT_MODE
public static final String CODE_11_CHECK_DIGIT_MODE_DOUBLE_DIGIT_CHECK
public static final String CODE_11_CHECK_DIGIT_MODE_SINGLE_DIGIT_CHECK
public static final String CODE_11_CHECK_DIGIT_MODE_DOUBLE_DIGIT_CHECK_AND_STRIP
public static final String CODE_11_CHECK_DIGIT_MODE_SINGLE_DIGIT_CHECK_AND_STRIP
public static final String PROPERTY_CODE_93_ENABLED
public static final String PROPERTY_CODE_93_MINIMUM_LENGTH
public static final String PROPERTY_CODE_93_MAXIMUM_LENGTH
public static final String PROPERTY_COMPOSITE_ENABLED
public static final String PROPERTY_COMPOSITE_MINIMUM_LENGTH
public static final String PROPERTY_COMPOSITE_MAXIMUM_LENGTH
public static final String PROPERTY_HAX_XIN_ENABLED
public static final String PROPERTY_HAX_XIN_MINIMUM_LENGTH
public static final String PROPERTY_HAX_XIN_MAXIMUM_LENGTH
public static final String PROPERTY_IATA_25_ENABLED
public static final String PROPERTY_IATA_25_MINIMUM_LENGTH
public static final String PROPERTY_IATA_25_MAXIMUM_LENGTH
public static final String PROPERTY_INTERLEAVED_25_ENABLED
public static final String PROPERTY_INTERLEAVED_25_MINIMUM_LENGTH
public static final String PROPERTY_INTERLEAVED_25_MAXIMUM_LENGTH
public static final String PROPERTY_INTERLEAVED_25_CHECK_DIGIT_MODE
public static final String INTERLEAVED_25_CHECK_DIGIT_MODE_NO_CHECK
public static final String INTERLEAVED_25_CHECK_DIGIT_MODE_CHECK
public static final String INTERLEAVED_25_CHECK_DIGIT_MODE_CHECK_AND_STRIP
public static final String PROPERTY_KOREAN_POST_ENABLED
public static final String PROPERTY_KOREAN_POST_MINIMUM_LENGTH
public static final String PROPERTY_KOREAN_POST_MAXIMUM_LENGTH
public static final String PROPERTY_MATRIX_25_ENABLED
public static final String PROPERTY_MATRIX_25_MINIMUM_LENGTH
public static final String PROPERTY_MATRIX_25_MAXIMUM_LENGTH
public static final String PROPERTY_MAXICODE_ENABLED
public static final String PROPERTY_MAXICODE_MINIMUM_LENGTH
public static final String PROPERTY_MAXICODE_MAXIMUM_LENGTH
public static final String PROPERTY_MICRO_PDF_417_ENABLED
public static final String PROPERTY_MICRO_PDF_417_MINIMUM_LENGTH
public static final String PROPERTY_MICRO_PDF_417_MAXIMUM_LENGTH
public static final String PROPERTY_MSI_ENABLED
public static final String PROPERTY_MSI_MINIMUM_LENGTH
public static final String PROPERTY_MSI_MAXIMUM_LENGTH
public static final String PROPERTY_MSI_CHECK_DIGIT_MODE
MSI_CHECK_DIGIT_MODE_NO_CHECK
,
MSI_CHECK_DIGIT_MODE_SINGLE_MOD_10_CHECK
,
MSI_CHECK_DIGIT_MODE_SINGLE_MOD_11_PLUS_MOD_10_CHECK
,
MSI_CHECK_DIGIT_MODE_DOUBLE_MOD_10_CHECK
,
MSI_CHECK_DIGIT_MODE_SINGLE_MOD_10_CHECK_AND_STRIP
,
MSI_CHECK_DIGIT_MODE_SINGLE_MOD_11_PLUS_MOD_10_CHECK_AND_STRIP
,
MSI_CHECK_DIGIT_MODE_DOUBLE_MOD_10_CHECK_AND_STRIP
,
Constant Field Valuespublic static final String MSI_CHECK_DIGIT_MODE_NO_CHECK
public static final String MSI_CHECK_DIGIT_MODE_SINGLE_MOD_10_CHECK
public static final String MSI_CHECK_DIGIT_MODE_SINGLE_MOD_11_PLUS_MOD_10_CHECK
public static final String MSI_CHECK_DIGIT_MODE_DOUBLE_MOD_10_CHECK
public static final String MSI_CHECK_DIGIT_MODE_SINGLE_MOD_10_CHECK_AND_STRIP
public static final String MSI_CHECK_DIGIT_MODE_SINGLE_MOD_11_PLUS_MOD_10_CHECK_AND_STRIP
public static final String MSI_CHECK_DIGIT_MODE_DOUBLE_MOD_10_CHECK_AND_STRIP
public static final String PROPERTY_PDF_417_ENABLED
public static final String PROPERTY_PDF_417_MINIMUM_LENGTH
public static final String PROPERTY_PDF_417_MAXIMUM_LENGTH
public static final String PROPERTY_QR_CODE_ENABLED
public static final String PROPERTY_QR_CODE_MINIMUM_LENGTH
public static final String PROPERTY_QR_CODE_MAXIMUM_LENGTH
public static final String PROPERTY_RSS_ENABLED
public static final String PROPERTY_RSS_LIMITED_ENABLED
public static final String PROPERTY_RSS_EXPANDED_ENABLED
public static final String PROPERTY_RSS_EXPANDED_MINIMUM_LENGTH
public static final String PROPERTY_RSS_EXPANDED_MAXIMUM_LENGTH
public static final String PROPERTY_STANDARD_25_ENABLED
public static final String PROPERTY_STANDARD_25_MINIMUM_LENGTH
public static final String PROPERTY_STANDARD_25_MAXIMUM_LENGTH
public static final String PROPERTY_TELEPEN_ENABLED
public static final String PROPERTY_TELEPEN_MINIMUM_LENGTH
public static final String PROPERTY_TELEPEN_MAXIMUM_LENGTH
public static final String PROPERTY_TELEPEN_OLD_STYLE_ENABLED
public static final String PROPERTY_TLC_39_ENABLED
public static final String PROPERTY_TRIOPTIC_ENABLED
public static final String PROPERTY_POSTAL_2D_MODE
POSTAL_2D_MODE_NONE
,
POSTAL_2D_MODE_AUSTRALIA
,
POSTAL_2D_MODE_INFOMAIL
,
POSTAL_2D_MODE_JAPAN
,
POSTAL_2D_MODE_CANADA
,
POSTAL_2D_MODE_DUTCH
,
POSTAL_2D_MODE_PLANET
,
POSTAL_2D_MODE_POSTNET
,
POSTAL_2D_MODE_BPO
,
POSTAL_2D_MODE_INFOMAIL_AND_BPO
,
POSTAL_2D_MODE_UPU
,
POSTAL_2D_MODE_USPS
,
POSTAL_2D_MODE_POSTNET_PLUS_BNB
,
POSTAL_2D_MODE_PLANET_AND_POSTNET
,
POSTAL_2D_MODE_PLANET_AND_UPU
,
POSTAL_2D_MODE_POSTNET_AND_UPU
,
POSTAL_2D_MODE_PLANET_AND_USPS
,
POSTAL_2D_MODE_POSTNET_AND_USPS
,
POSTAL_2D_MODE_UPU_AND_USPS
,
POSTAL_2D_MODE_PLANET_AND_POSTNET_PLUS_BNB
,
POSTAL_2D_MODE_POSTNET_AND_UPU_PLUS_BNB
,
POSTAL_2D_MODE_POSTNET_AND_USPS_PLUS_BNB
,
POSTAL_2D_MODE_PLANET_AND_POSTNET_AND_UPU
,
POSTAL_2D_MODE_PLANET_AND_POSTNET_AND_USPS
,
POSTAL_2D_MODE_PLANET_AND_UPU_AND_USPS
,
POSTAL_2D_MODE_POSTNET_AND_UPU_AND_USPS
,
POSTAL_2D_MODE_PLANET_AND_POSTNET_AND_UPU_PLUS_BNB
,
POSTAL_2D_MODE_PLANET_AND_POSTNET_AND_USPS_PLUS_BNB
,
POSTAL_2D_MODE_POSTNET_AND_UPU_AND_USPS_PLUS_BNB
,
POSTAL_2D_MODE_PLANET_AND_POSTNET_AND_UPU_AND_USPS
,
POSTAL_2D_MODE_PLANET_AND_POSTNET_AND_UPU_AND_USPS_PLUS_BNB
,
Constant Field Valuespublic static final String PROPERTY_POSTAL_2D_POSTNET_CHECK_DIGIT_TRANSMIT_ENABLED
PROPERTY_POSTAL_2D_MODE
,
Constant Field Valuespublic static final String PROPERTY_POSTAL_2D_PLANET_CHECK_DIGIT_TRANSMIT_ENABLED
PROPERTY_POSTAL_2D_MODE
,
Constant Field Valuespublic static final String POSTAL_2D_MODE_NONE
PROPERTY_POSTAL_2D_MODE
,
Constant Field Valuespublic static final String POSTAL_2D_MODE_AUSTRALIA
PROPERTY_POSTAL_2D_MODE
,
Constant Field Valuespublic static final String POSTAL_2D_MODE_INFOMAIL
PROPERTY_POSTAL_2D_MODE
,
Constant Field Valuespublic static final String POSTAL_2D_MODE_JAPAN
PROPERTY_POSTAL_2D_MODE
,
Constant Field Valuespublic static final String POSTAL_2D_MODE_CANADA
PROPERTY_POSTAL_2D_MODE
,
Constant Field Valuespublic static final String POSTAL_2D_MODE_DUTCH
PROPERTY_POSTAL_2D_MODE
,
Constant Field Valuespublic static final String POSTAL_2D_MODE_PLANET
PROPERTY_POSTAL_2D_MODE
,
Constant Field Valuespublic static final String POSTAL_2D_MODE_POSTNET
PROPERTY_POSTAL_2D_MODE
,
Constant Field Valuespublic static final String POSTAL_2D_MODE_BPO
PROPERTY_POSTAL_2D_MODE
,
Constant Field Valuespublic static final String POSTAL_2D_MODE_INFOMAIL_AND_BPO
PROPERTY_POSTAL_2D_MODE
,
Constant Field Valuespublic static final String POSTAL_2D_MODE_UPU
PROPERTY_POSTAL_2D_MODE
,
Constant Field Valuespublic static final String POSTAL_2D_MODE_USPS
PROPERTY_POSTAL_2D_MODE
,
Constant Field Valuespublic static final String POSTAL_2D_MODE_POSTNET_PLUS_BNB
PROPERTY_POSTAL_2D_MODE
,
Constant Field Valuespublic static final String POSTAL_2D_MODE_PLANET_AND_POSTNET
PROPERTY_POSTAL_2D_MODE
,
Constant Field Valuespublic static final String POSTAL_2D_MODE_PLANET_AND_UPU
PROPERTY_POSTAL_2D_MODE
,
Constant Field Valuespublic static final String POSTAL_2D_MODE_POSTNET_AND_UPU
PROPERTY_POSTAL_2D_MODE
,
Constant Field Valuespublic static final String POSTAL_2D_MODE_PLANET_AND_USPS
PROPERTY_POSTAL_2D_MODE
,
Constant Field Valuespublic static final String POSTAL_2D_MODE_POSTNET_AND_USPS
PROPERTY_POSTAL_2D_MODE
,
Constant Field Valuespublic static final String POSTAL_2D_MODE_UPU_AND_USPS
PROPERTY_POSTAL_2D_MODE
,
Constant Field Valuespublic static final String POSTAL_2D_MODE_PLANET_AND_POSTNET_PLUS_BNB
PROPERTY_POSTAL_2D_MODE
,
Constant Field Valuespublic static final String POSTAL_2D_MODE_POSTNET_AND_UPU_PLUS_BNB
PROPERTY_POSTAL_2D_MODE
,
Constant Field Valuespublic static final String POSTAL_2D_MODE_POSTNET_AND_USPS_PLUS_BNB
PROPERTY_POSTAL_2D_MODE
,
Constant Field Valuespublic static final String POSTAL_2D_MODE_PLANET_AND_POSTNET_AND_UPU
PROPERTY_POSTAL_2D_MODE
,
Constant Field Valuespublic static final String POSTAL_2D_MODE_PLANET_AND_POSTNET_AND_USPS
PROPERTY_POSTAL_2D_MODE
,
Constant Field Valuespublic static final String POSTAL_2D_MODE_PLANET_AND_UPU_AND_USPS
PROPERTY_POSTAL_2D_MODE
,
Constant Field Valuespublic static final String POSTAL_2D_MODE_POSTNET_AND_UPU_AND_USPS
PROPERTY_POSTAL_2D_MODE
,
Constant Field Valuespublic static final String POSTAL_2D_MODE_PLANET_AND_POSTNET_AND_UPU_PLUS_BNB
PROPERTY_POSTAL_2D_MODE
,
Constant Field Valuespublic static final String POSTAL_2D_MODE_PLANET_AND_POSTNET_AND_USPS_PLUS_BNB
PROPERTY_POSTAL_2D_MODE
,
Constant Field Valuespublic static final String POSTAL_2D_MODE_POSTNET_AND_UPU_AND_USPS_PLUS_BNB
PROPERTY_POSTAL_2D_MODE
,
Constant Field Valuespublic static final String POSTAL_2D_MODE_PLANET_AND_POSTNET_AND_UPU_AND_USPS
PROPERTY_POSTAL_2D_MODE
,
Constant Field Valuespublic static final String POSTAL_2D_MODE_PLANET_AND_POSTNET_AND_UPU_AND_USPS_PLUS_BNB
PROPERTY_POSTAL_2D_MODE
,
Constant Field Valuespublic static final String PROPERTY_DATA_PROCESSOR_CHARSET
public static final String PROPERTY_DATA_PROCESSOR_PREFIX
public static final String PROPERTY_DATA_PROCESSOR_SUFFIX
public static final String PROPERTY_DATA_PROCESSOR_SYMBOLOGY_PREFIX
public static final String DATA_PROCESSOR_SYMBOLOGY_ID_NONE
public static final String DATA_PROCESSOR_SYMBOLOGY_ID_HONEYWELL
public static final String DATA_PROCESSOR_SYMBOLOGY_ID_AIM
public static final String PROPERTY_DATA_PROCESSOR_LAUNCH_BROWSER
BarcodeReadEvent
if
this property is true. It is true by default.public static final String PROPERTY_DATA_PROCESSOR_SCAN_TO_INTENT
BarcodeReadEvent
if
this property is true. It is true by default.public static final String PROPERTY_DATA_PROCESSOR_LAUNCH_EZ_CONFIG
BarcodeReadEvent
if this property is true. It is true by default.public static final String PROPERTY_GROUP_SYMBOLOGY
BarcodeReader#startPropertyEditor(Context, String)
,
Constant Field Valuespublic static final String PROPERTY_GROUP_IMAGER
BarcodeReader#startPropertyEditor(Context, String)
,
Constant Field Valuespublic static final String PROPERTY_GROUP_TRIGGER
BarcodeReader#startPropertyEditor(Context, String)
,
Constant Field Valuespublic static final String PROPERTY_GROUP_NOTIFICATION
BarcodeReader#startPropertyEditor(Context, String)
,
Constant Field Valuespublic static final String PROPERTY_GROUP_DATA_PROCESSING
BarcodeReader#startPropertyEditor(Context, String)
,
Constant Field Valuespublic static final String PROPERTY_OCR_MODE
public static final String POSTAL_OCR_MODE_OFF
PROPERTY_OCR_MODE
,
Constant Field Valuespublic static final String POSTAL_OCR_MODE_NORMAL
PROPERTY_OCR_MODE
,
Constant Field Valuespublic static final String POSTAL_OCR_MODE_INVERSE
PROPERTY_OCR_MODE
,
Constant Field Valuespublic static final String POSTAL_OCR_MODE_NORMAL_AND_INVERSE
PROPERTY_OCR_MODE
,
Constant Field Valuespublic static final String PROPERTY_OCR_ACTIVE_TEMPLATE
public static final String PROPERTY_OCR_TEMPLATE
public static final String PROPERTY_CENTER_DECODE
public static final String PROPERTY_DECODE_WINDOW_TOP
PROPERTY_CENTER_DECODE
,
Constant Field Valuespublic static final String PROPERTY_DECODE_WINDOW_BOTTOM
PROPERTY_CENTER_DECODE
,
Constant Field Valuespublic static final String PROPERTY_DECODE_WINDOW_LEFT
PROPERTY_CENTER_DECODE
,
Constant Field Valuespublic static final String PROPERTY_DECODE_WINDOW_RIGHT
PROPERTY_CENTER_DECODE
,
Constant Field Valuespublic static final String GOOD_READ_NOTIFICATION
public static final String BAD_READ_NOTIFICATION
public static final Parcelable.Creator<BarcodeReader> CREATOR
public void addBarcodeListener(BarcodeReader.BarcodeListener listener)
Client activities should consider calling this method in onCreate() since event listener registration only needs to happen once time.
listener
- The callback that will runpublic void addTriggerListener(BarcodeReader.TriggerListener listener)
Client activities should consider calling this method in onCreate() since event listener registration only needs to happen once time.
listener
- The callback that will runpublic void removeBarcodeListener(BarcodeReader.BarcodeListener listener)
listener
- The callback to unregisterpublic void removeTriggerListener(BarcodeReader.TriggerListener listener)
listener
- The callback to unregisterpublic BarcodeReaderInfo getInfo() throws ScannerUnavailableException
ScannerUnavailableException
public void claim() throws ScannerUnavailableException
decode(boolean)
will throw
ScannerNotClaimedException
if claim()
has not been called.
Once claimed, the scanner will begin to post events to registered
event listeners.public void decode(boolean on) throws ScannerNotClaimedException, ScannerUnavailableException
on
- ScannerNotClaimedException
ScannerUnavailableException
public void aim(boolean on) throws ScannerNotClaimedException, ScannerUnavailableException
on
- ScannerNotClaimedException
ScannerUnavailableException
public void light(boolean on) throws ScannerNotClaimedException, ScannerUnavailableException
on
- ScannerNotClaimedException
ScannerUnavailableException
public Signature getSignature(SignatureParameters parameters) throws ScannerNotClaimedException, ScannerUnavailableException
parameters
- the signature parameters to useScannerUnavailableException
ScannerNotClaimedException
public void release()
public void close()
Calls made on this object after this call has been made will
result in an IllegalStateException
.
Once close()
has been called, any future calls on
this object will throw ScannerNotClaimedException
.
If the client application later needs to use the scanner again,
a new BarcodeReader
object must be created by calling
new AidcManager.createBarcodeReader(String)
.
Client activities should call this method in onClose() to terminate the scanner session prior to exiting.
public void setProperty(String name, int value) throws UnsupportedPropertyException
Property names can be found in Symbology
name
- The name of the property to setvalue
- The value to setUnsupportedPropertyException
public void setProperty(String name, boolean value) throws UnsupportedPropertyException
Property names can be found in Symbology
name
- The name of the property to setvalue
- The value to setUnsupportedPropertyException
public void setProperty(String name, String value) throws UnsupportedPropertyException
Property names can be found in Symbology
name
- The name of the property to setvalue
- The value to setUnsupportedPropertyException
public void setProperties(Map<String,Object> properties)
Property names can be found in Symbology
properties
- The properties to setpublic int getIntProperty(String name) throws UnsupportedPropertyException
name
- The name of the property to getUnsupportedPropertyException
public boolean getBooleanProperty(String name) throws UnsupportedPropertyException
name
- The name of the property to getUnsupportedPropertyException
public String getStringProperty(String name) throws UnsupportedPropertyException
name
- The name of the property to getUnsupportedPropertyException
public Map<String,Object> getProperties(Set<String> names)
getAllProperties()
can be used to
get the map of all properties.names
- The names of the properties to getpublic Map<String,Object> getAllProperties()
public Map<String,Object> getAllDefaultProperties()
public void notify(String notification)
notification
- indicates which event to signal to the userGOOD_READ_NOTIFICATION
,
BAD_READ_NOTIFICATION
public Bitmap captureImage()
public void startPropertyEditor(Context context)
BarcodeReader
context
- Which context to use to start the settings activitypublic void startPropertyEditor(Context context, String propertyGroup, String activityTitle)
BarcodeReader
context
- Which context to use to start the settings activitypropertyGroup
- Which property group to start the settings activity in.activityTitle
- Settings Activity Titlepublic void softwareTrigger(boolean state) throws ScannerNotClaimedException, ScannerUnavailableException
state
- Whether to trigger the scanner on or offScannerNotClaimedException
ScannerUnavailableException
public int describeContents()
describeContents
in interface Parcelable
public void writeToParcel(Parcel dest, int flags)
writeToParcel
in interface Parcelable
Copyright (c) 2015 Honeywell International Inc. All Rights Reserved.