Package com.microblink.blinkid.image.highres

# Interface HighResImageWrapper

All Superinterfaces:
  `android.os.Parcelable`

public interface HighResImageWrapper extends android.os.Parcelable
Wrapper around `Image` used for high resolution images.

- ## Nested Class Summary

  Nested Classes
  Modifier and Type
  Interface
  Description
  `static final class`
  `HighResImageWrapper.Factory`

  ## Nested classes/interfaces inherited from interface android.os.Parcelable

  `android.os.Parcelable.ClassLoaderCreator<T extends Object>, android.os.Parcelable.Creator<T extends Object>`

- ## Field Summary

  ### Fields inherited from interface android.os.Parcelable

  `CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE`

- ## Method Summary

  Modifier and Type
  Method
  Description
  `void`
  `dispose()`
  Disposes wrapped image.
  `Image`
  `getImage()`
  Returns wrapped image.
  `void`
  `saveToFile(File file)`
  Saves image to given file.

  ### Methods inherited from interface android.os.Parcelable

  `describeContents, writeToParcel`

- ## Method Details

  - ### saveToFile

    void saveToFile(@NonNull File file) throws IOException
    Saves image to given file. Depending on the image format, using this method might be much faster than converting it to bitmap first.
    Parameters:
      `file` - file to save image to
    Throws:
      `IOException` - thrown if writing to file fails

  - ### getImage

    @NonNull Image getImage()
    Returns wrapped image.
    Returns:
      wrapped image

  - ### dispose

    void dispose()
    Disposes wrapped image. You have to call this when you no longer need the image. Disposed images can't be used anymore and will throw an exception.