Barcode

Overview

The Barcode Module controls functionality of the device scanner. Check the platform indicators in each property or method section. If developing for a device with only a camera, the number of symbologies available will be limited only to the most common such as EAN13 and UPCA, and scanning will be available only through the device camera. If the app is running on more well-equipped hardware, finer control over a more fully featured Scanner wilol be available, often with a choice of scanner hardware to use on the device.

If the use case involves capturing a single barcode (for example, a pricing kiosk app) Zebra recommends using the Barcode.take(callback) method. If the app will decode multiple barcode types common in enterprise scenarios (for example a warehouse inventory and receiving app), Zebra recommends using the Barcode.enable(callback) method.

Notes:

• Only foreground apps have access to scanning hardware. When an app is sent to the background, its state is saved and scanner control is automatically relinquished. When a scanner app returns to the foreground, its previous state is reapplied.

• On the VC70, the scanner will work only if connected in SSI Mode.

• The RE 2.x Scanner API and the EB 1.x Barcode API should not be used simultaneously in any Enterprise Browser application; only one or the other should be used.

Enabling the API

There are two methods of enabling the Barcode API:

• Include all 'ebapi' modules
• Include only the required API modules

For either of these methods, one or more files must be copied to the device from the /Enterprise Browser/JavaScript Files/Enterprise Browser directory on the computer that contains the Enterprise Browser installation.

Include all API modules

To include all APIs, copy the ebapi-modules.js file to a location accessible by the app's files and include a reference to the JavaScript file in the app's HTML. For instance, to include the modules file in the app's index.html, copy the file to the same directory as that index.html and add the following line to the HTML's HEAD section:

<script type="text/javascript" charset="utf-8" src="ebapi-modules.js"></script>

The code above defines the EB class within the page. Note that the path for this file is relative to the current page (index.html). Any page on which the modules are required must include a reference to the required .js file(s) in this fashion.

Include only the required modules

To include individual APIs, first include a reference to the ebapi.js module in the HTML, and then the additional required API file(s). For instance, to use the Barcode API, add the following code to the HTML file(s), assuming the API files have been copied to the same directory as the HTML.

<script type="text/javascript" charset="utf-8" src="ebapi.js"></script>
<script type="text/javascript" charset="utf-8" src="eb.barcode.js"></script>

In the lines above, notice that ebapi.js is included first, followed by eb.barcode.js, which is the Barcode API for Enterprise Browser. This coding is required on each HTML page whenever an individual API will be called from that page.

Methods

addConnectionListener()

If you are using an RS507/RS6000/RS4000 barcode scanner you can add a connection listener to receive connected or disconnected callbacks through this method.

Parameters

• callback : CallBackHandler

Callback

Async Callback Returning Parameters: HASH

• connectionState : STRING

  The message describing the connection: Connected or Disconnected.

• connectionType : STRING

  The message describes the connection type removed/attached scanner: Bluetooth_SSI, Serial_SSI etc.

• decoderType : STRING

  The message describes the decode type of removed/attached scanner: ONE_DIMENSIONAL, TWO_DIMENSIONAL etc.

• deviceType : STRING

  The message describes the device type of removed/attached scanner: IMAGER, CAMERA etc.

• friendlyName : STRING

  The message describes the friendly name of removed/attached scanner: BLUETOOTH SCANNER,2D IMAGER,CAMERA SCANNER Disconnected.

• isDefaultScanner : STRING

  The message describes wether removed/attached scanner is a default scanner: true or false.

Returns

Synchronous Return:

• Void

Platforms

• Android
• Zebra Devices Only

Method Access:

• Instance Method: This method can be accessed via an instance object of this class:
  • myObject.addConnectionListener()
• Default Instance: This method can be accessed via the default instance object of this class.
  • EB.Barcode.addConnectionListener()

barcode_recognize(STRING imageFilePath)

Recognizes a barcode on an image. Returns a string with recognized code, or empty string if the barcode is not recognized.

Parameters

• imageFilePath : STRING

  Path to the image that contains the barcode to be recognized.

• callback : CallBackHandler

Callback

Async Callback Returning Parameters: STRING

Returns

Synchronous Return:

• STRING : String with recognized code, or empty string if the barcode is not recognized.

Platforms

• Android

Method Access:

• Instance Method: This method can be accessed via an instance object of this class:
  • myObject.barcode_recognize(STRING imageFilePath)
• Default Instance: This method can be accessed via the default instance object of this class.
  • EB.Barcode.barcode_recognize(STRING imageFilePath)

commandRemoteScanner(STRING command)

Instruct the connected RS507 scanner to perform some action.

Parameters

• command : STRING

  The action the RS507 scanner should perform, can be 'Disconnect' which disconnects the bluetooth RS507; 'unpair' which unpairs the RS507 from the device for association with another device; 'StartPaging' or 'StopPaging' which will cause the RS507 scanner to start or stop emitting a beep, to allow it to be located.

• callback : CallBackHandler

Returns

Synchronous Return:

• Void

Platforms

• Windows Mobile
• Zebra Devices Only

Method Access:

• Instance Method: This method can be accessed via an instance object of this class:
  • myObject.commandRemoteScanner(STRING command)
• Default Instance: This method can be accessed via the default instance object of this class.
  • EB.Barcode.commandRemoteScanner(STRING command)

disable()

Disables the barcode scanner. This reverts the scanner to its default state and flushes any current decoder settings.

Parameters

• callback : CallBackHandler

Returns

Synchronous Return:

• Void

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only

Method Access:

• Instance Method: This method can be accessed via an instance object of this class:
  • myObject.disable()
• Default Instance: This method can be accessed via the default instance object of this class.
  • EB.Barcode.disable()

enable(HASH propertyMap)

Enabling the scanner puts it in a state where it will respond to the trigger (on devices with a hardware trigger) or will accept a command to initiate a soft scan (start method). Scanned barcodes will be available to the application through the callback provided to this method. Only one scanner on the device can be enabled at any one time, to switch between the imager and camera scanners (for example) then first disable the currently enabled scanner. If you do not specify a callback to this method you will received the scanned data as keystrokes. Note that it is necessary to enable the scanner on WM/CE devices prior to being able to retrieve the state of properties.

Parameters

• propertyMap : HASH Optional

  Provide a set of properties to configure the scanner, for example enable specific symbologies or check digits. Valid `properties` for this parameter are the properties available to this API module. Check the property section for applicable properties. Not providing properties to this function will use the scanner's default properties, or those previously set on the Scanner instance.

• callback : CallBackHandler

Callback

Async Callback Returning Parameters: HASH

• data : STRING

  The data decoded by the scanner or imaging device.

• source : STRING

  The source device and human readable decoder type of the decoded barcode or symbol.

• type : STRING

  Hex value representing the decoder type.

• time : STRING

  The time at which the decode occurred (hh:mm:ss)

• length : STRING

  The length of the decoded barcode or symbol.

• direction : STRING

  The direction the barcode was scanned, either forward, reverse or unavailable.

Returns

Synchronous Return:

• Void

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only

Method Access:

• Instance Method: This method can be accessed via an instance object of this class:
  • myObject.enable(HASH propertyMap)
• Default Instance: This method can be accessed via the default instance object of this class.
  • EB.Barcode.enable(HASH propertyMap)

enumerate()

Used to gain access to all scanner objects present on the device. For consumer devices you will most likely only have a single scanner, your device's camera but Enterprise grade hardware may have two or more scanners attached.

Parameters

• callback : CallBackHandler

Callback

Async Callback Returning Parameters: ARRAY

• Object : SELF_INSTANCE: EB.Barcode

Returns

Synchronous Return:

• Void

Platforms

• Android
• Windows Mobile
• Windows CE

Method Access:

• Class Method: This method can only be accessed via the API class object.
  • EB.Barcode.enumerate()

getAllProperties()

This method will return all of object/value pairs for the propertyNames of the API class.

Parameters

• callback : CallBackHandler

Callback

Async Callback Returning Parameters: HASH

• : STRING

Returns

Synchronous Return:

• HASH : Map of all available properties
  • : STRING

Platforms

• Android
• Windows Mobile

Method Access:

• Instance Method: This method can be accessed via an instance object of this class:
  • myObject.getAllProperties()
• Default Instance: This method can be accessed via the default instance object of this class.
  • EB.Barcode.getAllProperties()

getDefault()

This method will return an object that represents the default instance of the API Class. For example Camera.getDefault will return a Camera object that represents the default camera.

Parameters

• callback : CallBackHandler

Callback

Async Callback Returning Parameters: SELF_INSTANCE

Returns

Synchronous Return:

• SELF_INSTANCE : Default object of Module.

Platforms

• Android
• Windows Mobile

Method Access:

• Class Method: This method can only be accessed via the API class object.
  • EB.Barcode.getDefault()

getProperties(ARRAY arrayofNames)

This method will return a set of object/value pairs for the list of the propertyName that is passed in. The propertyNames must be a valid property of the API class.

Parameters

• arrayofNames : ARRAY

  List of properties I want to know about

• Object : STRING

• callback : CallBackHandler

Callback

Async Callback Returning Parameters: HASH

• : STRING

Returns

Synchronous Return:

• HASH : Map of properties I want to know about
  • : STRING

Platforms

• Android
• Windows Mobile

Method Access:

• Instance Method: This method can be accessed via an instance object of this class:
  • myObject.getProperties(ARRAY arrayofNames)
• Default Instance: This method can be accessed via the default instance object of this class.
  • EB.Barcode.getProperties(ARRAY arrayofNames)

getProperty(STRING propertyName)

This method will return the value of the propertyName that is passed in. The propertyName must be a valid property of the API class.

Parameters

• propertyName : STRING

  The property to return info about.

• callback : CallBackHandler

Callback

Async Callback Returning Parameters: STRING

Returns

Synchronous Return:

• STRING : The property to return info about.

Platforms

• Android
• Windows Mobile

Method Access:

• Instance Method: This method can be accessed via an instance object of this class:
  • myObject.getProperty(STRING propertyName)
• Default Instance: This method can be accessed via the default instance object of this class.
  • EB.Barcode.getProperty(STRING propertyName)

getSupportedProperties()

Return array of properties supported by this scanner.

Parameters

• callback : CallBackHandler

Callback

Async Callback Returning Parameters: ARRAY

• Object : STRING

Returns

Synchronous Return:

• ARRAY : Array of property names supported by this scanner.
  • Object : STRING

Platforms

• Android
• Windows Mobile
• Zebra Devices Only

Method Access:

• Instance Method: This method can be accessed via an instance object of this class:
  • myObject.getSupportedProperties()
• Default Instance: This method can be accessed via the default instance object of this class.
  • EB.Barcode.getSupportedProperties()

registerBluetoothStatus()

If you are using an RS507 barcode scanner you can register to receive connected or disconnected events through this method.

Parameters

• callback : CallBackHandler

Callback

Async Callback Returning Parameters: HASH

• status : STRING

  The message describing the bluetooth connection: BluetoothConnected, BluetoothDisconnected or BTScanAssociationBarcode. See below for further descriptions.

Returns

Synchronous Return:

• Void

Platforms

• Windows Mobile
• Zebra Devices Only

Method Access:

• Instance Method: This method can be accessed via an instance object of this class:
  • myObject.registerBluetoothStatus()
• Default Instance: This method can be accessed via the default instance object of this class.
  • EB.Barcode.registerBluetoothStatus()

removeConnectionListener()

If you are using an RS507/RS6000/RS4000 barcode scanner you can remove a connection listener to receive connected or disconnected callbacks through this method.

Parameters

• callback : CallBackHandler

Returns

Synchronous Return:

• Void

Platforms

• Android
• Zebra Devices Only

Method Access:

• Instance Method: This method can be accessed via an instance object of this class:
  • myObject.removeConnectionListener()
• Default Instance: This method can be accessed via the default instance object of this class.
  • EB.Barcode.removeConnectionListener()

setDefault(SELF_INSTANCE: EB.Barcode defaultInstance)

This method allows you to set the attributes of the default object instance by passing in an object of the same class.

Parameters

• defaultInstance : SELF_INSTANCE: EB.Barcode

  An instance object that is of the same class.

• callback : CallBackHandler

Returns

Synchronous Return:

• Void

Platforms

• Android
• Windows Mobile

Method Access:

• Class Method: This method can only be accessed via the API class object.
  • EB.Barcode.setDefault(SELF_INSTANCE: EB.Barcode defaultInstance)

setProperties(HASH propertyMap)

This method will set the values of a list of properties for the API class. The propertyName must be a valid property for the class and must also not be read only.

