Resource Base
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.

Parameter and Runtime Settings Basic Methods

Method Description
getRuntimeSettings Get current runtime settings.
updateRuntimeSettings (with struct) Modify and update the current runtime settings.
updateRuntimeSettings (with preset template) Update runtime settings from one of the preset templates.
resetRuntimeSettings Reset runtime settings to default.
setModeArgument Set argument value for the specified mode parameter.
getModeArgument Get argument value for the specified mode parameter.

getRuntimeSettings

Get current settings and save them into a PublicRuntimeSettings struct.

PublicRuntimeSettings getRuntimeSettings() throws BarcodeReaderException

Return Value

The struct of template settings.

Exceptions

BarcodeReaderException

Code Snippet

BarcodeReader reader = new BarcodeReader();
PublicRuntimeSettings settings = reader.getRuntimeSettings();
reader.destroy();

updateRuntimeSettings

With a PublicRuntimeSettings Struct

Update runtime settings with a given PublicRuntimeSettings struct.

void updateRuntimeSettings(PublicRuntimeSettings settings) throws BarcodeReaderException

Parameters

settings: The struct of template settings.

Exceptions

BarcodeReaderException

Code Snippet

BarcodeReader reader = new BarcodeReader();
PublicRuntimeSettings settings = reader.getRuntimeSettings();
settings.deblurLevel = 9;
reader.updateRuntimeSettings(settings);
reader.destroy();

With a Preset Template

Update the runtime settings from one of the preset templates.

void updateRuntimeSettings(EnumPresetTemplate presetTemplate)

Parameters

presetTemplate: One of the preset templates.

Code Snippet

BarcodeReader reader = new BarcodeReader();
reader.updateRuntimeSettings(EnumPresetTemplate.VIDEO_SINGLE_BARCODE);
reader.destroy();

resetRuntimeSettings

Reset all parameters to default values.

void resetRuntimeSettings() throws BarcodeReaderException

Exceptions

BarcodeReaderException

Code Snippet

BarcodeReader reader = new BarcodeReader();
PublicRuntimeSettings settings = reader.getRuntimeSettings();
settings.deblurLevel = 9;
reader.updateRuntimeSettings(settings);
reader.resetRuntimeSettings();
reader.destroy();

setModeArgument

Sets the optional argument for a specified mode in Modes parameters.

void 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.

Exceptions

BarcodeReaderException

Code Snippet

BarcodeReader reader = new BarcodeReader();
PublicRuntimeSettings settings = reader.getRuntimeSettings();
settings.binarizationModes[0] = EnumBinarizationMode.BM_LOCAL_BLOCK;
reader.updateRuntimeSettings(settings);
reader.setModeArgument("BinarizationModes", 0, "EnableFillBinaryVacancy", "1");
reader.destroy();

Remarks

Check the available modes and arguments below:

getModeArgument

Gets the optional argument for a specified mode in Modes parameters.

String 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.

Exceptions

BarcodeReaderException

Code Snippet

BarcodeReader reader = new BarcodeReader();
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");
reader.destroy();

Remarks

Check the available modes and arguments below:

This page is compatible for:

Version 7.5.0

Is this page helpful?

YesYes NoNo

In this article:

latest version

  • Latest version
  • Version 8.9.0
  • Version 8.8.0
  • Version 8.6.3
  • Version 8.6.1
  • Version 8.6.0
  • Version 8.4.0
  • Version 8.2.5
  • Version 8.2.3
  • Version 8.2.1
  • Version 8.2.0
  • Version 8.1.3
  • Version 8.1.2
  • Version 8.1.0
  • Version 8.0.0
  • Version 7.6.0
  • Version 7.5.0
Change +
© 2003–2022 Dynamsoft. All rights reserved.
Privacy Statement / Site Map / Home / Purchase / Support