onFrameProcessed method of the Callback interface

Documentation Menu

Called by the service to deliver the result after recognizing the frames that were supplied.

The result stability status is also provided and should be used to determine if the accuracy is high enough for the result to be used for any practical purposes. We recommend not to use the data in any way until stability level has reached Available and the data scheme has been matched. When stability of the result has reached the desired level, the service may be stopped by calling the IDataCaptureService.stop method.

This method is to be implemented on the client side. The implementation of this method will probably contain assessing the result plausibility, displaying the results to the user or using them in any way you need.

void onFrameProcessed( DataScheme scheme, DataField[] fields, ResultStabilityStatus resultStatus, Warning warning )



A DataScheme object with information on the data scheme which was applied to the recognized frame.

warning Important! If null is passed instead of a valid DataScheme object, the data scheme has not yet been matched, which may mean that the document the user is trying to recognize does not fit the data capture profile with which the data service was created. In this case, the results are not usable.


The result as an array of data fields, represented by DataField objects.


The estimate of how stable the result is, represented by a ResultStabilityStatus enumeration constant. It is not guaranteed that it ever reaches desired levels for a particular scene.


The warning which occurred, if any; represented by a Warning enumeration constant.