Working with ImageRef objects

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 all the SDKs.

For display, additional processing, or export, the ImageRef can be converted to the specific SDK image type.

The following are some examples of useful operations when working with ImageRef:

Creating ImageRef objects

ImageRef objects can be created from various sources, including UIImage, CMSampleBuffer, encoded buffers, URLs, and file paths.

Create ImageRef from UIImage

ImageRef from UIImage

loading...

See full example on GitHub

Create ImageRef from CMSampleBuffer

ImageRef from CMSampleBuffer

loading...

See full example on GitHub

Create ImageRef from an encoded buffer

ImageRef from encoded buffer

loading...

See full example on GitHub

Create ImageRef using URL

ImageRef from URL

loading...

See full example on GitHub

Create ImageRef using a file path

ImageRef from file path

loading...

See full example on GitHub

Saving ImageRef objects

ImageRef objects can be easily saved to disk. You can specify the desired quality and the encryption options.

Save ImageRef using URL

Saving ImageRef objects using URL

loading...

See full example on GitHub

Save ImageRef using file path

Saving ImageRef objects using file path

loading...

See full example on GitHub

Converting ImageRef to UIImage

Converting ImageRef to UIImage

loading...

See full example on GitHub

Retrieving ImageRef metadata

Retrieving ImageRef metadata

loading...

See full example on GitHub

Want to scan longer than one minute?

Generate a free trial license to test the Scanbot SDK thoroughly.

Get free trial license

Scanbot 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

Was this helpful?