-
- All Implemented Interfaces:
public final class ScannerConfig.Builder
-
-
Constructor Summary
Constructors Constructor Description ScannerConfig.Builder()
-
Method Summary
Modifier and Type Method Description final ScannerConfig.BuildersetBarcodeFormats(List<BarcodeFormat> formats)Set a list of interested barcode formats. final ScannerConfig.BuildersetOverlayStringRes(@StringRes() Integer stringRes)Set a string resource used for the scanner overlay. final ScannerConfig.BuildersetOverlayDrawableRes(@DrawableRes() Integer drawableRes)Set a drawable resource used for the scanner overlay. final ScannerConfig.BuildersetHorizontalFrameRatio(Float ratio)Set the horizontal overlay ratio (default is 1 / square frame). final ScannerConfig.BuildersetHapticSuccessFeedback(Boolean enable)Enable (default) or disable haptic feedback when a barcode was detected. final ScannerConfig.BuildersetShowTorchToggle(Boolean enable)Show or hide (default) torch/flashlight toggle button. final ScannerConfig.BuildersetUseFrontCamera(Boolean enable)Use the front camera. final ScannerConfig.BuildersetShowCloseButton(Boolean enable)Show or hide (default) close button. final ScannerConfigbuild()Build the BarcodeConfig required by the ScanBarcode ActivityResultContract. -
-
Method Detail
-
setBarcodeFormats
final ScannerConfig.Builder setBarcodeFormats(List<BarcodeFormat> formats)
Set a list of interested barcode formats. List must not be empty. Reducing the number of supported formats will make the barcode scanner faster.
-
setOverlayStringRes
final ScannerConfig.Builder setOverlayStringRes(@StringRes() Integer stringRes)
Set a string resource used for the scanner overlay.
-
setOverlayDrawableRes
final ScannerConfig.Builder setOverlayDrawableRes(@DrawableRes() Integer drawableRes)
Set a drawable resource used for the scanner overlay. If null is passed, no icon will be shown.
-
setHorizontalFrameRatio
final ScannerConfig.Builder setHorizontalFrameRatio(Float ratio)
Set the horizontal overlay ratio (default is 1 / square frame).
-
setHapticSuccessFeedback
final ScannerConfig.Builder setHapticSuccessFeedback(Boolean enable)
Enable (default) or disable haptic feedback when a barcode was detected.
-
setShowTorchToggle
final ScannerConfig.Builder setShowTorchToggle(Boolean enable)
Show or hide (default) torch/flashlight toggle button.
-
setUseFrontCamera
final ScannerConfig.Builder setUseFrontCamera(Boolean enable)
Use the front camera.
-
setShowCloseButton
final ScannerConfig.Builder setShowCloseButton(Boolean enable)
Show or hide (default) close button.
-
build
final ScannerConfig build()
Build the BarcodeConfig required by the ScanBarcode ActivityResultContract.
-
-
-
-