Document Scanning SDK for Apple iOS  2.5.2
Class Methods | Properties | List of all members
PxMetaImage Class Reference

Bitmap with metadata (image orientation, flash status, etc) More...

#import <PxMetaImage.h>

Inheritance diagram for PxMetaImage:

Class Methods

(PxMetaImage *_Nonnull) + new:
 Creates PxMetaImage from image. Attempts to retrieve metadata information from the image specifed. More...
 
(PxMetaImage *_Nonnull) + new:withMetadata:
 Creates PxMetaImage from image and its associated metadata. More...
 
(PxMetaImage *_Nonnull) + new:withPath:
 Creates PxMetaImage from image and its local file system path. More...
 
(PxMetaImage *_Nonnull) + new:withURL:
 Creates PxMetaImage from image and its URL. More...
 

Properties

UIImage * image
 The underlying UIImage.
 
PxMetaImage_ColorHint colorHint
 Image color hint.
 
PxMetaImage_DevicePlatform devicePlatform
 Image device platform.
 
PxMetaImage_Orientation orientation
 Image orientation.
 
PxMetaImage_FlashStatus flashStatus
 Image flash usage status.
 
unsigned short isoSpeedRatings
 Image ISO speed ratings.
 
BOOL hasStrongShadows
 YES if image has strong shadows.
 
unsigned int pageNumber
 Image page number.
 

Detailed Description

Bitmap with metadata (image orientation, flash status, etc)

@interface PxMetaImage

Method Documentation

◆ new:()

+ (PxMetaImage* _Nonnull) new: (UIImage *_Nullable)  image

Creates PxMetaImage from image. Attempts to retrieve metadata information from the image specifed.

Parameters
imageinput image
Returns
Created object.

◆ new:withMetadata:()

+ (PxMetaImage* _Nonnull) new: (UIImage *_Nonnull)  image
withMetadata: (NSDictionary *_Nonnull)  metadata 

Creates PxMetaImage from image and its associated metadata.

Parameters
imageinput image
metadatadictionary with metadata values
Returns
Created object.

◆ new:withPath:()

+ (PxMetaImage* _Nonnull) new: (UIImage *_Nonnull)  image
withPath: (NSString *_Nonnull)  path 

Creates PxMetaImage from image and its local file system path.

Parameters
imageinput image
pathimage path
Returns
Created object.

◆ new:withURL:()

+ (PxMetaImage* _Nonnull) new: (UIImage *_Nonnull)  image
withURL: (NSString *_Nonnull)  url 

Creates PxMetaImage from image and its URL.

Parameters
imageinput image
urlimage URL
Returns
Created object.