BatchProcessor Object (IBatchProcessor Interface)

1. Implement the IImageSource and IFileAdapter interfaces, which provide access to the image source and files in it.
2. [optional] Implement the IAsyncProcessingCallback interface to manage the processing. The methods of this interface allow you to handle errors and/or cancel the processing.
3. Call the CreateBatchProcessor method of the Engine object, to receive the BatchProcessor object.
4. Use the PageFlushingPolicy property to set the mode of working with document pages in memory.
5. Call the Start method to initialize the processor and invoke asynchronous recognition processes. You can specify the source of images and processing settings in this method.

• The BatchProcessor object cannot be reused. Repeated calls to the Start method will cause errors.
• Do not create and use several Batch Processors simultaneously, as this may lead to the confusion of processing pages.

6. Call the GetNextProcessedPage method in a loop until the method returns 0, which means that there are no more images in the source and all the processed images have been returned to the user.

​

Properties

​

Methods

​

Output parameter

​

Samples

// Create Batch Processor
FREngine.IBatchProcessor batchProcessor = engine.CreateBatchProcessor();
FREngine.IFRDocument document = engine.CreateFRDocument();
// Initialize the processor
FREngine.IImageSource imageSource = new CImageSource; // the class is implemented by the user
batchProcessor.PageFlushingPolicy = FREngine.PageFlushingPolicyEnum.PFP_KeepInMemory;
batchProcessor.Start( imageSource, null, null, null );
// Start processing
while( true ) {
 FREngine.IFRPage page = batchProcessor.GetNextProcessedPage();
 if( page == null ) {
  break; // there are no more pages, end of the work
 }
 // do something with the page
 ...
 document.AddPage( page );
}

​

See also