ImageRef API
Introduction
ImageRef is a lightweight image reference type used throughout the Scanbot SDK to represent image data in a unified and effective manner. Additionally, it acts as a universal interface for images that any component of the SDK captures, processes, or returns.
It enables memory efficient Image processing across the SDK and also makes it cross accessible across the SDKs on supported platforms.
For display, additional processing, or export, the ImageRef can be converted to the specific platform image type.
To ensure proper memory management, ImageRef instances should be used within an autorelease block that handles disposal automatically.
Here are some examples of useful operations when working with ImageRef:
ImageRef creation from different sources
loading...
loading...
ImageRef usage
ImageRef can be used throughout the SDK as an input source for image data. The SDK also uses ImageRef as the output for image crops in scanner results. In general, ImageRef behaves similarly to a bitmap, but it exists in a different memory space and is managed by the SDK.
ImageRef can be used for running scanning operations:
loading...
It is possible to save an image from an ImageRef to a path. If encryption is enabled in the SDK, its parameters will be used to encrypt the file.
loading...
It is also possible to get image size data:
loading...
Want to scan longer than one minute?
Generate a free trial license to test the Scanbot SDK thoroughly.
Get free trial licenseScanbot SDK is part of the Apryse SDK product family
A mobile scan is just the start. With Apryse SDKs, you can expand mobile workflows into full cross‑platform document processing. Whether you need to edit PDFs, add secure digital signatures, or use a fast, customizable document viewer and editor, Apryse gives you the tools to build powerful features quickly.
Learn more
