Java API Reference - BarcodeReader Parameter and Runtime Settings Basic 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.barcode.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.

Exceptions

BarcodeReaderException

Remark

Check follow link for available modes and arguments:

Code Snippet

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

getModeArgument

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

String com.dynamsoft.barcode.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.

Exceptions

BarcodeReaderException

Remark

Check follow link for available modes and arguments:

Code Snippet

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

getRuntimeSettings

Get current settings and save them into a PublicRuntimeSettings struct.

PublicRuntimeSettings com.dynamsoft.barcode.BarcodeReader.getRuntimeSettings() throws BarcodeReaderException	

Return value

A PublicRuntimeSettings with current settings.

Exceptions

BarcodeReaderException

Code Snippet

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

updateRuntimeSettings

Update runtime settings with a given PublicRuntimeSettings struct.

void com.dynamsoft.barcode.BarcodeReader.updateRuntimeSettings(PublicRuntimeSettings settings) throws BarcodeReaderException

Parameters

settings The struct of template settings.

Exceptions

BarcodeReaderException

Code Snippet

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

resetRuntimeSettings

Reset all parameters to default values.

void com.dynamsoft.barcode.BarcodeReader.resetRuntimeSettings()	throws BarcodeReaderException

#### Exceptions
[`BarcodeReaderException`](/barcode-reader/docs/server/programming/java/api-reference/class/BarcodeReaderException.html)

Code Snippet

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