# BarcodeScannerConfig `BarcodeScannerConfig` is the class that defines the configurations for barcode scanning. Once the `BarcodeScannerConfig` object is made, it is set via the `BarcodeScannerActivity.ResultContract`. ## Definition *Assembly:* DynamsoftBarcodeReaderBundle.aar *Namespace:* com.dynamsoft.dbrbundle.ui ```java final class BarcodeScannerConfig ``` ## Methods | Method | Description | | ------ | ----------- | | [`setLicense`](#setlicense) | Sets the license key for the Barcode Reader. | | [`setScanningMode`](#setscanningmode) | Sets the scanning mode. | | [`setTemplateFile`](#settemplatefile) | Sets the template with a file path or a JSON string. | | [`setBarcodeFormats`](#setbarcodeformats) | Sets the barcode format(s) to read. | | [`setScanRegion`](#setscanregion) | Sets a scan region where only the barcodes located in the scan region can be decoded. | | [`setTorchButtonVisible`](#settorchbuttonvisible) | Sets whether to display the torch button when scanning or not. | | [`setBeepEnabled`](#setbeepenabled) | Sets whether to trigger a beep sound when a barcode is detected. | | [`setVibrateEnabled`](#setvibrateenabled) | Sets whether to trigger a vibration when a barcode is detected. | | [`setScanLaserVisible`](#setscanlaservisible) | Sets whether to display a scan laser when scanning. | | [`setAutoZoomEnabled`](#setautozoomenabled) | Sets whether to enable the auto-zoom feature when scanning. | | [`setCloseButtonVisible`](#setclosebuttonvisible) | Sets whether to display a button that can close the scanner page. | | [`setMaxConsecutiveStableFramesToExit`](#setmaxconsecutivestableframestoexit) | Sets how long the library will keep scanning when there is no more barcodes to decode. | | [`setExpectedBarcodesCount`](#setexpectedbarcodescount) | Sets the expected number of barcodes. The multiple barcodes scanning will be stopped when the `expectedBarcodesCount` is reached. | | [`setCameraToggleButtonVisible`](#setcameratogglebuttonvisible) | Sets whether to display the camera toggle button. | | [`setZoomFactor`](#setzoomfactor) | Sets the zoom factor. | | [`setResolution`](#setresolution) | Sets the resolution. | | [`getLicense`](#getlicense) | Returns the license key string. | | [`getScanningMode`](#getscanningmode) | Returns the scanning mode. | | [`getTemplateFile`](#gettemplatefile) | Returns the template with a file path or a JSON string. | | [`isTorchButtonVisible`](#istorchbuttonvisible) | Returns whether the button is visible. | | [`getBarcodeFormats`](#getbarcodeformats) | Returns the barcode format(s) that the library will accept. | | [`getScanRegion`](#getscanregion) | Returns the scan region. | | [`isBeepEnabled`](#isbeepenabled) | Returns whether the beep sound is enabled. | | [`isVibrateEnabled`](#isvibrateenabled) | Returns whether the vibration is enabled. | | [`isScanLaserVisible`](#isscanlaservisible) | Returns whether the scan laser is visible. | | [`isAutoZoomEnabled`](#isautozoomenabled) | Returns whether the auto-zoom feature is enabled. | | [`isCloseButtonVisible`](#isclosebuttonvisible) | Returns whether the close button is visible. | | [`getMaxConsecutiveStableFramesToExit`](#getmaxconsecutivestableframestoexit) | Returns the maximum number of consecutive stable frames to exit. | | [`getExpectedBarcodesCount`](#getexpectedbarcodescount) | Returns the expected number of barcodes. | | [`isCameraToggleButtonVisible`](#iscameratogglebuttonvisible) | Returns whether the camera toggle button is visible. | | [`getZoomFactor`](#getzoomfactor) | Returns the zoom factor. | | [`getResolution`](#getresolution) | Returns the resolution. | ### setLicense Sets the license key for the Barcode Reader. ```java void setLicense(String license); ``` **Parameter(s)** `license`: The license key to be used for initialization. ### setScanningMode Sets the scanning mode. ```java void setScanningMode(EnumScanningMode scanningMode); ``` **Parameter(s)** `scanningMode`: The scanning mode to be set, of type [`EnumScanningMode`](https://www.dynamsoft.com/barcode-reader/docs/mobile/programming/android/api-reference/barcode-scanner/enum-scanning-mode.md). ### setTemplateFile Sets the template with a file path or a JSON string. ```java void setTemplateFile(String templateFile); ``` **Parameter(s)** `templateFile`: The file path or a JSON string. ### setBarcodeFormats Sets the barcode format(s) to read. ```java void setBarcodeFormats(long format); ``` **Parameter(s)** `format`: A combined value of [`EnumBarcodeFormat`](https://www.dynamsoft.com/barcode-reader/docs/mobile/programming/android/api-reference/enum/barcode-format.md) to specify which barcode format(s) the library should target. ### setScanRegion Sets a scan region. Only the barcodes located in the scan region can be decoded. ```java void setScanRegion(DSRect scanRegion); ``` **Parameter(s)** `scanRegion`: A [`DSRect`](https://www.dynamsoft.com/capture-vision/docs/mobile/programming/android/api-reference/core/basic-structures/rect.md) object that specifies the scan region. ### setTorchButtonVisible Sets whether to display the torch button when scanning. User can click the torch button to turn on/off the torch. ```java void setTorchButtonVisible(boolean torchButtonVisible); ``` **Parameter(s)** `torchButtonVisible`: A boolean value that determines whether to display the torch button. ### setBeepEnabled Sets whether to trigger a beep sound when a barcode is detected. ```java void setBeepEnabled(boolean beepEnabled); ``` **Parameter(s)** `beepEnabled`: A boolean value that determines whether to enable the beep sound. ### setVibrateEnabled Sets whether to trigger a vibration when a barcode is detected. ```java void setVibrateEnabled(boolean vibrateEnabled); ``` **Parameter(s)** `vibrateEnabled`: A boolean value that determines whether to enable the vibration. ### setScanLaserVisible Sets whether to display a scan laser when scanning. ```java void setScanLaserVisible(boolean scanLaserVisible); ``` **Parameter(s)** `scanLaserVisible`: A boolean value that determines whether to display the scan laser. ### setAutoZoomEnabled Sets whether to enable the auto-zoom feature when scanning. ```java void setAutoZoomEnabled(boolean autoZoomEnabled); ``` **Parameter(s)** `autoZoomEnabled`: A boolean value that determines whether to enable the auto-zoom feature. ### setCloseButtonVisible Sets whether to display a button that can close the scanner page. ```java void setCloseButtonVisible(boolean closeButtonVisible); ``` **Parameter(s)** `closeButtonVisible`: A boolean value that determines whether to display the close button. ### setMaxConsecutiveStableFramesToExit Sets how long the library will keep scanning when there is no more barcodes to decode. The Default value is 10, which means the library will keep scanning for 10 consecutive stable frames. ```java void setMaxConsecutiveStableFramesToExit(int maxConsecutiveStableFramesToExit); ``` **Parameter(s)** `maxConsecutiveStableFramesToExit`: The maximum number of consecutive stable frames to exit. ### setExpectedBarcodesCount Sets the expected number of barcodes. The multiple barcodes scanning will be stopped when the `expectedBarcodesCount` is reached. ```java void setExpectedBarcodesCount(int expectedBarcodesCount); ``` **Parameter(s)** `expectedBarcodesCount`: The expected number of barcodes. ### setCameraToggleButtonVisible Sets whether to display the camera toggle button. ```java void setCameraToggleButtonVisible(boolean cameraToggleButtonVisible); ``` **Parameter(s)** `cameraToggleButtonVisible`: A boolean value that determines whether to display the camera toggle button. ### setZoomFactor Sets the zoom factor. ```java void setZoomFactor(float zoomFactor); ``` **Parameter(s)** `zoomFactor`: The zoom factor. ### setResolution Sets the resolution. ```java void setResolution(int resolution); ``` **Parameter(s)** `resolution`: The resolution. Reference [`EnumResolution`](https://www.dynamsoft.com/camera-enhancer/docs/mobile/programming/android/enum/resolution.md). **Remarks** - Introduced in Dynamsoft Barcode Reader SDK version 11.4.1000 and Dynamsoft Capture Vision version 3.4.1000. ### getLicense Returns the license key string. ```java String getLicense(); ``` **Return Value** The license key to be used for initialization. ### getScanningMode Returns the scanning mode. ```java EnumScanningMode getScanningMode(); ``` **Return Value** The scanning mode. ### getTemplateFile Returns the template with a file path or a JSON string. ```java String getTemplateFile(); ``` **Return Value** A file path or a JSON string. ### getBarcodeFormats Returns the barcode format settings. ```java long getBarcodeFormats(); ``` **Return Value** A combined value of [`EnumBarcodeFormat`](https://www.dynamsoft.com/barcode-reader/docs/mobile/programming/android/api-reference/enum/barcode-format.md) to specify which barcode format(s) the library should target. ### getScanRegion Returns the scan region. ```java DSRect getScanRegion(); ``` **Return Value** A [`DSRect`](https://www.dynamsoft.com/capture-vision/docs/mobile/programming/android/api-reference/core/basic-structures/rect.md) object that specifies the scan region. ### isTorchButtonVisible Returns a boolean indicating whether or not the torch button is visible. ```java boolean isTorchButtonVisible(); ``` **Return Value** A boolean value that determines whether the torch button is displayed. ### isBeepEnabled Returns a boolean indicating whether or not the beep sound is enabled. ```java boolean isBeepEnabled(); ``` **Return Value** A boolean value that determines whether the beep sound is enabled. ### isVibrateEnabled Returns a boolean indicating whether or not the vibration is enabled. ```java boolean isVibrateEnabled(); ``` **Return Value** A boolean value that determines whether the vibration is enabled. ### isScanLaserVisible Returns a boolean indicating whether or not the scan laser is visible. ```java boolean isScanLaserVisible(); ``` **Return Value** A boolean value that determines whether the scan laser is displayed. ### isAutoZoomEnabled Returns a boolean indicating whether or not the auto-zoom feature is enabled. ```java boolean isAutoZoomEnabled(); ``` **Return Value** A boolean value that determines whether the auto-zoom feature is enabled. ### isCloseButtonVisible Returns a boolean indicating whether or not the close button is visible. ```java boolean isCloseButtonVisible(); ``` **Return Value** A boolean value that determines whether the close button is displayed. ### getMaxConsecutiveStableFramesToExit Returns the maximum number of consecutive stable frames to exit. ```java int getMaxConsecutiveStableFramesToExit(); ``` **Return Value** The maximum number of consecutive stable frames to exit. ### getExpectedBarcodesCount Returns the expected number of barcodes. ```java int getExpectedBarcodesCount(); ``` **Return Value** The expected number of barcodes. ### isCameraToggleButtonVisible Returns a boolean indicating whether or not the camera toggle button is visible. ```java boolean isCameraToggleButtonVisible(); ``` **Return Value** A boolean value that determines whether the camera toggle button is displayed. ### getZoomFactor Returns the zoom factor. ```java float getZoomFactor(); ``` **Return Value** `zoomFactor`: The zoom factor. ### getResolution Returns the resolution. ```java int getResolution(); ``` **Return Value** The resolution. Represented by [`EnumResolution`](https://www.dynamsoft.com/camera-enhancer/docs/mobile/programming/android/enum/resolution.md). **Remarks** - Introduced in Dynamsoft Barcode Reader SDK version 11.4.1000 and Dynamsoft Capture Vision version 3.4.1000.