Dev Center
Table of contents

Thanks for downloading Dynamsoft Barcode Reader Package!

Your download will start shortly. If your download does not begin, click here to retry.


ColourClusteringModes controls the process of colour categorization. It consists of one or more modes, each mode representing a different way to implement the categorization.

Candidate Mode List



This mode clusters the colours using the general algorithm based on HSV (hue, saturation, value). This mode has the following arguments for further customization.


Lets the library choose a mode automatically. Not supported yet.

Setting Methods

As PublicRuntimeSettings Member

ColourClusteringModes can be set dynamically during runtime as a member of FurtherModes, which is a member of PublicRuntimeSettings struct, it is an array with 8 ColourClusteringMode Enumeration items.

Code Snippet in C++

//...other codes
PublicRuntimeSettings* pSettings = new PublicRuntimeSettings;
int errorCode = reader->GetRuntimeSettings(pSettings);
pSettings->colourClusteringModes[0] = CCM_GENERAL_HSV;
reader->SetModeArgument("ColourClusteringModes", 0, "Sensitivity", "1");
delete pSettings;
//...other codes

GetModeArgument and SetModeArgument need to be called for getting and setting Arguments.

See Also

As JSON Parameter

ColourClusteringModes as a JSON parameter is a JSON Object array. Each JSON object is defined as below.

Key Name Key Value Description
Mode Any one in Candidate Mode List as string (Required) Specifies a mode for colour categorization.
Sensitivity A number from value range of Sensitivity (Optional) Sets the Argument Sensitivity.
LibraryFileName A string from value range of LibraryFileName (Optional) Sets the Argument LibraryFileName.
LibraryParameters A string from value range of LibraryParameters (Optional) Sets the Argument LibraryParameters.

JSON Parameter Example

    "ColourClusteringModes": [
            "Mode": "CCM_GENERAL_HSV", 
            "Sensitivity": 1
            "Mode": "CCM_GENERAL_HSV", 
            "Sensitivity": 9

Candidate Argument List


Sets the sensitivity used for colour categorization. A bigger value means less colours will be clustered as the same colour.

Value Type Value Range Default Value Valid For
int [1, 9] 5 CCM_GENERAL_HSV


Sets the file name of the library to load dynamically.

Value Type Value Range Default Value Valid For
string A string value representing file name. ”” All modes

The library must be in the same place with Dynamsoft Barcode Reader Library.


Sets the parameters passed to the library to load dynamically.

Value Type Value Range Default Value Valid For
string A string value representing parameters. ”” All modes

This page is compatible for:

Version 7.5.0

Is this page helpful?

YesYes NoNo

In this article:

latest version

    • Latest version
    • Version 10.x
      • Version 10.2.0
      • Version 10.0.21
      • Version 10.0.20
      • Version 10.0.10
      • Version 10.0.0
    • Version 9.x
      • Version 9.6.42
      • Version 9.6.40
      • Version 9.6.33
      • Version 9.6.32
      • Version 9.6.31
      • Version 9.6.30
      • Version 9.6.20
      • Version 9.6.10
      • Version 9.6.0
      • Version 9.4.0
      • Version 9.2.0
      • Version 9.0.0
    • Version 8.x
      • Version 8.8.0
      • Version 8.6.0
      • Version 8.4.0
      • Version 8.2.0
      • Version 8.1.2
      • Version 8.1.0
      • Version 8.0.0
    • Version 7.x
      • Version 7.6.0
      • Version 7.5.0
    Change +