Parameter and Runtime Settings Basic Methods

Method	Description
`getRuntimeSettings`	Get current runtime settings.
`updateRuntimeSettings(PublicRuntimeSettings)`	Modify and update the current runtime settings.
`updateRuntimeSettings(EnumPresetTemplate)`	Update runtime settings from one of the preset templates.
`resetRuntimeSettings`	Reset runtime settings to default.

getRuntimeSettings

Get current settings and save them into a PublicRuntimeSettings struct.

PublicRuntimeSettings getRuntimeSettings() throws BarcodeReaderException

Return Value

The PublicRuntimeSettings struct of template settings.

Exceptions

A BarcodeReaderException is thrown when:

The library failed to get the current runtime settings.

Code Snippet

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

updateRuntimeSettings(PublicRuntimeSettings)

Update runtime settings with a given PublicRuntimeSettings struct.

void updateRuntimeSettings(PublicRuntimeSettings settings) throws BarcodeReaderException

Parameters

settings: The PublicRuntimeSettings struct of template settings.

Exceptions

A BarcodeReaderException is thrown when:

There exists parameters that are invalid or out of range.

Code Snippet

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

updateRuntimeSettings(EnumPresetTemplate)

Update the runtime settings from one of the preset templates.

void updateRuntimeSettings(EnumPresetTemplate presetTemplate)

Parameters

presetTemplate: One of the preset templates defined by EnumPresetTemplate

Code Snippet

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

resetRuntimeSettings

Reset all parameters to default values.

void resetRuntimeSettings() throws BarcodeReaderException

Exceptions

A BarcodeReaderException is thrown when:

The library failed to reset the runtime settings.

Code Snippet

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