BarcodeScannerOptions.Builder

AI-generated Key Takeaways

• BarcodeScannerOptions.Builder helps create customized barcode scanning configurations using methods like setBarcodeFormats and enableAllPotentialBarcodes.

• It allows specifying the desired barcode formats for faster scanning and the option to receive all potential barcodes, even if undecoded.

• Developers can further customize the scanning process by setting a custom Executor for task execution and defining zoom suggestions using setZoomSuggestionOptions.

• The build() method is used to finalize and generate a BarcodeScannerOptions instance based on the provided configurations.

public static class BarcodeScannerOptions.Builder extends Object

Builder to build out a BarcodeScannerOptions.

Public Constructor Summary

Builder() Builder for BarcodeScannerOptions.

Public Method Summary

BarcodeScannerOptions	build() Builds a BarcodeScannerOptions instance.
BarcodeScannerOptions.Builder	enableAllPotentialBarcodes() Returns all potential barcodes when enabled, even if they cannot be decoded.
BarcodeScannerOptions.Builder	setBarcodeFormats(int format, int... moreFormats) Sets the interested barcode formats defined in Barcode.BarcodeFormat.
BarcodeScannerOptions.Builder	setExecutor(Executor executor) Sets the custom Executor to use.
BarcodeScannerOptions.Builder	setZoomSuggestionOptions(ZoomSuggestionOptions zoomSuggestionOptions) Sets the ZoomSuggestionOptions to use.

Inherited Method Summary

From class java.lang.Object

Object	clone()
boolean	equals(Object arg0)
void	finalize()
final Class<?>	getClass()
int	hashCode()
final void	notify()
final void	notifyAll()
String	toString()
final void	wait(long arg0, int arg1)
final void	wait(long arg0)
final void	wait()

Public Constructors

public Builder ()

Builder for BarcodeScannerOptions.

Public Methods

public BarcodeScannerOptions build ()

Builds a BarcodeScannerOptions instance.

public BarcodeScannerOptions.Builder enableAllPotentialBarcodes ()

Returns all potential barcodes when enabled, even if they cannot be decoded.

Barcode.getRawBytes() and Barcode.getRawValue() will return null for any undecoded barcodes, but Barcode.getBoundingBox() will return the area potentially containing a barcode.

This can be used to facilitate further detection, e.g., by zooming in the camera to get a clearer image of any barcode in the returned bounding box.

public BarcodeScannerOptions.Builder setBarcodeFormats (int format, int... moreFormats)

Sets the interested barcode formats defined in Barcode.BarcodeFormat.

e.g. setBarcodeFormats(Barcode.FORMAT_QR_CODE, Barcode.FORMAT_UPC_A).

Reducing the number of supported formats will make the barcode scanner faster.

Only the last call will be respected if calling this method multiple times

Default: all formats are supported.

Parameters

format	supported barcode format
moreFormats	more supported barcode formats

public BarcodeScannerOptions.Builder setExecutor (Executor executor)

Sets the custom Executor to use. If no Executor is set, an internal background thread pool will be used.

Most clients should not need to call this method.

Parameters

executor	the Executor to use

Returns

• this object, for chaining method calls

public BarcodeScannerOptions.Builder setZoomSuggestionOptions (ZoomSuggestionOptions zoomSuggestionOptions)

Sets the ZoomSuggestionOptions to use.

If this is specified, then the library will suggest zooming the camera if the barcode is too far away or too small to be detected.

Parameters

zoomSuggestionOptions	the ZoomSuggestionOptions to use

Returns

• this object, for chaining method calls.