Documentation
Table of contents

BarcodeColourModes

Parameter BarcodeColourModes defines the barcode colour modes. It consists of one or more modes, with each representing a different colour environment.

Example

"BarcodeColourModes" : 
[
    {
        "LightReflection" : 1,
        "Mode" : "BICM_DARK_ON_LIGHT"
    }
]

Parameter Summary

Parameter BarcodeColourModes consist of a group of barcode colour mode objects. Each barcode colour mode object includes a candidate mode and a series of auxiliary mode arguments.

Mode Arguments

The mode arguments of the barcode colour mode object are shown as follow:

Mode Argument Name Mode Argument Summary
Mode
(Required)
Description
Specifies a target barcode colour mode.
Type
String
Candidate Mode List
BICM_DARK_ON_LIGHT
BICM_LIGHT_ON_DARK
BICM_DARK_ON_DARK
BICM_LIGHT_ON_LIGHT
BICM_DARK_LIGHT_MIXED
BICM_DARK_ON_LIGHT_DARK_SURROUNDING
BICM_SKIP
Default Value
BICM_DARK_ON_LIGHT
LightReflection
(Optional)
Description
A number from value range of LightReflection.
Type
int
Range
[0,1]
Default Value
1
Remarks
0: no light reflection.
1: has light reflection.
LibraryFileName
(Optional)
Description
Sets the file name of the library to load dynamically.
Type
String
Range
A string value representing file name.
Default Value
""
Valid For
All modes.
LibraryParameters
(Optional)
Description
The library must be in the same place with Dynamsoft Barcode Reader Library.
Type
String
Range
A string value representing parameters.
Default Value
""
Valid For
All modes.

Default Setting

If the BarcodeColourModes is not configured in your template file, the following setting will be used as the default setting.

{
    "BarcodeColourModes" : null
}

Candidate Modes Introduction

BICM_DARK_ON_LIGHT

The target barcode is a dark item on a light background. This mode has the following arguments for further customizing.

Available Mode Arguments:

  • LightReflection
  • LibraryFileName
  • LibraryParameters

BICM_DARK_ON_LIGHT_DARK_SURROUNDING

The target barcode is a dark item on a light background surrounded by dark. This mode has the following arguments for further customizing.

Available Mode Arguments:

  • LightReflection
  • LibraryFileName
  • LibraryParameters

BICM_LIGHT_ON_DARK

The target barcode is a light item on a dark background. Not supported yet.

BICM_DARK_ON_DARK

The target barcode is a dark item on a dark background. Not supported yet.

BICM_LIGHT_ON_LIGHT

The target barcode is a light item on a light background. Not supported yet.

BICM_DARK_LIGHT_MIXED

The target barcode is on background which is mixed by dark and light. Not supported yet

This page is compatible for:

Version 1.0

Is this page helpful?

YesYes NoNo

In this article:

latest version

    • Latest version
    • Version 2.x
      • Version 2.2.20
      • Version 2.2.10
      • Version 2.2.0
      • Version 2.0.30
      • Version 2.0.20
      • Version 2.0.10
      • Version 2.0.0
    Change +
    © 2003–2024 Dynamsoft. All rights reserved.
    Privacy Statement / Site Map / Home / Purchase / Support