Configure Barcode Formats

There are two ways to configure barcode formats:

• Configure formats in code.
• Configure formats together with other settings in the template.

Configure Formats in Your Code

Specify barcode formats using a combined value of EnumBarcodeFormat.

• Use bitwise OR (|) to combine multiple formats.
• EnumBarcodeFormat.BF_DEFAULT includes all common formats (BF_ONED, BF_GS1_DATABAR, BF_PDF417, BF_QR_CODE, BF_DATAMATRIX, BF_AZTEC, BF_MAXICODE, BF_MICRO_QR, BF_MICRO_PDF417, and BF_GS1_COMPOSITE).
• Use EnumBarcodeFormat.BF_ALL to enable all supported formats.
• Use group values like EnumBarcodeFormat.BF_ONED when appropriate.

Example:

• Java
• Kotlin

1. try {
     SimplifiedCaptureVisionSettings settings = mRouter.getSimplifiedSettings(EnumPresetTemplate.PT_READ_BARCODES);
     SimplifiedBarcodeReaderSettings barcodeSettings = settings.barcodeSettings;
     // Only read QR Code.
     barcodeSettings.barcodeFormatIds = EnumBarcodeFormat.BF_QR_CODE | EnumBarcodeFormat.BF_DATAMATRIX;
     mRouter.updateSettings(EnumPresetTemplate.PT_READ_BARCODES, settings);
   } catch (CaptureVisionRouterException e) {
     throw new RuntimeException(e);
   }
   

2. try {
     val settings = mRouter.getSimplifiedSettings(EnumPresetTemplate.PT_READ_BARCODES)
     val barcodeSettings = settings.barcodeSettings
     // Only read QR Code.
     barcodeSettings.barcodeFormatIds = EnumBarcodeFormat.BF_QR_CODE or EnumBarcodeFormat.BF_DATAMATRIX
     mRouter.updateSettings(EnumPresetTemplate.PT_READ_BARCODES, settings)
   } catch (e: CaptureVisionRouterException) {
     throw RuntimeException(e)
   }
   

Related API(s)

• SimplifiedCaptureVisionSettings.barcodeSettings.barcodeFormatIds

Configure Formats in a Template

Barcode formats are specified in BarcodeFormatIds under BarcodeReaderTaskSettingOptions. For example:

{
  "CaptureVisionTemplates": [
    {
      "ImageROIProcessingNameArray": [ "ROI_2D" ],
      "Name": "ReadCommon2D",
    }
  ],
  "TargetROIDefOptions": [
    {
      "Name": "ROI_2D",
      "TaskSettingNameArray": [ "Task_2D" ]
    }
  ],
  "BarcodeReaderTaskSettingOptions": [
    {
      "Name": "Task_2D",
      "BarcodeFormatIds": [ "BF_QR_CODE", "BF_DATAMATRIX", "BF_PDF417", "BF_MAXICODE" ],
      "SectionArray": [
        {
          "Section": "ST_BARCODE_LOCALIZATION",
          "ImageParameterName": "ip"
        },
        {
          "Section": "ST_BARCODE_DECODING",
          "ImageParameterName": "ip"
        }
      ]
    }
  ],
  "ImageParameterOptions": [
    {
      "Name": "ip"
    }
  ]
}

For common formats, you can download and use the preset templates below: