Skip to main content

Migration to version 1.3.*

New Document Camera​

This version of the SDK contains a brand new implementation of the document camera. This version of the SmartCapture document camera is designed to capture higher quality images and provide more responsive guidance to users. While we made a best effort to maintain backwards compatibility with this new implementation, a few backwards incompatible changes could not be avoided.

Localization strings have been updated​

Implementors who localize or otherwise customize the text should review the updated strings as some strings have changed and some new strings have been added.

Changes to DocumentProcessingState.Success​

DocumentProcessingState.Success now has a new structure, as some of the fields previously returned by the document camera are no longer returned. You can view the new class signature in the references section.

While exact implementation details can vary, in most instances result.image.image can be replaced with result.bytes and result.image.toBitmap() can be replaced with result.previewBitmap.

Increased resolution of output image​

While we have attempted to remain conscientious of bandwidth constraints, to improve pass rates and data extraction, the image output by the camera will be slightly larger (especially on high end devices). An image size of 2-3 mb should be expected on most modern devices. No direct code changes should be needed to account for this.

Changes to internal SmartCapture logic​

The internal logic for how an image is determined to be suitable for capture has undergone significant changes. This not only already leads to better captures, but will also enable quicker iteration for future improvements to the SmartCapture logic. Informational, no direct code changes are needed to account for this.

Removal of Lottie​

In response to some client feedback, this version of the Document Camera no longer uses Lottie for animations. Lottie is still in use in other areas of the SmartCapture SDK and MJCS. Informational, no direct code changes are needed to account for this.

Deprecation of several methods​

Several methods in the SDK have been carried forward for backwards compatibility, but have now been marked as deprecated. All deprecated methods list a replacement within the tooltip. These methods will be maintained for at least a couple versions to come, but may eventually be removed. We encourage implementors to migrate away from deprecated methods ahead of time, but no direct code changes are required for these at this time.