Parameters

• propertyMap : HASH

  Map of properties I want to set

• Object : STRING

• callback : CallBackHandler

Returns

Synchronous Return:

• Void

Platforms

• Android
• Windows Mobile

Method Access:

• Instance Method: This method can be accessed via an instance object of this class:
  • myObject.setProperties(HASH propertyMap)
• Default Instance: This method can be accessed via the default instance object of this class.
  • EB.Barcode.setProperties(HASH propertyMap)

setProperty(STRING propertyName, STRING propertyValue)

This method will set the value of a property for the API class. The propertyName must be a valid property for the class and must also not be read only.

Parameters

• propertyName : STRING

  The one property name that I want to set

• propertyValue : STRING

  The one property value that I want to set

• callback : CallBackHandler

Returns

Synchronous Return:

• Void

Platforms

• Android
• Windows Mobile

Method Access:

• Instance Method: This method can be accessed via an instance object of this class:
  • myObject.setProperty(STRING propertyName, STRING propertyValue)
• Default Instance: This method can be accessed via the default instance object of this class.
  • EB.Barcode.setProperty(STRING propertyName, STRING propertyValue)

start()

Performs a soft trigger start, initiating a scan without pressing the hardware trigger. If the scan does not result in a decode it is necessary to perform a soft stop before another soft start.

Parameters

• callback : CallBackHandler

Returns

Synchronous Return:

• Void

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only

Method Access:

• Instance Method: This method can be accessed via an instance object of this class:
  • myObject.start()
• Default Instance: This method can be accessed via the default instance object of this class.
  • EB.Barcode.start()

stop()

Performs a soft trigger stop.

Parameters

• callback : CallBackHandler

Returns

Synchronous Return:

• Void

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only

Method Access:

• Instance Method: This method can be accessed via an instance object of this class:
  • myObject.stop()
• Default Instance: This method can be accessed via the default instance object of this class.
  • EB.Barcode.stop()

take(HASH propertyMap)

Enable the scanner and start capturing the barcode automatically. On Symbol Technologies' devices the amount of time to scan the barcode is defined by the scanTimeout property. On Android if a barcode is found, the user can confirm barcode recognition, or continue to try to recognize the barcode. When the user confirms or cancels, the callback is called. Once the callback has been called the barcode hardware is disabled.This method will work only on scanners which support soft scan.

Parameters

• propertyMap : HASH Optional

  Provide a set of properties to configure the scanner, for example enable specific symbologies or check digits. Valid `properties` for this parameter are the properties available to this API module. Check the property section for applicable properties. Not providing properties to this function will use the scanner's default properties, or those previously set on the Scanner instance.

• callback : CallBackHandler

Callback

Async Callback Returning Parameters: HASH

• barcode : STRING

  The data decoded by the scanner or imaging device.

• status : STRING

  Whether or not the barcode was successfully scanned, status will be 'ok' or 'cancel'

Returns

Synchronous Return:

• Void

Platforms

• Android
• Windows Mobile
• Windows CE

Method Access:

• Instance Method: This method can be accessed via an instance object of this class:
  • myObject.take(HASH propertyMap)
• Default Instance: This method can be accessed via the default instance object of this class.
  • EB.Barcode.take(HASH propertyMap)

Properties

adaptiveScanning

Type

BOOLEAN

Description

Enables or disables adaptive scanning. When set to true, the scan engine will automatically toggle between 2 scan angles, wide and narrow, allowing the scan engine to decode barcodes both in close proximity and far away (~100 inches). Adaptive scanning is only supported in high performance, long working range scan engines such as SE960.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.adaptiveScanning
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.adaptiveScanning

Platforms

