DSImageData

The DSImageData class defines the structure of an object that represents an image.

Definition

Assembly: DynamsoftCaptureVisionBundle.xcframework

• Objective-C
• Swift

1. @interface DSImageData : NSObject
   

2. class ImageData : NSObject
   

Attributes & Methods

bytes

The image data content in a byte array.

• Objective-C
• Swift

1. @property (nonatomic, copy) NSData *bytes;
   

2. var bytes: Data? { get set }
   

width

The width of the image in pixels.

• Objective-C
• Swift

1. @property (nonatomic, assign) NSUInteger width
   

2. var width: Int { get set }
   

height

The height of the image in pixels.

• Objective-C
• Swift

1. @property (nonatomic, assign) NSUInteger height
   

2. var height: Int { get set }
   

stride

The stride (or scan width) of the image.

• Objective-C
• Swift

1. @property (nonatomic, assign) NSUInteger stride
   

2. var stride: Int { get set }
   

format

The image pixel format used in the image byte array.

• Objective-C
• Swift

1. @property (nonatomic, assign) DSImagePixelFormat format
   

2. var format: DSImagePixelFormat { get set }
   

orientation

The orientation information of the image. The library is able to read the orientation information from the EXIF data of the image file.

• Objective-C
• Swift

1. @property (nonatomic, assign) NSInteger orientation
   

2. var orientation: Int { get set }
   

tag

The tag of the image.

• Objective-C
• Swift

1. @property (nonatomic, strong, nullable) DSImageTag *tag;
   

2. var tag?: DSImageTag { get set }
   

toUIImage

Transform the DSImageData to a UIImage.

• Objective-C
• Swift

1. - (nullable UIImage *)toUIImage:(NSError *_Nullable *_Nullable)error;
   

2. func toUIImage() throws -> UIImage
   

Parameters

error: An NSError pointer. If an error occurs, it will represent the error information.

Error

Return Value

A UIImage that converted from the DSImageData.

Code Snippet

• Objective-C
• Swift

1. NSError *error;
   UIImage *image = [imageData toUIImage:&error];
   

2. do{
      image = try imageData.toUIImage()
   } catch{
      // Add your code to deal with exceptions.
   }