Basic Settings Methods
| Method | Description |
|---|---|
setModeArgument |
Set argument value for the specified mode parameter. |
getModeArgument |
Get argument value for the specified mode parameter. |
getRuntimeSettings |
Get current runtime settings. |
updateRuntimeSettings |
Modify and update the current runtime settings. |
resetRuntimeSettings |
Reset runtime settings to default. |
setModeArgument
Sets the optional argument for a specified mode in Modes parameters.
void com.dynamsoft.dbr.BarcodeReader.setModeArgument(String modesName, int index, String argumentName, String argumentValue) throws BarcodeReaderException
Parameters
modesName The mode parameter name to set argument.
index The array index of mode parameter to indicate a specific mode.
argumentName The name of the argument to set.
argumentValue The value of the argument to set.
Exception
BarcodeReaderException
Code Snippet
BarcodeReader.initLicense("YOUR-LICENSE-KEY");
BarcodeReader reader = BarcodeReader.getInstance();
if(reader != null)
{
PublicRuntimeSettings settings = reader.getRuntimeSettings();
settings.binarizationModes[0] = EnumBinarizationMode.BM_LOCAL_BLOCK;
reader.updateRuntimeSettings(settings);
reader.setModeArgument("BinarizationModes", 0, "EnableFillBinaryVacancy", "1");
// add further process
reader.recycle();
}
Remarks
Check follow link for available modes and arguments:
BarcodeColourModesBinarizationModesColourClusteringModesColourConversionModesDeformationResistingModesImagePreprocessingModesIntermediateResultSavingModeLocalizationModesRegionPredetectionModesScaleUpModesTextFilterModesTextureDetectionModes
getModeArgument
Gets the optional argument for a specified mode in Modes parameters.
String com.dynamsoft.dbr.BarcodeReader.getModeArgument(String modesName, int index, String argumentName) throws BarcodeReaderException
Parameters
modesName The mode parameter name to get argument.
index The array index of mode parameter to indicate a specific mode.
argumentName The name of the argument to get.
Return Value
the optional argument for a specified mode in Modes parameters.
Exception
BarcodeReaderException
Code Snippet
BarcodeReader.initLicense("YOUR-LICENSE-KEY");
BarcodeReader reader = BarcodeReader.getInstance();
if(reader != null)
{
PublicRuntimeSettings settings = reader.getRuntimeSettings();
settings.binarizationModes[0] = EnumBinarizationMode.BM_LOCAL_BLOCK;
reader.updateRuntimeSettings(settings);
reader.setModeArgument("BinarizationModes", 0, "EnableFillBinaryVacancy", "1");
String argumentValue = reader.getModeArgument("BinarizationModes", 0, "EnableFillBinaryVacancy");
// add further process
reader.recycle();
}
Remarks
Check follow link for available modes and arguments:
BarcodeColourModesBinarizationModesColourClusteringModesColourConversionModesDeformationResistingModesImagePreprocessingModesIntermediateResultSavingModeLocalizationModesRegionPredetectionModesScaleUpModesTextFilterModesTextureDetectionModes
getRuntimeSettings
Get current settings and save them into a PublicRuntimeSettings struct.
PublicRuntimeSettings com.dynamsoft.dbr.BarcodeReader.getRuntimeSettings() throws BarcodeReaderException
Return Value
A PublicRuntimeSettings with current settings.
Exception
BarcodeReaderException
Code Snippet
BarcodeReader.initLicense("YOUR-LICENSE-KEY");
BarcodeReader reader = BarcodeReader.getInstance();
if(reader != null)
{
PublicRuntimeSettings settings = reader.getRuntimeSettings();
// add further process
reader.recycle();
}
updateRuntimeSettings
Update runtime settings with a given PublicRuntimeSettings struct.
void com.dynamsoft.dbr.BarcodeReader.updateRuntimeSettings(PublicRuntimeSettings settings) throws BarcodeReaderException
Parameters
settings The struct of template settings.
Exception
BarcodeReaderException
Code Snippet
BarcodeReader.initLicense("YOUR-LICENSE-KEY");
BarcodeReader reader = BarcodeReader.getInstance();
if(reader != null)
{
PublicRuntimeSettings settings = reader.getRuntimeSettings();
settings.deblurLevel = 9;
reader.updateRuntimeSettings(settings);
// add further process
reader.recycle();
}
resetRuntimeSettings
Reset all parameters to default values.
void com.dynamsoft.dbr.BarcodeReader.resetRuntimeSettings() throws BarcodeReaderException
Exception
BarcodeReaderException
Code Snippet
BarcodeReader.initLicense("YOUR-LICENSE-KEY");
BarcodeReader reader = BarcodeReader.getInstance();
if(reader != null)
{
PublicRuntimeSettings settings = reader.getRuntimeSettings();
settings.deblurLevel = 9;
reader.updateRuntimeSettings(settings);
reader.resetRuntimeSettings();
// add further process
reader.recycle();
}