• Windows Mobile
• Zebra Devices Only(Laser Scanners on Symbol Technologies' devices)

aimMode

Type

STRING

Description

Defines the aiming mode to use.

Values

Possible Values (STRING):

• Constant: EB.Barcode.AIMMODE_NONE - String: none No Aiming (Can be overridden by picklistMode).
• Constant: EB.Barcode.AIMMODE_DOT - String: dot Laser barcode readers will show a dot for aiming.
• Constant: EB.Barcode.AIMMODE_SLAB - String: slab Laser barcode readers will show a slab for aiming.
• Constant: EB.Barcode.AIMMODE_RETICLE - String: reticle Imager barcode readers will show a reticle for aiming.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.aimMode
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.aimMode

Platforms

• Windows Mobile
• Zebra Devices Only(Scanners on Symbol Technologies' devices)

aimType

Type

STRING

Description

Describes the type of aiming to use.

Values

Possible Values (STRING):

• Constant: EB.Barcode.AIMTYPE_TRIGGER - String: trigger Standard trigger mode. Holding the trigger will start a decoding session.
• Constant: EB.Barcode.AIMTYPE_TIMED_HOLD - String: timedHold Aiming lasts for the time specified by 'timedAimDuration' before decoding. The opportunity to scan will last until the barcode is decoded or scanTimeout occurs.
• Constant: EB.Barcode.AIMTYPE_TIMED_RELEASE - String: timedRelease Aiming lasts until trigger is released. If the timedAimDuration has expired when the trigger is released then a decode session is started until a barcode is decoded or for the remaining time equal to the scanTimeout value.
• Constant: EB.Barcode.AIMTYPE_PRESENTATION - String: presentation Provided to support Kiosk devices. The scanner illuminates when movement is detected in the range of the scanner window. In order to use this mode the scanner must be initiated with a softscan using the EB.Barcode.start() method and again after each decode. The device must be equipped with a sensor to detect movement to use presentation mode. MK31XX devices come with presentation mode pre-enabled in the scanner driver and the aimType cannot be modified for these devices.
• Constant: EB.Barcode.AIMTYPE_PRESS_AND_RELEASE - String: pressAndRelease Scan will continue after the trigger is released until scanTimeout occurs.
• Constant: EB.Barcode.AIMTYPE_CONTINUOUS_READ - String: continuousRead Once the trigger is pulled barcodes will continue to be scanned as long as the trigger is held, enabling rapid scanning, to be used in conjunction with sameSymbolTimeout and differentSymbolTimeout. This value is ignored if viewfinderMode is set to 'dynamicReticle'

Access

• Instance: This property can be accessed via an instance object of this class: myObject.aimType
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.aimType

Platforms

• Windows Mobile
• Zebra Devices Only(Scanners on Symbol Technologies' devices)

allDecoders

Type

BOOLEAN

Description

When set to true, the barcode scanner will read all barcode types that the scanner is capable of reading. When set to false, the barcode scanner will not be able to decode any symbologies, this is most useful if you want to set the scanner to a default state before only enabling your required symbologies. The fewer symbologies that are enabled the faster the decoding performance of the scanning engine will be. This property will return true only if all supported symbologies by the scanner are enabled, if only a subset of supported symbologies are enabled then false will be returned. Note that some decoders will not be enabled as some symbologies use the same systems to encode data, making it impossible to differentiate between them. For example: "canpostal" and "auspostal" both use a 4-state system, so devices will only enable either "canpostal" OR "auspostal" when "alldecoders" is enabled. Note that other symbologies also share the 4-state system.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.allDecoders
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.allDecoders

Platforms

• Android
• Windows Mobile
• Windows CE(Scanners on Symbol Technologies' devices)

ausPostal

Type

BOOLEAN

Description

Enables or disables the symbology for Australian Postal barcodes. If your application does not expect to scan this symbology you should disable it to improve scanning performance.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.ausPostal
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.ausPostal

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

autoEnter

Type

BOOLEAN

Description

When true, automatically appends the character code for 'enter' to the end of any barcodes scanned. This is useful if you want to submit forms following a scan without further interaction. This property will only take effect if you have not specified a callback to the enable method. AutoEnter and AutoTab are mutually exclusive properties.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.autoEnter
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.autoEnter

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only(Scanners on Symbol Technologies' devices)

autoTab

Type

BOOLEAN

Description

When true, automatically appends the tab character to the end of any barcodes scanned. This is useful if you are populating a form and want to jump to the next field in the form without further interaction. This property will only take effect if you have not specified a callback to the enable method. AutoTab and AutoEnter are mutually exclusive properties.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.autoTab
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.autoTab

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only(Scanners on Symbol Technologies' devices)

aztec

Type

BOOLEAN

Description

Enables or disables the symbology for Aztec barcodes. If your application does not expect to scan this symbology you should disable it to improve scanning performance.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.aztec
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.aztec

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

barcodeDataFormat

Type

STRING

Description

Specifies the format in which the barcode data is returned, binary data is returned in Data URI format with the appropriate mime type. This parameter is designed to be used primarily with image based symbologies (eg. Signature). Binary data will not be output as keystrokes, you must set a decode callback in order to receive scanned data.

Values

Possible Values (STRING):

• Constant: EB.Barcode.FORMAT_BINARY - String: binary Scanned data will be returned in Data URI format.
• Constant: EB.Barcode.FORMAT_TEXT - String: text Scanned data will be returned in Text format.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.barcodeDataFormat
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.barcodeDataFormat

Platforms

• Windows Mobile
• Zebra Devices Only(Camera / Imager Scanners on Symbol Technologies' devices)

beamWidth

Type

STRING

Description

Specifies the width of the laser beam. All devices will support normal beam widths but other widths may not be supported on your device.

Values

Possible Values (STRING):

• Constant: EB.Barcode.BEAM_NORMAL - String: normal Laser beam width is normal.
• Constant: EB.Barcode.BEAM_WIDE - String: wide Laser beam width is wide.
• Constant: EB.Barcode.BEAM_NARROW - String: narrow Laser beam width is narrow.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.beamWidth
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.beamWidth

Platforms

• Windows Mobile
• Zebra Devices Only(Laser Scanners on Symbol Technologies' devices)

bidirectionalRedundancy

Type

BOOLEAN

Description

Enables or disables bidirectional redundancy.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.bidirectionalRedundancy
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.bidirectionalRedundancy

Platforms

• Windows Mobile
• Zebra Devices Only(Laser Scanners on Symbol Technologies' devices)

canPostal

Type

BOOLEAN

Description

Enables or disables the symbology for Canadian Postal barcodes. If your application does not expect to scan this symbology you should disable it to improve scanning performance.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.canPostal
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.canPostal

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

chinese2of5

Type

BOOLEAN

Description

Enables or disables the symbology for Chinese 2of5 barcodes. If your application does not expect to scan this symbology you should disable it to improve scanning performance.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.chinese2of5
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.chinese2of5

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

codabar

Type

BOOLEAN

Description

Enables or disables the symbology for Codabar barcodes. If your application does not expect to scan this symbology you should disable it to improve scanning performance.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.codabar
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.codabar

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

codabarClsiEditing

Type

BOOLEAN

Description

Enables Codabar CLSi formatting when set to true.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.codabarClsiEditing
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.codabarClsiEditing

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

codabarMaxLength

Type

INTEGER

Description

Specifies the maximum number of allowable characters in a Codabar barcode. If your application only expects barcode lengths in a certain range, reducing the allowed range can improve scanning performance. Allowed values are 0 to 55.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.codabarMaxLength
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.codabarMaxLength

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

codabarMinLength

Type

INTEGER

Description

Specifies the minimum number of allowable characters in a Codabar barcode. If your application only expects barcode lengths in a certain range, reducing the allowed range can improve scanning performance. Allowed values are 0 to 55.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.codabarMinLength
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.codabarMinLength

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

codabarNotisEditing

Type

BOOLEAN

Description

Enables Codabar NotisEditing formatting when set to true.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.codabarNotisEditing
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.codabarNotisEditing

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

codabarRedundancy

Type

BOOLEAN

Description

Sets the Codabar Redundancy property, if set the barcode must be decoded twice before being accepted. This will slow scanning but improve reliability.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.codabarRedundancy
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.codabarRedundancy

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

code11

Type

BOOLEAN

Description

Enables or disables the symbology for Code11 barcodes. If your application does not expect to scan this symbology you should disable it to improve scanning performance.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.code11
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.code11

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

code11checkDigitCount

Type

STRING

Description

Specifies whether to verify 0, 1 or 2 check digits.

Values

Possible Values (STRING):

• Constant: EB.Barcode.CODE11_CHECKDIGIT_NONE - String: none Scanning engine will verify no Code 11 check digits.
• Constant: EB.Barcode.CODE11_CHECKDIGIT_ONE - String: one Scanning engine will verify one Code 11 check digit.
• Constant: EB.Barcode.CODE11_CHECKDIGIT_TWO - String: two Scanning engine will verify two Code 11 check digits.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.code11checkDigitCount
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.code11checkDigitCount

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

code11maxLength

Type

INTEGER

Description

Specifies the maximum number of allowable characters in a Code 11 barcode. If your application only expects barcode lengths in a certain range, reducing the allowed range can improve scanning performance. Allowed values are 0 to 55.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.code11maxLength
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.code11maxLength

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

code11minLength

Type

INTEGER

Description

Specifies the minimum number of allowable characters in a Code 11 barcode. If your application only expects barcode lengths in a certain range, reducing the allowed range can improve scanning performance. Allowed values are 0 to 55.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.code11minLength
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.code11minLength

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

code11redundancy

Type

BOOLEAN

Description

Sets the Code 11 Redundancy property, if set the barcode must be decoded twice before being accepted. This will slow scanning but improve reliability.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.code11redundancy
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.code11redundancy

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

code11reportCheckDigit

Type

BOOLEAN

Description

When true, the barcode check digit(s) will be reported for scanned Code 11 barcodes.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.code11reportCheckDigit
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.code11reportCheckDigit

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

code128

Type

BOOLEAN

Description

Enables or disables the symbology for Code128 barcodes. If your application does not expect to scan this symbology you should disable it to improve scanning performance.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.code128
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.code128

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

code128checkIsBtTable

Type

BOOLEAN

Description

When true, decodes concatenated Code128 output only if the pair belongs to one of the commonly concatenated pairs as defined by the standard.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.code128checkIsBtTable
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.code128checkIsBtTable

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

code128ean128

Type

BOOLEAN

Description

When true, barcodes with the EAN128 subtype property set will be read.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.code128ean128
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.code128ean128

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

code128isbt128

Type

BOOLEAN

Description

When true, barcodes with the isbt128 subtype property set will be read.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.code128isbt128
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.code128isbt128

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

code128isbt128ConcatMode

Type

STRING

Description

Sets the Code128 ISBT concatenation mode property. This feature allows a pair of barcodes which meet certain criteria defined in the ISBT128 spec to be reported as a single barcode. This parameter describes the different concatenation modes available for ISBT128.

Values

Possible Values (STRING):

• Constant: EB.Barcode.CODE128ISBT_NEVER - String: never Will ignore the barcode pair and only output decode data for one of the barcodes.
• Constant: EB.Barcode.CODE128ISBT_ALWAYS - String: always Will not decode if both barcodes are not present or if one of them can not be decoded.
• Constant: EB.Barcode.CODE128ISBT_AUTO - String: auto Auto-Discriminate.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.code128isbt128ConcatMode
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.code128isbt128ConcatMode

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

code128maxLength

Type

INTEGER

Description

Specifies the maximum number of allowable characters in a Code 128 barcode. If your application only expects barcode lengths in a certain range, reducing the allowed range can improve scanning performance. Allowed values are 0 to 55.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.code128maxLength
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.code128maxLength

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

code128minLength

Type

INTEGER

Description

Specifies the minimum number of allowable characters in a Code 128 barcode. If your application only expects barcode lengths in a certain range, reducing the allowed range can improve scanning performance. Allowed values are 0 to 55.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.code128minLength
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.code128minLength

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

code128other128

Type

BOOLEAN

Description

Sets the other 128 property which enables the non EAN and non ISBT 128 subtype.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.code128other128
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.code128other128

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

code128redundancy

Type

BOOLEAN

Description

Sets the Code 128 Redundancy property, if set the barcode must be decoded twice before being accepted. This will slow scanning but improve reliability.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.code128redundancy
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.code128redundancy

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

code128securityLevel

Type

INTEGER

Description

Sets the Code 128 security level and accepts a value between 0 and 3 inclusive. 0: Allows the scanner to operate in its most aggressive state, while providing sufficient security in decoding most 'in-spec' barcodes. 1: Eliminates most mis-decodes. 2: Select this option if security level 1 fails to eliminate mis-decodes. 3: Select this option if security level 1 and 2 fail to eliminate mis-decodes. Be advised that selecting level 3 is an extreme measure against mis-decoding and will significantly impair the decoding ability of the scanner.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.code128securityLevel
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.code128securityLevel

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

code39

Type

BOOLEAN

Description

Enables or disables the symbology for Code 39 barcodes. If your application does not expect to scan this symbology you should disable it to improve scanning performance.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.code39
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.code39

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

code39code32Prefix

Type

BOOLEAN

Description

Enables reporting of the Code32 prefix when a Code39 barcode is converted.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.code39code32Prefix
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.code39code32Prefix

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

code39convertToCode32

Type

BOOLEAN

Description

Enables conversion from Code39 to Code 32 barcodes, when set the decoded barcode is converted to Code 32.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.code39convertToCode32
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.code39convertToCode32

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

code39fullAscii

Type

BOOLEAN

Description

Enables full ASCII conversion of Code 39 barcodes.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.code39fullAscii
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.code39fullAscii

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

code39maxLength

Type

INTEGER

Description

Specifies the maximum number of allowable characters in a Code 39 barcode. If your application only expects barcode lengths in a certain range, reducing the allowed range can improve scanning performance. Allowed values are 0 to 55.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.code39maxLength
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.code39maxLength

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

code39minLength

Type

INTEGER

Description

Specifies the minimum number of allowable characters in a Code 39 barcode. If your application only expects barcode lengths in a certain range, reducing the allowed range can improve scanning performance. Allowed values are 0 to 55.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.code39minLength
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.code39minLength

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

code39redundancy

Type

BOOLEAN

Description

Sets the Code 39 Redundancy property, if set the barcode must be decoded twice before being accepted. This will slow scanning but improve reliability.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.code39redundancy
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.code39redundancy

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

code39reportCheckDigit

Type

BOOLEAN

Description

Enables reporting of the Code 39 check digit when a Code 39 barcode is scanned.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.code39reportCheckDigit
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.code39reportCheckDigit

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

code39securityLevel

Type

INTEGER

Description

Sets the Code 128 security level and accepts a value between 0 and 3 inclusive. 0: This setting allows the scanner to operate in its most aggressive state, while providing sufficient security in decoding most 'in-spec' barcodes. 1: This setting eliminates most mis-decodes. 2: Select this option if security level 1 fails to eliminate mis-decodes. 3: Select this option if security level 1 and 2 fail to eliminate mis-decodes. Be advised that selecting level 3 is an extreme measure against mis-decoding and will significantly impair the decoding ability of the scanner.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.code39securityLevel
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.code39securityLevel

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

code39verifyCheckDigit

Type

BOOLEAN

Description

Turns on verification of the Code 39 check digit.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.code39verifyCheckDigit
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.code39verifyCheckDigit

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

code93

Type

BOOLEAN

Description

Enables or disables the symbology for Code 93 barcodes. If your application does not expect to scan this symbology you should disable it to improve scanning performance.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.code93
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.code93

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

code93maxLength

Type

INTEGER

Description

Specifies the maximum number of allowable characters in a Code 93 barcode. If your application only expects barcode lengths in a certain range, reducing the allowed range can improve scanning performance. Allowed values are 0 to 55.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.code93maxLength
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.code93maxLength

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

code93minLength

Type

INTEGER

Description

Specifies the minimum number of allowable characters in a Code 93 barcode. If your application only expects barcode lengths in a certain range, reducing the allowed range can improve scanning performance. Allowed values are 0 to 55.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.code93minLength
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.code93minLength

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

code93redundancy

Type

BOOLEAN

Description

Sets the Code 93 Redundancy property, if set the barcode must be decoded twice before being accepted. This will slow scanning but improve reliability.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.code93redundancy
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.code93redundancy

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

compositeAb

Type

BOOLEAN

Description

Enables or disables the symbology for Composite AB barcodes. If your application does not expect to scan this symbology you should disable it to improve scanning performance.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.compositeAb
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.compositeAb

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

compositeAbUccLinkMode

Type

STRING

Description

Describes whether UCC link mode is enabled.

Values

Possible Values (STRING):

• Constant: EB.Barcode.UCC_NEVER - String: never Link flag is ignored.
• Constant: EB.Barcode.UCC_ALWAYS - String: always Composite AB barcodes are always linked.
• Constant: EB.Barcode.UCC_AUTO - String: auto Auto-discriminate whether Composite AB barcodes are linked.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.compositeAbUccLinkMode
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.compositeAbUccLinkMode

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

compositeAbUseUpcPreambleCheckDigitRules

Type

BOOLEAN

Description

This setting causes the UPC rules specified in the UPC EAN parameters to be used when reporting composite decode data.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.compositeAbUseUpcPreambleCheckDigitRules
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.compositeAbUseUpcPreambleCheckDigitRules

Platforms

• Windows Mobile
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

compositeC

Type

BOOLEAN

Description

Enables or disables the symbology for Composite C barcodes. If your application does not expect to scan this symbology you should disable it to improve scanning performance.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.compositeC
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.compositeC

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

connectionIdleTimeout

Type

INTEGER

Description

Specifies the time, in seconds, that an external scanner will be allowed to remain idle before the connection is terminated to conserve power.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.connectionIdleTimeout
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.connectionIdleTimeout

Platforms

• Windows Mobile
• Zebra Devices Only(Bluetooth Scanners on Symbol Technologies' devices)

d2of5

Type

BOOLEAN

Description

Enables or disables the symbology for D2of5 barcodes. If your application does not expect to scan this symbology you should disable it to improve scanning performance.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.d2of5
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.d2of5

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

d2of5maxLength

Type

INTEGER

Description

Specifies the maximum number of allowable characters in a D2of5 barcode. If your application only expects barcode lengths in a certain range, reducing the allowed range can improve scanning performance. Allowed values are 0 to 55.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.d2of5maxLength
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.d2of5maxLength

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

d2of5minLength

Type

INTEGER

Description

Specifies the minimum number of allowable characters in a D2of5 barcode. If your application only expects barcode lengths in a certain range, reducing the allowed range can improve scanning performance. Allowed values are 0 to 55.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.d2of5minLength
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.d2of5minLength

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

d2of5redundancy

Type

BOOLEAN

Description

Sets the D2of5 Redundancy property, if set the barcode must be decoded twice before being accepted. This will slow scanning but improve reliability.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.d2of5redundancy
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.d2of5redundancy

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

dataBufferSize

Type

INTEGER

Description

Specifies the number of bytes allocated to receive the scanned barcode. This parameter is designed to be used primarily with image based symbologies and should not be modified unless absolutely necessary (eg. Signature).

Access

• Instance: This property can be accessed via an instance object of this class: myObject.dataBufferSize
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.dataBufferSize

Platforms

• Windows Mobile
• Zebra Devices Only(Scanners on Symbol Technologies' devices)

datamatrix

Type

BOOLEAN

Description

Enables or disables the symbology for Datamatrix barcodes. If your application does not expect to scan this symbology you should disable it to improve scanning performance.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.datamatrix
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.datamatrix

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

dbpMode

Type

STRING

Description

Describes the type of Digital Bar Pulse (DBP) being produced by the scan engine.

Values

Possible Values (STRING):

• Constant: EB.Barcode.DBP_NORMAL - String: normal Tells the scan engine to produce normal DBP.
• Constant: EB.Barcode.DBP_COMPOSITE - String: composite Tells the scan engine to produce composite DBP, which is 2 different sets of DBP data multiplexed together for better decode performance. In order to enable this mode it must be supported by the scanner.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.dbpMode
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.dbpMode

Platforms

• Windows Mobile
• Zebra Devices Only(Laser Scanners on Symbol Technologies' devices)

decodeDuration

Type

INTEGER

Description

The duration of the device beeper when a barcode is scanned, in milliseconds. It will accept values in the range 0 to 5000 milliseconds. Note: On Android platform, calling this method, the DecodeDuration config tags value will not be applied.

Params

Default: 250

Access

• Instance: This property can be accessed via an instance object of this class: myObject.decodeDuration
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.decodeDuration

Platforms

• Android(KitKat and above platform only)
• Windows Mobile
• Windows CE
• Zebra Devices Only(Scanners on Symbol Technologies' devices)

decodeFrequency

Type

INTEGER

Description

The frequency of the device beeper when a barcode is successfully decoded. This should be within the range of the beeper but the API will accept values in the range 0 to 65535. Note: On Android platform, calling this method, the DecodeFrequency config tags value will not be applied.

Params

Default: 3000

Access

• Instance: This property can be accessed via an instance object of this class: myObject.decodeFrequency
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.decodeFrequency

Platforms

• Android(KitKat and above platform only)
• Windows Mobile
• Windows CE
• Zebra Devices Only(Scanners on Symbol Technologies' devices)

decodeVolume

Type

INTEGER

Description

The volume of the device beeper when a barcode is scanned. It will accept values in the range 0 to 5. On Window Mobile/CE, the value of 0 is device dependent, some devices interpret this as the quietest volume. Note: On Android platform, calling this method, the DecodeVolume config tags value will not be applied.

Params

Default: 5

Access

• Instance: This property can be accessed via an instance object of this class: myObject.decodeVolume
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.decodeVolume

Platforms

• Android(KitKat and above platform only)
• Windows Mobile
• Windows CE
• Zebra Devices Only(Scanners on Symbol Technologies' devices)

decodeSound

Type

STRING

Description

Path to a local '.wav' file to be played when the scanner successfully decodes a barcode. The '.wav' file must reside on the device. This will override the existing scanner beeper settings. The decodeSound property doesnot rely on decodeDuration, decodeFrequency and decodeVolume properties. Calling this method, the ScanDecodeWav config tags value will not be applied. Note: On Android platform, '.ogg' file is also supported. See remarks section below.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.decodeSound
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.decodeSound

Platforms

• Android(KitKat and above platform only)
• Windows Mobile
• Windows CE
• Zebra Devices Only(Scanners on Symbol Technologies' devices)

differentSymbolTimeout

Type

INTEGER

Description

When the aimType:continuousRead property is applied this value defines the interval between which different barcodes can be scanned. The value is specified in milliseconds, use 0 to indicate no interval between successive reads. Use this setting to allow time for the operator to re-aim the device between successive scans.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.differentSymbolTimeout
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.differentSymbolTimeout

Platforms

• Windows Mobile
• Zebra Devices Only(Scanners on Symbol Technologies' devices)

disableScannerDuringNavigate

Type

BOOLEAN

Description

By default if you have enabled the Scanner on a page, through either JavaScript or Ruby and navigate to a new page the Scanner will automatically disable. To override this behavior you can set this option to false and once enabled the Scanner will remain so in the foreground application until you disable it.

Params

Default: true

Access

• Instance: This property can be accessed via an instance object of this class: myObject.disableScannerDuringNavigate
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.disableScannerDuringNavigate

Platforms

• Windows Mobile
• Zebra Devices Only(Scanners on Symbol Technologies' devices)

disconnectBtOnDisable

Type

BOOLEAN

Description

Forces the scanner to disconnect from the terminal when it is 'disabled'. Since the scanner is disabled when you navigate to a new page, set this value to false if you want to maintain the bluetooth connection to your remote scanner.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.disconnectBtOnDisable
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.disconnectBtOnDisable

Platforms

• Windows Mobile
• Zebra Devices Only(Bluetooth Scanners on Symbol Technologies' devices)

displayBtAddressBarcodeOnEnable

Type

BOOLEAN

Description

If set to true the bluetooth address will be displayed as a barcode on the screen during the pairing process, initiated by calling 'enable' on a bluetooth scanner. Not all devices support this functionality. Note you must specify this parameter before or within the call to 'enable'.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.displayBtAddressBarcodeOnEnable
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.displayBtAddressBarcodeOnEnable

Platforms

• Windows Mobile
• Zebra Devices Only(Bluetooth Scanners on Symbol Technologies' devices)

dpmMode

Type

BOOLEAN

Description

Allows Direct Part Marking (DPM) barcodes to be read When true, but may adversely affect overall decoding performance. DPM is a way of stamping barcodes directly on physical objects and is only available on DPM terminals.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.dpmMode
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.dpmMode

Platforms

• Windows Mobile
• Zebra Devices Only(Imager / Camera Scanners on Symbol Technologies' devices. The scanning engine must support DPM barcodes.)

dutchPostal

Type

BOOLEAN

Description

Enables or disables the symbology for Dutch Postal barcodes. If your application does not expect to scan this symbology you should disable it to improve scanning performance.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.dutchPostal
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.dutchPostal

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

ean13

Type

BOOLEAN

Description

Enables or disables the symbology for EAN 13 barcodes. If your application does not expect to scan this symbology you should disable it to improve scanning performance.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.ean13
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.ean13

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

ean8

Type

BOOLEAN

Description

Enables or disables the symbology for EAN 8 barcodes. If your application does not expect to scan this symbology you should disable it to improve scanning performance.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.ean8
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.ean8

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

ean8convertToEan13

Type

BOOLEAN

Description

When true, EAN 8 barcodes will be converted to EAN 13 and EAN 13 parameters used.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.ean8convertToEan13
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.ean8convertToEan13

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

enableTimeout

Type

INTEGER

Description

Configures the time (in seconds) allowed to pair with the external bluetooth scanner after calling the 'enable()' method. You must specify this parameter before calling 'enable' to change the default.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.enableTimeout
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.enableTimeout

Platforms

• Windows Mobile
• Zebra Devices Only(Bluetooth Scanners on Symbol Technologies' devices)

focusMode

Type

STRING

Description

Sets the focus mode in use.

Values

Possible Values (STRING):

• Constant: EB.Barcode.FOCUS_FIXED - String: fixed Use fixed focus.
• Constant: EB.Barcode.FOCUS_AUTO - String: auto Use auto focus.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.focusMode
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.focusMode

Platforms

• Windows Mobile
• Zebra Devices Only(Imager / Camera Scanners on Symbol Technologies' devices)

friendlyName

Type

STRING Read Only

Description

Returns the friendly name associated with the scanner.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.friendlyName
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.friendlyName

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only(Scanners on Symbol Technologies' devices)

gs1dataBar

Type

BOOLEAN

Description

Enables or disables the symbology for GS1 DataBar barcodes. If your application does not expect to scan this symbology you should disable it to improve scanning performance. This symbology was previously known as rss.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.gs1dataBar
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.gs1dataBar

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

gs1dataBarExpanded

Type

BOOLEAN

Description

Enables or disables the symbology for GS1 Databar Expanded barcodes. If your application does not expect to scan this symbology you should disable it to improve scanning performance. This symbology was previously known as rssExp.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.gs1dataBarExpanded
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.gs1dataBarExpanded

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

gs1dataBarLimited

Type

BOOLEAN

Description

Enables or disables the symbology for GS1 Databar Limited barcodes. If your application does not expect to scan this symbology you should disable it to improve scanning performance. This symbology was previously known as rssLim.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.gs1dataBarLimited
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.gs1dataBarLimited

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

hapticFeedback

Type

BOOLEAN

Description

Controls the haptic feedback on decode. This means that if this is set to true, then the device will vibrate when a decode occurs.

Params

Default: true

Access

• Instance: This property can be accessed via an instance object of this class: myObject.hapticFeedback
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.hapticFeedback

Platforms

• Android
• Zebra Devices Only(Scanners on Symbol Technologies' devices)

i2of5

Type

BOOLEAN

Description

Enables or disables the symbology for I2of5 barcodes. If your application does not expect to scan this symbology you should disable it to improve scanning performance.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.i2of5
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.i2of5

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

i2of5convertToEan13

Type

BOOLEAN

Description

When true, EAN 8 barcodes will be converted to EAN 13 and EAN 13 parameters used.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.i2of5convertToEan13
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.i2of5convertToEan13

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

i2of5maxLength

Type

INTEGER

Description

Specifies the maximum number of allowable characters in a I2of5 barcode. If your application only expects barcode lengths in a certain range, reducing the allowed range can improve scanning performance. Allowed values are 0 to 55.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.i2of5maxLength
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.i2of5maxLength

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

i2of5minLength

Type

INTEGER

Description

Specifies the minimum number of allowable characters in a I2of5 barcode. If your application only expects barcode lengths in a certain range, reducing the allowed range can improve scanning performance. Allowed values are 0 to 55.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.i2of5minLength
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.i2of5minLength

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

i2of5redundancy

Type

BOOLEAN

Description

Sets the I2of5 Redundancy property, if set the barcode must be decoded twice before being accepted. This will slow scanning but improve reliability.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.i2of5redundancy
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.i2of5redundancy

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

i2of5reportCheckDigit

Type

BOOLEAN

Description

When true, the barcode check digit(s) will be reported for scanned I2of5 barcodes.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.i2of5reportCheckDigit
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.i2of5reportCheckDigit

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

i2of5verifyCheckDigit

Type

STRING

Description

Enables the verification of the I2of5 check digit.

Values

Possible Values (STRING):

• Constant: EB.Barcode.I2OF5_VERIFY_NONE - String: none Disables verification of the check digit.
• Constant: EB.Barcode.I2OF5_VERIFY_USS - String: uss Enables the USS format for the check digit.
• Constant: EB.Barcode.I2OF5_VERIFY_OPCC - String: opcc Enables the OPCC format for the check digit.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.i2of5verifyCheckDigit
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.i2of5verifyCheckDigit

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

illuminationMode

Type

STRING

Description

Selects the illumination mode to use.

Values

Possible Values (STRING):

• Constant: EB.Barcode.ILLUMINATION_AUTO - String: auto Auto-exposure algorithms will decide whether illumination is required. Not currently supported on Android.
• Constant: EB.Barcode.ILLUMINATION_ALWAYS_ON - String: alwaysOn External illumination is always on.
• Constant: EB.Barcode.ILLUMINATION_ALWAYS_OFF - String: alwaysOff External illumination is always off.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.illuminationMode
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.illuminationMode

Platforms

• Windows Mobile
• Windows CE
• Zebra Devices Only(Imager / Camera Scanners on Symbol Technologies devices)

invalidDecodeFrequency

Type

INTEGER

Description

The frequency of the device beeper when a barcode is scanned but not successfully decoded. This should be within the range of the beeper but the API will accept values in the range 0 to 65535.

Params

Default: 2500

Access

• Instance: This property can be accessed via an instance object of this class: myObject.invalidDecodeFrequency
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.invalidDecodeFrequency

Platforms

• Windows Mobile
• Zebra Devices Only(Scanners on Symbol Technologies' devices)

invalidDecodeSound

Type

STRING

Description

Path to a local wave file to be played when a barcode is scanned but not successfully decoded. This setting overrides the scanner beeper.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.invalidDecodeSound
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.invalidDecodeSound

Platforms

• Windows Mobile
• Zebra Devices Only(Scanners on Symbol Technologies' devices)

inverse1dMode

Type

STRING

Description

Allows the user to select inverse 1D barcodes for decoding.

Values

Possible Values (STRING):

• Constant: EB.Barcode.INVERSE_ENABLED - String: enabled Inverse 1D symbology decoding is enabled.
• Constant: EB.Barcode.INVERSE_DISABLED - String: disabled Inverse 1D symbology decoding is disabled.
• Constant: EB.Barcode.INVERSE_AUTO - String: auto Allows decoding of both positive and inverse 1D symbologies.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.inverse1dMode
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.inverse1dMode

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only(Scanners on Symbol Technologies' devices. The scanning engine must support inverse barcodes)

japPostal

Type

BOOLEAN

Description

Enables or disables the symbology for Japanese Postal barcodes. If your application does not expect to scan this symbology you should disable it to improve scanning performance.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.japPostal
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.japPostal

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

klasseEins

Type

BOOLEAN

Description

Enables or disables the Klasse Eins laser on time function.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.klasseEins
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.klasseEins

Platforms

• Windows Mobile
• Zebra Devices Only(Laser Scanners on Symbol Technologies' devices)

korean3of5

Type

BOOLEAN

Description

Enables or disables the symbology for Korean 3of5 barcodes. If your application does not expect to scan this symbology you should disable it to improve scanning performance.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.korean3of5
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.korean3of5

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

korean3of5maxLength

Type

INTEGER

Description

Specifies the maximum number of allowable characters in a Korean 3of5 barcode. If your application only expects barcode lengths in a certain range, reducing the allowed range can improve scanning performance. Allowed values are 0 to 55.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.korean3of5maxLength
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.korean3of5maxLength

Platforms

• Windows Mobile
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

korean3of5minLength

Type

INTEGER

Description

Specifies the minimum number of allowable characters in a Korean 3of5 barcode. If your application only expects barcode lengths in a certain range, reducing the allowed range can improve scanning performance. Allowed values are 0 to 55.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.korean3of5minLength
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.korean3of5minLength

Platforms

• Windows Mobile
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

korean3of5redundancy

Type

BOOLEAN

Description

Sets Korean 3of5 Redundancy property, if set the barcode must be decoded twice before being accepted. This will slow scanning but improve reliability.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.korean3of5redundancy
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.korean3of5redundancy

Platforms

• Windows Mobile
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

lcdMode

Type

BOOLEAN

Description

Controls whether LCD Mode is enabled on the scanner. LCD Mode makes it easier to scan barcodes off of LCD screens (like mobile device screens)

Params

Default: false

Access

• Instance: This property can be accessed via an instance object of this class: myObject.lcdMode
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.lcdMode

Platforms

• Android
• Zebra Devices Only(Scanners on Symbol Technologies' devices)

linearSecurityLevel

Type

STRING

Description

Describes the linear security level used during decoding. This determines the number of times a barcode must be read before it is decoded. If the successive reads of the barcode do not match, it will not be decoded.

Values

Possible Values (STRING):

• Constant: EB.Barcode.REDUNDANCY_AND_LENGTH - String: redundancyAndLength Double redundancy based on redundancy flags and code length. Only applicable to laser scanners, not BlockBuster imager scanners. Not supported on Android with EMDK version 3.1 and above.
• Constant: EB.Barcode.SHORT_OR_CODABAR - String: shortOrCodabar Double redundancy if short barcode or Codabar.
• Constant: EB.Barcode.LONG_AND_SHORT - String: longAndShort Double redundancy for long barcodes, triple for short barcodes.
• Constant: EB.Barcode.ALL_TWICE - String: allTwice Double redundancy for all barcodes.
• Constant: EB.Barcode.ALL_THRICE - String: allThrice Triple redundancy for all barcodes.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.linearSecurityLevel
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.linearSecurityLevel

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only(Scanners on Symbol Technologies' devices)

lowBatteryScan

Type

BOOLEAN

Description

Set to false to disable scanning when the battery is low / critical or set to true to enable it.

Params

Default: false

Access

• Instance: This property can be accessed via an instance object of this class: myObject.lowBatteryScan
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.lowBatteryScan

Platforms

• Windows Mobile
• Zebra Devices Only(Scanners on Symbol Technologies' devices)

macroMicroPdf

Type

BOOLEAN

Description

Enables or disables the symbology for MacroMicroPDF barcodes. If your application does not expect to scan this symbology you should disable it to improve scanning performance.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.macroMicroPdf
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.macroMicroPdf

Platforms

• Windows Mobile
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

macroMicroPdfBufferLabels

Type

BOOLEAN

Description

If true, the scanner driver will return the barcode data only after the complete macroMicroPdf sequence has been read. If false, the scanner driver will return each barcode in the macroMicroPdf sequence as it is read.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.macroMicroPdfBufferLabels
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.macroMicroPdfBufferLabels

Platforms

• Windows Mobile
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

macroMicroPdfConvertToMicroPdf

Type

BOOLEAN

Description

If true, MacroMicroPDF barcodes will be converted to MicroPDF codes.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.macroMicroPdfConvertToMicroPdf
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.macroMicroPdfConvertToMicroPdf

Platforms

• Windows Mobile
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

macroMicroPdfExclusive

Type

BOOLEAN

Description

If true, the scanner driver will not complete read requests while in the middle of a macroMicroPdf sequence. Once a macroMicroPdf sequence has been started it must be completed or canceled before the scan driver will complete other read requests.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.macroMicroPdfExclusive
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.macroMicroPdfExclusive

Platforms

• Windows Mobile
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

macroMicroPdfReportAppendInfo

Type

BOOLEAN

Description

If true, the appended info is concatenated to the decoded data before being returned.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.macroMicroPdfReportAppendInfo
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.macroMicroPdfReportAppendInfo

Platforms

• Windows Mobile
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

macroPdf

Type

BOOLEAN

Description

Enables or disables the symbology for Macro PDF barcodes. If your application does not expect to scan this symbology you should disable it to improve scanning performance.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.macroPdf
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.macroPdf

Platforms

• Windows Mobile
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

macroPdfBufferLabels

Type

BOOLEAN

Description

When true, the scanner driver will return he barcode data only after the complete macroPdf sequence has been read. If false, the scan driver will return each barcode in the macroPdf sequence as it is read.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.macroPdfBufferLabels
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.macroPdfBufferLabels

Platforms

• Windows Mobile
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

macroPdfConvertToPdf417

Type

BOOLEAN

Description

If true, MacroPDF barcodes will be converted to PDF417 codes.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.macroPdfConvertToPdf417
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.macroPdfConvertToPdf417

Platforms

• Windows Mobile
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

macroPdfExclusive

Type

BOOLEAN

Description

If true, the scanner driver will not complete read requests while in the middle of a macroPdf sequence. Once a macroPdf sequence has been started it must be completed or canceled before the scan driver will complete other read requests.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.macroPdfExclusive
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.macroPdfExclusive

Platforms

• Windows Mobile
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

matrix2of5

Type

BOOLEAN

Description

Enables or disables the symbology for Matrix 2of5 barcodes. If your application does not expect to scan this symbology you should disable it to improve scanning performance.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.matrix2of5
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.matrix2of5

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

matrix2of5maxLength

Type

INTEGER

Description

Specifies the maximum number of allowable characters in a Matrix 2of5 barcode. If your application only expects barcode lengths in a certain range, reducing the allowed range can improve scanning performance. Allowed values are 0 to 55.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.matrix2of5maxLength
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.matrix2of5maxLength

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

matrix2of5minLength

Type

INTEGER

Description

Specifies the minimum number of allowable characters in a Matrix 2of5 barcode. If your application only expects barcode lengths in a certain range, reducing the allowed range can improve scanning performance. Allowed values are 0 to 55.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.matrix2of5minLength
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.matrix2of5minLength

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

matrix2of5reportCheckDigit

Type

BOOLEAN

Description

When true, the barcode check digit(s) will be reported for scanned Matrix 2of5 barcodes.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.matrix2of5reportCheckDigit
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.matrix2of5reportCheckDigit

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

matrix2of5verifyCheckDigit

Type

BOOLEAN

Description

Enables verification of the Matrix 2of5 symbology check digit.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.matrix2of5verifyCheckDigit
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.matrix2of5verifyCheckDigit

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

maxiCode

Type

BOOLEAN

Description

Enables or disables the symbology for Maxicode barcodes. If your application does not expect to scan this symbology you should disable it to improve scanning performance.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.maxiCode
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.maxiCode

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

microPdf

Type

BOOLEAN

Description

Enables or disables the symbology for Micro PDF barcodes. If your application does not expect to scan this symbology you should disable it to improve scanning performance.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.microPdf
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.microPdf

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

microQr

Type

BOOLEAN

Description

Enables or disables the symbology for Micro QR barcodes. If your application does not expect to scan this symbology you should disable it to improve scanning performance.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.microQr
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.microQr

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

msi

Type

BOOLEAN

Description

Enables or disables the symbology for MSI barcodes. If your application does not expect to scan this symbology you should disable it to improve scanning performance.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.msi
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.msi

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

msiCheckDigitScheme

Type

STRING

Description

Specifies the check digit scheme used to verify MSI barcodes.

Values

Possible Values (STRING):

• Constant: EB.Barcode.MSI_CHECKDIGITS_MOD11 - String: mod11 The first check digit is MOD 11, the second is MOD 10.
• Constant: EB.Barcode.MSI_CHECKDIGITS_MOD10 - String: mod10 Both check digits are MOD 10.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.msiCheckDigitScheme
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.msiCheckDigitScheme

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

msiCheckDigits

Type

STRING

Description

Sets the number of MSI check digits to use.

Values

Possible Values (STRING):

• Constant: EB.Barcode.MSI_CHECKDIGITS_ONE - String: one Use one check digit for MSI barcodes.
• Constant: EB.Barcode.MSI_CHECKDIGITS_TWO - String: two Use two check digits for MSI barcodes.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.msiCheckDigits
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.msiCheckDigits

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

msiMaxLength

Type

INTEGER

Description

Specifies the maximum number of allowable characters in a MSI barcode. If your application only expects barcode lengths in a certain range, reducing the allowed range can improve scanning performance. Allowed values are 0 to 55.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.msiMaxLength
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.msiMaxLength

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

msiMinLength

Type

INTEGER

Description

Specifies the minimum number of allowable characters in a MSI barcode. If your application only expects barcode lengths in a certain range, reducing the allowed range can improve scanning performance. Allowed values are 0 to 55.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.msiMinLength
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.msiMinLength

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

msiRedundancy

Type

BOOLEAN

Description

Sets the MSI Redundancy property, if set the barcode must be decoded twice before being accepted. This will slow scanning but improve reliability.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.msiRedundancy
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.msiRedundancy

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

msiReportCheckDigit

Type

BOOLEAN

Description

When true, the barcode check digit(s) will be reported for scanned MSI barcodes.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.msiReportCheckDigit
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.msiReportCheckDigit

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

pdf417

Type

BOOLEAN

Description

Enables or disables the symbology for PDF 417 barcodes. If your application does not expect to scan this symbology you should disable it to improve scanning performance.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.pdf417
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.pdf417

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

picklistMode

Type

STRING

Description

Allows the imager to decode only the barcode that is directly under the cross-hair on Android and center of the reticle on WM/CE. This feature is most useful in applications where multiple barcodes may appear in the field of view during a decode session and only one of them is targeted for decode. When enabled picklistMode will override aimMode or, if no aiming is chosen, and use aimMode:reticle. This mode will also interact with viewfinderMode, see the EMDK for C help file for more information. Enabling picklist mode may adversely affect overall decoding performance.

Values

Possible Values (STRING):

• Constant: EB.Barcode.PICKLIST_DISABLED - String: disabled Disables picklist mode so any barcode within the field of view can be decoded.
• Constant: EB.Barcode.PICKLIST_HARDWARE_RETICLE - String: hardwareReticle Enables picklist mode so that only the barcode under the projected reticle can be decoded. On Windows, if the imager does not support a projected reticle then the behavior is the same as softwareReticle. On Android, this is only supported for Imager (non-viewfinder) based scanners.
• Constant: EB.Barcode.PICKLIST_SOFTWARE_RETICLE - String: softwareReticle Enables picklist mode so that only the barcode in the center of the image is decoded on WM/CE and under the cross-hair on Android. This is most useful when used in conjunction with static and dynamic reticle viewfinder modes.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.picklistMode
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.picklistMode

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only(Imager / Camera Scanners on Symbol Technologies' devices)

poorQuality1dMode

Type

BOOLEAN

Description

Allows poor quality 1D barcodes to be read When true, but this will adversely affect the overall decoding performance.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.poorQuality1dMode
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.poorQuality1dMode

Platforms

• Windows Mobile
• Zebra Devices Only(Imager / Camera Scanners on Symbol Technologies' devices)

qrCode

Type

BOOLEAN

Description

Enables or disables the symbology for QR Code barcodes. If your application does not expect to scan this symbology you should disable it to improve scanning performance.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.qrCode
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.qrCode

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

rasterHeight

Type

INTEGER

Description

Vertical rastering height to use, as a percentage, when rasterMode:openAlways is applied. This value must be between 0 and 100.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.rasterHeight
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.rasterHeight

Platforms

• Windows Mobile
• Zebra Devices Only(Laser Scanners on Symbol Technologies' devices)

rasterMode

Type

STRING

Description

Describes the type of vertical rastering to use.

Values

Possible Values (STRING):

• Constant: EB.Barcode.RASTER_NONE - String: none No vertical rastering.
• Constant: EB.Barcode.RASTER_OPEN_ALWAYS - String: openAlways Vertical rastering is always full open. To adjust the rastering height use the rasterHeight property.
• Constant: EB.Barcode.RASTER_SMART - String: smart Vertical rastering mode is 'Smart'.
• Constant: EB.Barcode.RASTER_CYCLONE - String: cyclone Vertical rastering mode is 'Cyclone'.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.rasterMode
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.rasterMode

Platforms

• Windows Mobile
• Zebra Devices Only(Scanners on Symbol Technologies' devices)

rsmBatteryCapacity

Type

STRING Read Only

Description

The remaining capacity of the battery, in the range 0 to 100. 'unknown' will be returned if the capacity could not be determined, for example if the scanner had no battery.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.rsmBatteryCapacity
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.rsmBatteryCapacity

Platforms

• Windows Mobile
• Zebra Devices Only(Symbol Technologies' Bluetooth barcode scanners, model RS507)

rsmBatteryId

Type

STRING Read Only

Description

One of 'simple', 'double', 'disabled' or 'unknown'

Access

• Instance: This property can be accessed via an instance object of this class: myObject.rsmBatteryId
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.rsmBatteryId

Platforms

• Windows Mobile
• Zebra Devices Only(Symbol Technologies' Bluetooth barcode scanners, model RS507)

rsmBatteryStatus

Type

STRING Read Only

Description

Indicates the status of the remote scanner's battery, will be one of 'unknown', 'full', 'medium', 'empty', 'chargingFullRate', 'chargingHalfRate', 'chargingTrickle' or 'discharging'

Access

• Instance: This property can be accessed via an instance object of this class: myObject.rsmBatteryStatus
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.rsmBatteryStatus

Platforms

• Windows Mobile
• Zebra Devices Only(Symbol Technologies' Bluetooth barcode scanners, model RS507)

rsmBluetoothAddress

Type

STRING Read Only

Description

Bluetooth address as FF:FF:FF:FF:FF:FF where FF is a hex number.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.rsmBluetoothAddress
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.rsmBluetoothAddress

Platforms

• Windows Mobile
• Zebra Devices Only(Symbol Technologies' Bluetooth barcode scanners, model RS507)

rsmBluetoothAuthentication

Type

BOOLEAN

Description

True if authentication is required.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.rsmBluetoothAuthentication
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.rsmBluetoothAuthentication

Platforms

• Windows Mobile
• Zebra Devices Only(Symbol Technologies' Bluetooth barcode scanners, model RS507)

rsmBluetoothAutoReconnect

Type

STRING

Description

Bluetooth reconnection scheme.

Values

Possible Values (STRING):

• Constant: EB.Barcode.RSM_AUTORECONNECT_NONE - String: none No scheme.
• Constant: EB.Barcode.RSM_AUTORECONNECT_ON_POWER - String: onPower When powered on.
• Constant: EB.Barcode.RSM_AUTORECONNECT_ON_OUT_OF_RANGE - String: onOutOfRange When device goes out of range.
• Constant: EB.Barcode.RSM_AUTORECONNECT_ON_POWER_OUT_OF_RANGE - String: onPowerOutOfRange When powered on or when the device goes out of range.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.rsmBluetoothAutoReconnect
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.rsmBluetoothAutoReconnect

Platforms

• Windows Mobile
• Zebra Devices Only(Symbol Technologies' Bluetooth barcode scanners, model RS507)

rsmBluetoothBeepOnReconnectAttempt

Type

BOOLEAN

Description

When true, scanner will emit 5 beeps every 5 seconds whilst re-connection in progress.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.rsmBluetoothBeepOnReconnectAttempt
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.rsmBluetoothBeepOnReconnectAttempt

Platforms

• Windows Mobile
• Zebra Devices Only(Symbol Technologies' Bluetooth barcode scanners, model RS507)

rsmBluetoothEncryption

Type

BOOLEAN

Description

True if encryption is required.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.rsmBluetoothEncryption
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.rsmBluetoothEncryption

Platforms

• Windows Mobile
• Zebra Devices Only(Symbol Technologies' Bluetooth barcode scanners, model RS507)

rsmBluetoothFriendlyName

Type

STRING

Description

Friendly Bluetooth name, e.g. 'MyBTScanner'

Access

• Instance: This property can be accessed via an instance object of this class: myObject.rsmBluetoothFriendlyName
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.rsmBluetoothFriendlyName

Platforms

• Windows Mobile
• Zebra Devices Only(Symbol Technologies' Bluetooth barcode scanners, model RS507)

rsmBluetoothHidAutoReconnect

Type

STRING

Description

'neverReconnect', 'reconnectOnData' or 'reconnectImmediately'

Access

• Instance: This property can be accessed via an instance object of this class: myObject.rsmBluetoothHidAutoReconnect
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.rsmBluetoothHidAutoReconnect

Platforms

• Windows Mobile
• Zebra Devices Only(Symbol Technologies' Bluetooth barcode scanners, model RS507)

rsmBluetoothInquiryMode

Type

STRING

Description

To use a general inquiry mode, 'general' else, 'limited'

Access

• Instance: This property can be accessed via an instance object of this class: myObject.rsmBluetoothInquiryMode
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.rsmBluetoothInquiryMode

Platforms

• Windows Mobile
• Zebra Devices Only(Symbol Technologies' Bluetooth barcode scanners, model RS507)

rsmBluetoothPinCode

Type

STRING

Description

Up to 5 character PIN code used for Bluetooth authentication.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.rsmBluetoothPinCode
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.rsmBluetoothPinCode

Platforms

• Windows Mobile
• Zebra Devices Only(Symbol Technologies' Bluetooth barcode scanners, model RS507)

rsmBluetoothPinCodeType

Type

STRING

Description

'UseStored' will use the PIN code stored in the memory of the ring scanner, by default '12345'. 'PromptUser' indicates that the ring scanner should be used to scan 5 alpha numeric barcodes to define the PIN, eg. "1", "2", "3", "4", "5" (for PIN 12345). This parameter is not saved permanently on the ring scanner.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.rsmBluetoothPinCodeType
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.rsmBluetoothPinCodeType

Platforms

• Windows Mobile
• Zebra Devices Only(Symbol Technologies' Bluetooth barcode scanners, model RS507)

rsmBluetoothReconnectionAttempts

Type

INTEGER

Description

How long the scanner tries to re-establish connection if it goes out of range, in seconds. This value must be a multiple of 5 and in the range 30 to 60 seconds.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.rsmBluetoothReconnectionAttempts
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.rsmBluetoothReconnectionAttempts

Platforms

• Windows Mobile
• Zebra Devices Only(Symbol Technologies' Bluetooth barcode scanners, model RS507)

rsmDateOfManufacture

Type

STRING Read Only

Description

Ring scanner date of manufacture as DDMMYY.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.rsmDateOfManufacture
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.rsmDateOfManufacture

Platforms

• Windows Mobile
• Zebra Devices Only(Symbol Technologies' Bluetooth barcode scanners, model RS507)

rsmDateOfService

Type

STRING Read Only

Description

Ring scanner date of service as DDMMYY.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.rsmDateOfService
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.rsmDateOfService

Platforms

• Windows Mobile
• Zebra Devices Only(Symbol Technologies' Bluetooth barcode scanners, model RS507)

rsmDecodeFeedback

Type

BOOLEAN

Description

If true, the remote scanner beeps and illuminates its green LED on a successful decode.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.rsmDecodeFeedback
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.rsmDecodeFeedback

Platforms

• Windows Mobile
• Zebra Devices Only(Symbol Technologies' Bluetooth barcode scanners, model RS507)

rsmDeviceClass

Type

STRING Read Only

Description

The device class of the ring scanner.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.rsmDeviceClass
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.rsmDeviceClass

Platforms

• Windows Mobile
• Zebra Devices Only(Symbol Technologies' Bluetooth barcode scanners, model RS507)

rsmFirmwareVersion

Type

STRING Read Only

Description

Scanner's operating system version.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.rsmFirmwareVersion
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.rsmFirmwareVersion

Platforms

• Windows Mobile
• Zebra Devices Only(Symbol Technologies' Bluetooth barcode scanners, model RS507)

rsmForceSavePairingBarcode

Type

BOOLEAN

Description

Force saving the barcode assigned to the device to which the scanner has been paired.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.rsmForceSavePairingBarcode
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.rsmForceSavePairingBarcode

Platforms

• Windows Mobile
• Zebra Devices Only(Symbol Technologies' Bluetooth barcode scanners, model RS507)

rsmGoodScansDelay

Type

INTEGER

Description

Delay between good scans in proximity continuous mode, measured in milliseconds. Range 0 to 15000. This value must be a multiple of 100.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.rsmGoodScansDelay
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.rsmGoodScansDelay

Platforms

• Windows Mobile
• Zebra Devices Only(Symbol Technologies' Bluetooth barcode scanners, model RS507)

rsmIgnoreCode128Usps

Type

BOOLEAN

Description

Feature for ignoring Code 128 barcodes beginning with 420 and 421.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.rsmIgnoreCode128Usps
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.rsmIgnoreCode128Usps

Platforms

• Windows Mobile
• Zebra Devices Only(Symbol Technologies' Bluetooth barcode scanners, model RS507)

rsmLowBatteryIndication

Type

BOOLEAN

Description

Whether or not the ring scanner should give a low battery indication.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.rsmLowBatteryIndication
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.rsmLowBatteryIndication

Platforms

• Windows Mobile
• Zebra Devices Only(Symbol Technologies' Bluetooth barcode scanners, model RS507)

rsmLowBatteryIndicationCycle

Type

INTEGER

Description

Low battery indication cycle time, in seconds. Must be one of 15, 30, 60, 90 or 120.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.rsmLowBatteryIndicationCycle
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.rsmLowBatteryIndicationCycle

Platforms

• Windows Mobile
• Zebra Devices Only(Symbol Technologies' Bluetooth barcode scanners, model RS507)

rsmMems

Type

BOOLEAN

Description

If you press the trigger on an RSM scanner, proximity enabled will be turned off, even though it still reports its self as being turned on if you query the property. In order to use ProximityEnable you need to also have Mems enabled, this is the motion sensor and if you disable Mems the scanner will not function.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.rsmMems
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.rsmMems

Platforms

• Windows Mobile
• Zebra Devices Only(Symbol Technologies' Bluetooth barcode scanners, model RS507)

rsmModelNumber

Type

STRING Read Only

Description

Ring scanner model number.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.rsmModelNumber
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.rsmModelNumber

Platforms

• Windows Mobile
• Zebra Devices Only(Symbol Technologies' Bluetooth barcode scanners, model RS507)

rsmPagingBeepSequence

Type

INTEGER

Description

Range 0 to 15 to specify the pattern for the paging beep sequence.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.rsmPagingBeepSequence
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.rsmPagingBeepSequence

Platforms

• Windows Mobile
• Zebra Devices Only(Symbol Technologies' Bluetooth barcode scanners, model RS507)

rsmPagingEnable

Type

BOOLEAN

Description

Specify whether paging the device is enabled.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.rsmPagingEnable
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.rsmPagingEnable

Platforms

• Windows Mobile
• Zebra Devices Only(Symbol Technologies' Bluetooth barcode scanners, model RS507)

rsmProximityContinuous

Type

BOOLEAN

Description

Proximity continuous mode.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.rsmProximityContinuous
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.rsmProximityContinuous

Platforms

• Windows Mobile
• Zebra Devices Only(Symbol Technologies' Bluetooth barcode scanners, model RS507)

rsmProximityDistance

Type

STRING

Description

Specify the distance for the proximity feature as 'short', 'medium' or 'long'

Access

• Instance: This property can be accessed via an instance object of this class: myObject.rsmProximityDistance
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.rsmProximityDistance

Platforms

• Windows Mobile
• Zebra Devices Only(Symbol Technologies' Bluetooth barcode scanners, model RS507)

rsmProximityEnable

Type

BOOLEAN

Description

If you press the trigger on an RSM scanner, proximity enabled will be turned off, even though it still reports its self as being turned on if you query the property. In order to use ProximityEnable you need to also have Mems enabled, this is the motion sensor and if you disable Mems the scanner will not function.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.rsmProximityEnable
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.rsmProximityEnable

Platforms

• Windows Mobile
• Zebra Devices Only(Symbol Technologies' Bluetooth barcode scanners, model RS507)

rsmScanLineWidth

Type

STRING

Description

The laser scan line width, 'wide' or 'narrow'.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.rsmScanLineWidth
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.rsmScanLineWidth

Platforms

• Windows Mobile
• Zebra Devices Only(Symbol Technologies' Bluetooth barcode scanners, model RS507)

rsmScanTriggerWakeup

Type

BOOLEAN

Description

Scanner trigger will wakeup the device from a low power state.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.rsmScanTriggerWakeup
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.rsmScanTriggerWakeup

Platforms

• Windows Mobile
• Zebra Devices Only(Symbol Technologies' Bluetooth barcode scanners, model RS507)

rsmSerialNumber

Type

STRING Read Only

Description

Ring scanner serial number.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.rsmSerialNumber
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.rsmSerialNumber

Platforms

• Windows Mobile
• Zebra Devices Only(Symbol Technologies' Bluetooth barcode scanners, model RS507)

sameSymbolTimeout

Type

INTEGER

Description

When the aimType:continuousRead property is applied this value defines the interval between which the same barcode can be decoded twice. The value is specified in milliseconds, use 0 to indicate no interval between successive reads. Use this value to prevent accidental duplicate scans.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.sameSymbolTimeout
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.sameSymbolTimeout

Platforms

• Windows Mobile
• Zebra Devices Only(Scanners on Symbol Technologies' devices)

scanTimeout

Type

INTEGER

Description

Maximum time in milliseconds that laser scanners will emit a beam or imager scanners will enable the imager. A value of 0 indicates an infinite timeout. This parameter is compatible with aimType:trigger, aimType:timedHold, aimType:timedRelease and aimType:pressAndRelease. Note that for regulatory reasons scanTimeout is not configurable on all laser / imager scanners. Scan timeout is extent to hardware capabilities and limitations.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.scanTimeout
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.scanTimeout

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only(Scanners on Symbol Technologies' devices)

scannerType

Type

STRING Read Only

Description

The type of scanner in use, will be one of 'Camera', 'Imager' or 'Laser'. Camera scanners capture and process an image taken via the devices camera. Imager scanners rely on capturing and processing an image of the barcode via dedicated scanning hardware. Both camera and imager scanners are capable of decoding 1D and 2D barcodes. Laser scanners are only capable of decoding 1D barcodes and rely on a sweeping laser.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.scannerType
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.scannerType

Platforms

• Android
• Windows Mobile
• Windows CE(All Scanners)

signature

Type

BOOLEAN

Description

Enables or disables the symbology for Signature barcodes. If your application does not expect to scan this symbology you should disable it to improve scanning performance. Signature barcodes return their data in Data URI format, it is recommended you adjust the dataBufferSize and barcodeDataFormat properties when scanning Signature barcodes.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.signature
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.signature

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

signatureImageHeight

Type

INTEGER

Description

Specifies the output height of the captured signature barcode. Signature barcodes return their data in Data URI format, it is recommended you adjust the dataBufferSize and barcodeDataFormat properties when scanning Signature barcodes. Provide a number greater than or equal to 20.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.signatureImageHeight
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.signatureImageHeight

Platforms

• Windows Mobile
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

signatureImageQuality

Type

INTEGER

Description

Specifies the output quality of the captured signature barcode. Signature barcodes return their data in Data URI format, it is recommended you adjust the dataBufferSize and barcodeDataFormat properties when scanning Signature barcodes. Provide a value between 10 and 100 inclusive.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.signatureImageQuality
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.signatureImageQuality

Platforms

• Windows Mobile
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

signatureImageWidth

Type

INTEGER

Description

Specifies the output width of the captured signature barcode. Signature barcodes return their data in Data URI format, it is recommended you adjust the dataBufferSize and barcodeDataFormat properties when scanning Signature barcodes. Provide a number greater than or equal to 20.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.signatureImageWidth
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.signatureImageWidth

Platforms

• Windows Mobile
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

timedAimDuration

Type

INTEGER

Description

Aim duration in milliseconds for aimType:timedHold and aimType:timedRelease.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.timedAimDuration
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.timedAimDuration

Platforms

• Windows Mobile
• Zebra Devices Only(Scanners on Symbol Technologies' devices)

tlc39

Type

BOOLEAN

Description

Enables or disables the symbology for TLC 39 barcodes. If your application does not expect to scan this symbology you should disable it to improve scanning performance.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.tlc39
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.tlc39

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

triggerConnected

Type

BOOLEAN

Description

Only applies to an enabled laser or imaging scanner. Disconnecting the trigger will prevent the scan beam from being emitted, this can temporarily prevent a user from scanning without having to disable the scanner, which can take longer. By default the trigger will be connected when the scanner is first enabled, you do not have to connect it separately. Please note that disconnecting the trigger will also prevent the start method from emitting a laser. This property will only affect the scanner and will have no effect on the 'captureTrigger' API.

Params

Default: true

Access

• Instance: This property can be accessed via an instance object of this class: myObject.triggerConnected
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.triggerConnected

Platforms

• Windows Mobile
• Zebra Devices Only(Scanners on Symbol Technologies' devices)

trioptic39

Type

BOOLEAN

Description

Enables or disables the symbology for Trioptic 39 barcodes. If your application does not expect to scan this symbology you should disable it to improve scanning performance.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.trioptic39
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.trioptic39

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

trioptic39Redundancy

Type

BOOLEAN

Description

Sets the Trioptic 39 Redundancy property, if set the barcode must be decoded twice before being accepted. This will slow scanning but improve reliability.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.trioptic39Redundancy
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.trioptic39Redundancy

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

ukPostal

Type

BOOLEAN

Description

Enables or disables the symbology for UK Postal barcodes. If your application does not expect to scan this symbology you should disable it to improve scanning performance.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.ukPostal
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.ukPostal

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

ukPostalReportCheckDigit

Type

BOOLEAN

Description

When true, the barcode check digit(s) will be reported for scanned UK Postal barcodes.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.ukPostalReportCheckDigit
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.ukPostalReportCheckDigit

Platforms

• Android
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

upcEanBookland

Type

BOOLEAN

Description

Enables or disables decoding of UPC EAN Bookland barcodes.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.upcEanBookland
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.upcEanBookland

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

upcEanBooklandFormat

Type

STRING

Description

Specifies the bookland format to use when decoding UPC EAN Bookland barcodes.

Values

Possible Values (STRING):

• Constant: EB.Barcode.BOOKLAND_ISBN10 - String: isbn10 Causes 978 bookland barcodes to be reported in 10 digit mode.
• Constant: EB.Barcode.BOOKLAND_ISBN13 - String: isbn13 Causes 978/979 bookland barcodes to be transmitted as EAN13 as per 2007 ISBN-13 protocol.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.upcEanBooklandFormat
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.upcEanBooklandFormat

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

upcEanConvertGs1dataBarToUpcEan

Type

BOOLEAN

Description

If true, RSS barcodes will be converted to UPC/EAN format. For this setting to work UPC/EAN symbologies must be enabled.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.upcEanConvertGs1dataBarToUpcEan
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.upcEanConvertGs1dataBarToUpcEan

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

upcEanCoupon

Type

BOOLEAN

Description

Enables or disables decoding of UPC EAN Coupon barcodes.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.upcEanCoupon
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.upcEanCoupon

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

upcEanLinearDecode

Type

BOOLEAN

Description

Sets the linear decode property.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.upcEanLinearDecode
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.upcEanLinearDecode

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

upcEanRandomWeightCheckDigit

Type

BOOLEAN

Description

When true, enables random weight check digit verification.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.upcEanRandomWeightCheckDigit
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.upcEanRandomWeightCheckDigit

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

upcEanRetryCount

Type

INTEGER

Description

Sets the retry count for auto-discriminating for supplementals. The value must be between 2 - 20 inclusive.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.upcEanRetryCount
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.upcEanRetryCount

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

upcEanSecurityLevel

Type

INTEGER

Description

Sets the Security level for decoding UPC EAN barcodes and accepts a value between 0 and 3 inclusive. 0: This setting allows the scanner to operate in its most aggressive state, while providing sufficient security in decoding most 'in-spec' barcodes. 1: This setting eliminates most mis-decodes. 2: Select this option if security level 1 fails to eliminate mis-decodes. 3: Select this option if security level 1 and 2 fail to eliminate mis-decodes. Be advised that selecting level 3 is an extreme measure against mis-decoding and will significantly impair the decoding ability of the scanner.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.upcEanSecurityLevel
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.upcEanSecurityLevel

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

upcEanSupplemental2

Type

BOOLEAN

Description

When true, enables the supplemental barcode decoding. Note you must have upcEanSupplementalMode:always set for this parameter to take effect.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.upcEanSupplemental2
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.upcEanSupplemental2

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

upcEanSupplemental5

Type

BOOLEAN

Description

When true, enables the supplemental barcode decoding. Note you must have upcEanSupplementalMode:always set for this parameter to take effect.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.upcEanSupplemental5
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.upcEanSupplemental5

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

upcEanSupplementalMode

Type

STRING

Description

Describes the UPC EAN Supplemental mode.

Values

Possible Values (STRING):

• Constant: EB.Barcode.UPCEAN_NONE - String: none Supplementals are ignored.
• Constant: EB.Barcode.UPCEAN_AUTO - String: auto Auto-discriminates supplementals.
• Constant: EB.Barcode.UPCEAN_ALWAYS - String: always Will not decode upc/ean without supplementals.
• Constant: EB.Barcode.UPCEAN_SMART - String: smart The decoder will return the decoded value of the main block right away if it does not belong to any of the supplemental types. If the barcode starts with one of the prefixes it will search the image more aggressively for a supplemental. The scanner will try to scan the supplemental if it is present but if that fails, the main barcode will be returned.
• Constant: EB.Barcode.UPCEAN_379 - String: 378or379 Auto-discriminates supplemental for upc/ean codes starting with 378 or 379. Will disable reading of supplementals for any other upc/ean barcodes not starting with these values. The supplemental will be scanned if present but if scanning fails then the main barcode will be returned.
• Constant: EB.Barcode.UPCEAN_979 - String: 978or979 Auto-discriminates supplemental for upc/ean codes starting with 978 or 979. Will disable reading of supplementals for any other upc/ean barcodes not starting with these values. The supplemental will be scanned if present but if scanning fails then the main barcode will be returned.
• Constant: EB.Barcode.UPCEAN_439 - String: 414or419or434or439 Auto-discriminates supplemental for upc/ean codes starting with 414 or 419 or 434 or 439. Will disable reading of supplementals for any other upc/ean barcodes not starting with these values. The supplemental will be scanned if present but if scanning fails then the main barcode will be returned.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.upcEanSupplementalMode
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.upcEanSupplementalMode

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

upca

Type

BOOLEAN

Description

Enables or disables the symbology for UPCA barcodes. If your application does not expect to scan this symbology you should disable it to improve scanning performance.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.upca
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.upca

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

upcaPreamble

Type

STRING

Description

Controls the preamble applied to the UPCA barcode.

Values

Possible Values (STRING):

• Constant: EB.Barcode.UPCA_PREAMBLE_NONE - String: none Applies no preamble to the bar code.
• Constant: EB.Barcode.UPCA_PREAMBLE_SYSTEMCHAR - String: systemChar Applies system character preamble to the bar code.
• Constant: EB.Barcode.UPCA_PREAMBLE_COUNTRY - String: countryAndSystemChars Applies both system and country code preamble to the bar code.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.upcaPreamble
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.upcaPreamble

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

upcaReportCheckDigit

Type

BOOLEAN

Description

When true, the barcode check digit(s) will be reported for scanned UPCA barcodes.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.upcaReportCheckDigit
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.upcaReportCheckDigit

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

upce0

Type

BOOLEAN

Description

Enables or disables the symbology for UPCE0 barcodes. If your application does not expect to scan this symbology you should disable it to improve scanning performance.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.upce0
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.upce0

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

upce0convertToUpca

Type

BOOLEAN

Description

When true, scanned UPCE0 barcodes will be converted to UPCA and UPCA parameters used.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.upce0convertToUpca
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.upce0convertToUpca

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

upce0preamble

Type

STRING

Description

Controls the preamble applied to the UPCE0 barcode.

Values

Possible Values (STRING):

• Constant: EB.Barcode.UPCE0_PREAMBLE_NONE - String: none Applies no preamble to the bar code.
• Constant: EB.Barcode.UPCE0_PREAMBLE_SYSTEMCHAR - String: systemChar Applies system character preamble to the bar code.
• Constant: EB.Barcode.UPCE0_PREAMBLE_COUNTRY - String: countryAndSystemChars Applies both system and country code preamble to the bar code.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.upce0preamble
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.upce0preamble

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

upce0reportCheckDigit

Type

BOOLEAN

Description

When true, the barcode check digit(s) will be reported for scanned UPCE0 barcodes.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.upce0reportCheckDigit
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.upce0reportCheckDigit

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

upce1

Type

BOOLEAN

Description

Enables or disables the symbology for UPCE1 barcodes. If your application does not expect to scan this symbology you should disable it to improve scanning performance.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.upce1
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.upce1

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

upce1convertToUpca

Type

BOOLEAN

Description

When true, scanned UPCE1 barcodes will be converted to UPCA and UPCA parameters used.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.upce1convertToUpca
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.upce1convertToUpca

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

upce1preamble

Type

STRING

Description

Controls the preamble applied to the UPCE1 barcode.

Values

Possible Values (STRING):

• Constant: EB.Barcode.UPCE1_PREAMBLE_NONE - String: none Applies no preamble to the bar code.
• Constant: EB.Barcode.UPCE1_PREAMBLE_SYSTEMCHAR - String: systemChar Applies system character preamble to the bar code.
• Constant: EB.Barcode.UPCE1_PREAMBLE_COUNTRY - String: countryAndSystemChars Applies both system and country code preamble to the bar code.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.upce1preamble
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.upce1preamble

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

upce1reportCheckDigit

Type

BOOLEAN

Description

When true, the barcode check digit(s) will be reported for scanned UPCE1 barcodes.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.upce1reportCheckDigit
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.upce1reportCheckDigit

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

us4state

Type

BOOLEAN

Description

Enables or disables the symbology for US 4-State barcodes. If your application does not expect to scan this symbology you should disable it to improve scanning performance.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.us4state
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.us4state

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

us4stateFics

Type

BOOLEAN

Description

Enables or disables the symbology for US 4-State FICS barcodes. If your application does not expect to scan this symbology you should disable it to improve scanning performance.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.us4stateFics
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.us4stateFics

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

usPlanet

Type

BOOLEAN

Description

Enables or disables the symbology for US Planet barcodes. If your application does not expect to scan this symbology you should disable it to improve scanning performance.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.usPlanet
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.usPlanet

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

usPlanetReportCheckDigit

Type

BOOLEAN

Description

When true, the barcode check digit(s) will be reported for scanned US Planet barcodes.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.usPlanetReportCheckDigit
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.usPlanetReportCheckDigit

Platforms

• Android
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

usPostNet

Type

BOOLEAN

Description

Enables or disables the symbology for US Post Net barcodes. If your application does not expect to scan this symbology you should disable it to improve scanning performance.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.usPostNet
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.usPostNet

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

usPostNetReportCheckDigit

Type

BOOLEAN

Description

When true, the barcode check digit(s) will be reported for scanned US Post Net barcodes.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.usPostNetReportCheckDigit
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.usPostNetReportCheckDigit

Platforms

• Android
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

viewfinderFeedback

Type

STRING

Description

Configures the feedback given after a successful scan. This value is ignored if aimType is set to continuousRead and no feedback will be given. Not supported on Android with EMDK version 3.1 and above.

Values

Possible Values (STRING):

• Constant: EB.Barcode.VF_FEEDBACK_ENABLED - String: enabled The last image that was successfully decoded is displayed. The time for which the image is displayed can be configured by the viewfinderFeedbackTime parameter.
• Constant: EB.Barcode.VF_FEEDBACK_DISABLED - String: disabled No feedback is given in the viewfinder after a successful decode.
• Constant: EB.Barcode.VF_FEEDBACK_RETICLE - String: reticle The last image that was successfully decoded is displayed along with a red reticle in the center of the image. The time for which the image is displayed can be configured by the viewfinderFeedbackTime parameter.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.viewfinderFeedback
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.viewfinderFeedback

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only(Camera Scanners on Symbol Technologies' devices)

viewfinderFeedbackTime

Type

INTEGER

Description

If the viewfinderFeedback:enabled or viewfinderFeedback:reticle are applied then the decoded barcode will remain on the screen for this duration, specified in milliseconds. Not supported on Android with EMDK version 3.1 and above.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.viewfinderFeedbackTime
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.viewfinderFeedbackTime

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only(Camera Scanners on Symbol Technologies' devices)

viewfinderHeight

Type

INTEGER

Description

When scanning a barcode using a Camera scanner the viewfinder preview window will be this number of pixels in height. The images displayed in the viewfinder will be scaled as appropriate.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.viewfinderHeight
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.viewfinderHeight

Platforms

• Windows Mobile
• Zebra Devices Only(Camera Scanners on Symbol Technologies' devices)

viewfinderMode

Type

STRING

Description

Configures the mode of the scanner viewfinder window. This attribute is not supported on all Scanners and will interact with the picklistMode parameter, see the EMDK for C help file for more information.

Values

Possible Values (STRING):

• Constant: EB.Barcode.VIEWFINDER_ENABLED - String: enabled Only the viewfinder is enabled (not the reticle). Displays a viewfinder on the screen showing the image being captured by the camera.
• Constant: EB.Barcode.VIEWFINDER_DISABLED - String: disabled The viewfinder will not be displayed during aiming or scanning.
• Constant: EB.Barcode.VIEWFINDER_STATIC_RETICLE - String: staticReticle Displays the viewfinder as well as draws a red reticle in the center of the image which helps with tracking the barcode.
• Constant: EB.Barcode.VIEWFINDER_DYNAMIC_RETICLE - String: dynamicReticle Displays the viewfinder as well as draws a red reticle in the center of the image. If the barcode in the image is 'decodable' the reticle turns green to indicate this. This mode requires a second trigger press to decode the barcode after the reticle turns green. Not supported on Android.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.viewfinderMode
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.viewfinderMode

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only(Camera Scanners on Symbol Technologies' devices)

viewfinderWidth

Type

INTEGER

Description

When scanning a barcode using a Camera scanner the viewfinder preview window will be this number of pixels wide. The images displayed in the viewfinder will be scaled as appropriate.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.viewfinderWidth
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.viewfinderWidth

Platforms

• Windows Mobile
• Zebra Devices Only(Camera Scanners on Symbol Technologies' devices)

viewfinderX

Type

INTEGER

Description

When scanning a barcode using a Camera scanner the viewfinder preview window will appear this number of pixels from the left hand side of the screen. The images displayed in the viewfinder will be scaled as appropriate.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.viewfinderX
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.viewfinderX

Platforms

• Windows Mobile
• Zebra Devices Only(Camera Scanners on Symbol Technologies' devices)

viewfinderY

Type

INTEGER

Description

When scanning a barcode using a Camera scanner the viewfinder preview window will appear this number of pixels from the top of the screen. The images displayed in the viewfinder will be scaled as appropriate.

Access

• Instance: This property can be accessed via an instance object of this class: myObject.viewfinderY
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.viewfinderY

Platforms

• Windows Mobile
• Zebra Devices Only(Camera Scanners on Symbol Technologies' devices)

webcode

Type

BOOLEAN

Description

Enables or disables the symbology for Webcode barcodes. If your application does not expect to scan this symbology you should disable it to improve scanning performance. Deprecated in Android 4.1 (Jelly Bean).

Access

• Instance: This property can be accessed via an instance object of this class: myObject.webcode
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.webcode

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only(Not all scanning engines support all symbologies or all symbology properties)

webcodeDecodeGtSubtype

Type

BOOLEAN

Description

If true, the GT Webcode subtype will be decoded. Deprecated in Android 4.1 (Jelly Bean).

Access

• Instance: This property can be accessed via an instance object of this class: myObject.webcodeDecodeGtSubtype
• Default Instance: This property can be accessed via the default instance object of this class.
  • EB.Barcode.webcodeDecodeGtSubtype

Platforms

• Android
• Windows Mobile
• Windows CE
• Zebra Devices Only (Not all scanning engines support all symbologies or all symbology properties)

Remarks

Limitation of Scanner and Barcode API

The RE 2.x Scanner API and the EB 1.x Barcode API should not be used simultaneously in any Enterprise Browser application; only one or the other should be used.

Limitation of decodeSound property on Android Platform

If decodeSound property contains '.wav'/'.ogg' filename same as system filename, then the system '.wav'/'.ogg' file will be selected for playing when a scanned barcode is successfully decoded.

Limitation of custom decode sound properties on Android Platform

On some Android devices, only the first set values of custom decode sound properties (i.e. decodeVolume, decodeFrequency and decodeDuration) will take effect even after setting multiple times with different values. User need to restart the Enterprise Browser application to apply the different values for custom decode sound properties.

Omnii XT15

On the Zebra Omnii XT15 device running Windows Mobile/CE, the decode success and failure sounds are not audible unless the decode sound is configured manually in the Config.xml file. To configure this setting, see the <ScanDecodeWav> parameter in the Config.xml Reference Guide.

Bluetooth Scanner Overview

Once associated with the Device a Bluetooth Scanner will remain associated even after losing the BT connection. In order to associate a different Bluetooth scanner with the device it is necessary to scan the 'unpairing' barcode and then invoke the 'disabled' method followed by the 'enabled' method, this will allow you to scan the BT association barcode with a different scanner. You can override this default behavior using the disconnectBtOnDisable property.

The following messages will be received from the Bluetooth Scanner in the bluetoothStatus event:

'BTScanAssociationBarcode'

Means the device is ready to be associated with a BT scanner. You must scan the association barcode. It is only necessary to scan the association barcode when you first associate a scanner with the device, this pairing will be remembered until you scan the unpairing barcode.

'BluetoothConnected'

The remote scanner has successfully connected to the device.

'BluetoothDisconnected'

The remote scanner has become disconnected from the device, this may be due to loss of battery, being out of range or scanning the 'unpairing' barcode. The scanner will attempt to reconnect automatically for a period of time once it regains power or goes out of range, if it fails to reconnect after the specified timeout the reconnect button on the device should be pushed. Once the unpairing barcode is scanned it is necessary to disable the scanner and then re-enable it before another scanner can be associated.

Bluetooth Scanner Support On Android Devices

Enterprise Browser does not support Bluetooth scanners on the Zebra TC70 GA1 device.

Enterprise Browser supports Bluetooth scanners on devices running Android KitKat and higher.

Viewfinder Position Parameters

On Symbol Technologies' scanners the scanner viewfinder window is not infinitely resizable, when setting ViewFinderX, ViewFinderY, ViewFinderWidth and ViewFinderHeight ensure you do not exceed the size of the screen and it is recommended to use the same aspect ratio as your device. For applications designed to handle screen rotation it is recommended to use a scan window whose longest side will fit within both the screen width and screen height. If your viewfinder position fails to be applied it is recommended you query your log file to see which parameter is causing trouble, or reposition the window away from the edges of the screen.

Scanning and Camera Interaction

In some device configurations the scanner and camera share the same hardware. Where two modules share the same physical hardware they cannot be enabled simultaneously, in this circumstance once the scanner is enabled it must be disabled before the camera can be used, and vice versa.

Get Scanner Properties

On WM/CE, it is first necessary to enable the scanner before most of the properties can be retrieved. The case of scanner properties will differ across platforms. On WM/CE, some of the scanner properties are not exposed to set but can be retrieved. On Android, only supported scanner properties can be retrieved in "getAllProperties" method.

Set Scanner Properties

On WM/CE, for some properties, it is first necessary to apply those properties before enabling the scanner.

Android Camera Barcode limitation

As google barcode scanning library(Zxing library) supported only in Landscape mode. Barcode scanning window only appears at centre of screen in Landscape mode.

Devices lacking support

Due to platform limitations this API is not available on the following Zebra Technologies devices on specific platform. Note: However one can enable legacy scanner service and can scan the respective barcode.

• VH10 CE 6.0

Examples

Enable barcode scanner and scan a bacrode

This example shows how to enable your device's barcode scanner and access the data gathered by the scanner. Note that this example assumes that your ebapi-modules.js file is in the same folder as the HTML invoking it. On symbol devices, data wedge needs to be disabled or the Enterprise Browser will not be able to claim any of the scanners.

<head>
    <title>Barcode API Test</title>
    <script type="text/javascript" charset="utf-8" src="ebapi-modules.js"></script>

    <script type="text/javascript">
        function scanReceived(params){
            // No data or no timestamp, scan failed.
            if(params['data']== "" || params['time']==""){
                document.getElementById('display').innerHTML = "Failed!";
                return;
            }
            // Data and timestamp exist, barcode successful, show results
            var displayStr = "Barcode Data: " + params['data']+"<br>Time: "+params['time'];
            document.getElementById("display").innerHTML = displayStr;
        }

        function enableScanners(){
            EB.Barcode.enable({}, scanReceived);
            // Empty property hash, '{}' loads default values for the scanner.
        }

        function unloadEvent(){
            EB.Barcode.disable();
            // Disable Barcode on unload of page to free it up for other operations.
        }
    </script>
</head>

<body onunload='unloadEvent()'>
    <h1>Barcode API Test</h1>
    <div id="display">
        Barcode Data: <br>
        Time: <br>
    </div>
    <button onclick="enableScanners()">Enable Barcode Scanners</button>
</body>              

Setting pre-defined decode sound

The example shows how to set the existing '.wav' or '.ogg' file for decode notification using decodeSound property on Android platform.

function setDecodeSoundwav() {
   EB.Barcode.decodeSound = 'file:///sdcard/badread.wav'; //For Android    
}

Setting custom created decode sound

The example shows how to create and set the custom notification file for getting decode notification. Note: It is recommended to not to set decodeSound property if user want to create and set the custom notification using below barcode properties.

function setCustomDecodeSound(){
   EB.Barcode.enable({'decodeDuration': 1000,'decodeFrequency':2000,'decodeVolume':3}, callback); //This is the recommended approach for creating and setting custom notification.
}