JpegExtendedParams Object (IJpegExtendedParams Interface)

JpegExtendedParams object (IJpegExtendedParams interface) in the ABBYY FineReader Engine API — Tuning parameters for saving an image to JPEG, JPEG 2000, and JPEG-compressed TIFF formats via IImage.WriteToFile; persistent object savable to file/memory.

This object provides functionality for tuning the parameters of saving an image to JPEG format (IFF_JpegGrayJfif, IFF_JpegColorJfif, IFF_Jpeg2kGray, IFF_Jpeg2kColor, IFF_TiffGrayJpegJfif and IFF_TiffColorJpegJfif image format types) using the IImage::WriteToFile method. A pointer to this object is passed into the IImage::WriteToFile method as an input parameter, and thus affects the size and quality of the resulting image. All properties of a newly created object of this type are set to reasonable defaults. See the description of particular property for its default value.

The JpegExtendedParams object is a persistent object. This means that the object’s current state can be written to persistent storage. Later, the object can be re-created by reading the object’s state from the persistent storage. The following methods provide persistence of the object:

Linux: SaveToFile, and LoadFromFile

Windows SaveToFile, LoadFromFile, SaveToMemory, and LoadFromMemory.

Properties

Name	Type	Description
Application	Engine, read-only	Returns the Engine object.
Quality	int	Stores the value of the JPEG quality in percent. The default value for this property is 50.

Methods

Name	Description
CopyFrom	Initializes properties of the current object with values of similar properties of another object.
LoadFromFile	Restores the object contents from a file on disk.
LoadFromMemory	Restores the object contents from the global memory. Windows only.
SaveToFile	Saves the object contents into a file on disk.
SaveToMemory	Saves the object contents into the global memory. Windows only.

Output parameter

This object is the output parameter of the CreateJpegExtendedParams method of the Engine object.

Input parameter

This object is passed as an input parameter to the following methods:

• WriteToFile method of the Image object
• CreateMultipageImageWriter method of the Engine object

See also

ImageFileFormatEnum

Working with Images

Working with Properties