Configure Settings

initSettings

Configures runtime settings using a provided JSON string, which contains settings for one or more CaptureVisionTemplates.

void initSettings(String content) throws CaptureVisionRouterException;

Parameters

[in] content: A JSON string that contains Capture Vision settings.

Exception

initSettingsFromFile

Configures runtime settings using a provided JSON file, which contains settings for one or more CaptureVisionTemplates.

void initSettingsFromFile(String filePath) throws CaptureVisionRouterException;

Parameters

[in] file: A JSON file that contains Capture Vision settings.

Exception

Code Snippet

Add a Templates folder to the assets folder of your project at src\main\assets\Templates. Put your JSON file in the Templates folder. Here we use a ReadPDF417.json file as an example.

Add the following code to initialize the template:

try {
    mRouter.initSettingsFromFile("ReadPDF417.json");
} catch (CaptureVisionRouterException e) {
    throw new RuntimeException(e);
}

To use your template, you have to specify the template name in the startCapturing or capture method. The template name is the name of CaptureVisionTemplates in your template file (see in the image of step 3).

For example:

mRouter.startCapturing("ReadPDF417", new CompletionListener() {
    @Override
    public void onSuccess() {
        // Add code to run when the capture is successfully started.
    }

    @Override
    public void onFailure(int errorCode, String errorString) {
        // Add code to run when the capture fails.
    }
});

getSimplifiedSettings

Retrieves a simplified version of the Capture Vision settings for a specific template.

SimplifiedCaptureVisionSettings getSimplifiedSettings(String templateName) throws CaptureVisionRouterException;

Parameters

templateName: Specify a template with a templateName for the data capturing.

Return Value

An object of SimplifiedCaptureVisionSettings.

Exception

getTemplateNames

Retrieves the names of all the currently available templates.

String[] getTemplateNames();

Return Value

An array that contains all the currently available templates names.

updateSettings

Updates the specified CaptureVisionTemplate with an updated SimplifiedCaptureVisionSettings object.

void updateSettings(String templateName, SimplifiedCaptureVisionSettings settings) throws CaptureVisionRouterException;

Parameters

[in] templateName: Specify the name of the template that you want to update.

[in] settings: An object of SimplifiedCaptureVisionSettings.

Exception

resetSettings

Restores all settings to their original default values.

void resetSettings() throws CaptureVisionRouterException;

Exception

outputSettings

Returns an object that contains settings for the specified CaptureVisionTemplate.

String outputSettings(String templateName) throws CaptureVisionRouterException;

[in] templateName: The name of the template that you want to output.

Return Value

The Capture Vision settings in a JSON string.

Exception

outputSettingsToFile

Generates a JSON file download containing the settings for the specified CaptureVisionTemplate.

void outputSettingsToFile(String templateName, String filePath) throws CaptureVisionRouterException;

Parameters

[in] templateName: The name of the template that you want to output.

[in] file: The file path and name that you want to save the template.

Exception

Code Snippet

try {
    // To output the template to a JSON file, you have to get the read/write permission of the external storage first.
    // In this example, we output the template to the documents folder.
    String outputPath = String.valueOf(Environment.getExternalStoragePublicDirectory(Environment.DIRECTORY_DOCUMENTS));
    // Optional code. If you want to create a new folder under the documents folder, please uncomment the following code.
    // File file = new File(outputPath);
    // if(!file.exists()) {
    //     file.mkdirs();
    // }
    // You have to specify the template name and the file path. Here we use the preset template "PT_READ_BARCODES" as an example.
    mRouter.outputSettingsToFile(EnumPresetTemplate.PT_READ_BARCODES, outputPath+"/outputTemplate.json");
} catch (CaptureVisionRouterException e) {
    throw new RuntimeException(e);
}