This page covers the description of available scenarios
Scenario is the main setting for Document Reader SDK. It controls all scanning process of Core framework. Depending on the selected scenario, Core works in different ways. The set of available scenarios is different for each Core type. The following part of code allows to get all available scenarios (should be used after initialization is completed):
// getting current processing scenarioStringcurrentScenario=DocumentReader.Instance().processParams().scenario;// list of available scenariosArrayList<String>scenarios=newArrayList<>();for(DocumentReaderScenarioscenario:DocumentReader.Instance().availableScenarios){scenarios.add(scenario.name);}
// getting current processing scenariovar currentScenario: String? = DocumentReader.Instance().processParams().scenario// list of available scenariosval scenarios =ArrayList<String>()for (scenario in DocumentReader.Instance().availableScenarios) { scenarios.add(scenario.name)}
DocumentReaderScenario class contains two main properties:
name - name of a scenario, use this value to set scenario for Document Reader SDK.
description - brief description of the scenario functionality and usage.
After initialization is completed, the processing scenario should be set, like so:
// set the scenario valueDocumentReader.Instance().processParams().scenario="Mrz";
// set the scenario valueDocumentReader.Instance().processParams().scenario ="Mrz"
Comparison table of available scenarios vs results is below:
Scenario name
Multiple pages processing
Document location
MRZ OCR
Barcode data
Document type
Visual zone OCR
Graphic fields
Credit card data
Locate
A
X
Mrz
X
MrzOrLocate
O
O
MrzAndLocate
A
X
X
Barcode
X
MrzOrBarcode
O
O
MrzOrOcr
A
O
O
O
O
O
MrzOrBarcodeOrOcr
O
O
O
O
O
O
LocateVisual_And_MrzOrOcr
A
X
O
O
O
O
DocType
A
O
O
X
O
Ocr
A
X
O
X
X
O
FullProcess
A
X
O
O
X
O
X
Id3Rus
O
O
O
O
O
Capture
X
A - the option is available for this scenario.
Empty - the result type is not included in processing list and won't be available
O - the result type is not mandatory to reach COMPLETED state. Might be available, when processing is finished.
X - the result type is mandatory to reach COMPLETED state and will always be available when processing is finished.
Comparison table of available scenarios vs Cores is below:
