Advanced Settings Methods

Method	Description
`initRuntimeSettingsWithFile`	Initialize runtime settings with the settings in a given JSON file.
`initRuntimeSettingsWithString`	Initialize runtime settings with the settings in a given JSON string.
`appendTplFileToRuntimeSettings`	Append a new template file to the current runtime settings.
`appendTplStringToRuntimeSettings`	Append a new template string to the current runtime settings.
`getAllParameterTemplateNames`	Gets the parameter templates name array.
`outputSettingsToFile`	Output runtime settings to a settings file (JSON file).
`outputSettingsToString`	Output runtime settings to a string.

initRuntimeSettingsWithFile

Initialize runtime settings with the settings in a given JSON file.

void com.dynamsoft.dbr.BarcodeReader.initRuntimeSettingsWithFile(String filePath, int enumConflictMode) throws BarcodeReaderException

Parameters
filePath The path of the settings file.
enumConflictMode The parameter setting mode, which decides whether to inherit parameters from previous template setting or to overwrite previous settings and replace with the new template.

Exception
BarcodeReaderException

Code Snippet

BarcodeReader.initLicense("YOUR-LICENSE-KEY");
BarcodeReader reader = BarcodeReader.getInstance();
if(reader != null)
{
	reader.initRuntimeSettingsWithFile("your template file path", EnumConflictMode.CM_OVERWRITE);
    // add further process
    reader.recycle();
}

initRuntimeSettingsWithString

Initialize runtime settings with the settings in a given JSON string.

void com.dynamsoft.dbr.BarcodeReader.initRuntimeSettingsWithString(String content, int enumConflictMode)throws BarcodeReaderException

Parameters
content A JSON string that represents the content of the settings.
enumConflictMode The parameter setting mode, which decides whether to inherit parameters from previous template setting or to overwrite previous settings and replace with the new template.

Exception
BarcodeReaderException

Code Snippet

BarcodeReader.initLicense("YOUR-LICENSE-KEY");
BarcodeReader reader = BarcodeReader.getInstance();
if(reader != null)
{
	reader.initRuntimeSettingsWithString("{\"Version\":\"3.0\", \"ImageParameter\":{\"Name\":\"IP1\", \"BarcodeFormatIds\":[\"BF_QR_CODE\"], \"ExpectedBarcodesCount\":10}}", EnumConflictMode.CM_OVERWRITE);
    // add further process
    reader.recycle();
}

appendTplFileToRuntimeSettings

Append a new template file to the current runtime settings.

void com.dynamsoft.dbr.BarcodeReader.appendTplFileToRuntimeSettings(String filePath, int enumConflictMode) throws BarcodeReaderException

Exception
BarcodeReaderException

Code Snippet

BarcodeReader.initLicense("YOUR-LICENSE-KEY");
BarcodeReader reader = BarcodeReader.getInstance();
if(reader != null)
{
	reader.appendTplFileToRuntimeSettings("your template file path", EnumConflictMode.CM_IGNORE);
    // add further process
    reader.recycle();
}

appendTplStringToRuntimeSettings

Append a new template string to the current runtime settings.

void com.dynamsoft.dbr.BarcodeReader.appendTplStringToRuntimeSettings(String content, int enumConflictMode)	throws BarcodeReaderException	

Exception
BarcodeReaderException

Code Snippet

BarcodeReader.initLicense("YOUR-LICENSE-KEY");
BarcodeReader reader = BarcodeReader.getInstance();
if(reader != null)
{
	reader.initRuntimeSettingsWithString("{\"Version\":\"3.0\", \"ImageParameter\":{\"Name\":\"IP1\", \"BarcodeFormatIds\":[\"BF_QR_CODE\"], \"ExpectedBarcodesCount\":10}}", EnumConflictMode.CM_OVERWRITE);
	reader.appendTplStringToRuntimeSettings("{\"Version\":\"3.0\", \"ImageParameter\":{\"Name\":\"IP2\", \"BarcodeFormatIds\":[\"BF_OneD\"], \"ExpectedBarcodesCount\":20}}", EnumConflictMode.CM_IGNORE);
    // add further process
    reader.recycle();
}

getAllParameterTemplateNames

Gets the parameter templates name array.

String [] com.dynamsoft.dbr.BarcodeReader.getAllParameterTemplateNames()		

Return Value
The template name array.

Exception
BarcodeReaderException

Code Snippet

BarcodeReader.initLicense("YOUR-LICENSE-KEY");
BarcodeReader reader = BarcodeReader.getInstance();
if(reader != null)
{
	String[] templateNames = reader.getAllParameterTemplateNames();
    // add further process
    reader.recycle();
}

outputSettingsToFile

Output runtime settings to a settings file (JSON file).

void com.dynamsoft.dbr.BarcodeReader.outputSettingsToFile(String filePath, String settingsName) throws BarcodeReaderException

Parameters
filePath The output file path which stores current settings.
settingsName A unique name for declaring current runtime settings.

Exception
BarcodeReaderException

Code Snippet

BarcodeReader.initLicense("YOUR-LICENSE-KEY");
BarcodeReader reader = BarcodeReader.getInstance();
if(reader != null)
{
	reader.outputSettingsToFile("your saving file path", "currentRuntimeSettings");
    // add further process
    reader.recycle();
}

outputSettingsToString

Output runtime settings to a string.

String com.dynamsoft.dbr.BarcodeReader.outputSettingsToString(String settingsName) throws BarcodeReaderException

Parameters
settingsName A unique name for declaring current runtime settings.

Return Value
The output string which stores the contents of current settings.

Code Snippet

BarcodeReader.initLicense("YOUR-LICENSE-KEY");
BarcodeReader reader = BarcodeReader.getInstance();
if(reader != null)
{
	String settingStr = reader.outputSettingsToString("currentRuntimeSettings");
    // add further process
    reader.recycle();
}