HeicImage.md

openize.heic.decoder.HeicImage

Heic image class.

Properties

Name	Type	Description	Notes
Header	HeicHeader	Heic image header. Grants convinient access to IsoBmff container meta data.
Frames	Map<Long, HeicImageFrame>	Dictionary of public Heic image frames with access by identifier.
AllFrames	Map<Long, HeicImageFrame>	Dictionary of all Heic image frames with access by identifier.
DefaultFrame	HeicImageFrame	Returns the default image frame, which is specified in meta data.
Width	long	Width of the default image frame in pixels.
Height	long	Height of the default image frame in pixels.

Methods

Name	Type	Description	Parameters	Notes
load	HeicImage	Reads the file meta data and creates a class object for further decoding of the file contents.	IOStream stream - File stream.	This operation does not decode pixels. Use the default frame methods GetByteArray or GetInt32Array afterwards in order to decode pixels.
canLoad	boolean	Checks if the stream can be read as a heic image. Returns true if file header contains heic signarure, false otherwise	IOStream stream - File stream.
getByteArray	byte[]	Get pixel data of the default image frame in the format of byte array. Each three or four bytes (the count depends on the pixel format) refer to one pixel left to right top to bottom line by line. Returns null if frame does not contain image data. In general, it equals to dstArray.	PixelFormat pixelFormat - Pixel format that defines the order of colors and the presence of alpha byte. Rectangle boundsRectangle - Bounds of the requested area. byte[] dstArray - Byte array for storing the pixel values. If it is null or its length is less than necessary the new array will be allocated and returned.
getInt32Array	int[]	Get pixel data of the default image frame in the format of integer array. Each int value refers to one pixel left to right top to bottom line by line. Returns null if frame does not contain image data. In general, it equals to dstArray.	PixelFormat pixelFormat - Pixel format that defines the order of colors. Rectangle boundsRectangle - Bounds of the requested area. int[] dstArray - Integer array for storing the argb values. If it is null or its length is less than necessary the new array will be allocated and returned.

[Back to API_README]