com.aspose.imaging.fileformats.apng

Class ApngImage

java.lang.Object

com.aspose.imaging.DisposableObject

com.aspose.imaging.DataStreamSupporter

com.aspose.imaging.Image

com.aspose.imaging.RasterImage

com.aspose.imaging.RasterCachedImage

com.aspose.imaging.RasterCachedMultipageImage

com.aspose.imaging.fileformats.apng.ApngImage

All Implemented Interfaces:

IHasExifData, IHasMetadata, IMetadataContainer, IMultipageImage, IMultipageImageExt, IObjectWithBounds, IRasterImageArgb32PixelLoader, IRasterImageRawDataLoader, IHasXmpData, com.aspose.internal.IPixelsSaver, com.aspose.internal.progressmanagement.IProgressEventHandler, com.aspose.internal.progressmanagement.IProgressInformer, com.aspose.ms.System.IDisposable, Closeable, AutoCloseable

public final class ApngImage
extends RasterCachedMultipageImage
implements IMultipageImageExt

The API for Animated PNG (Animated Portable Network Graphics) image file format is a versatile solution for developers looking to integrate animated content into their applications. This API offers extensive control over frame settings, allowing users to define frame-specific parameters, including loop duration and PNG file settings. With this feature-rich tool, you can effortlessly manage and optimize the display of APNG images, import and export images, enhancing the dynamic and interactive aspects of your applications.

Code example:

The following example shows how to export to APNG file format.

import com.aspose.imaging;
import com.aspose.imaging.imageoptions;

try (Image image = Image.load("Animation1.webp"))
{
    // Export to APNG animation with unlimited animation cycles as default
    image.save("Animation1.webp.png", new ApngOptions());
    // Setting up animation cycles
    ApngOptions options = new ApngOptions();
    options.setNumPlays(5);
    image.save("Animation2.webp.png", options); // 5 cycles
}

Constructor Summary

Constructors

Constructor and Description
ApngImage(ApngOptions options, int width, int height) Begin working with the ApngImage class by initializing a new instance effortlessly.

Method Summary

Modifier and Type	Method and Description
ApngFrame	addFrame() /**
void	addFrame(RasterImage frameImage) Effortlessly expand your frame collection by adding a new frame to the end with this intuitive method.
void	addFrame(RasterImage frameImage, long frameTime) Expand your frame collection seamlessly by appending a new frame to the with this intuitive method.
void	addPage(RasterImage page) Add a new page to the image effortlessly with this intuitive method.
long	getDefaultFrameTime() Easily adjust the default frame duration for creating new frames with this flexible property.
ImageOptionsBase	getDefaultOptions(Object[] args) Retrieve the default options effortlessly with this straightforward method.
long	getFileFormat() Quickly access information about the file format with this convenient property.
boolean	getInterlaced() Quickly determine whether this PngImage object is interlaced with this convenient property.
Date	getModifyDate(boolean useDefault) Quickly obtain the date and time when the resource image was last modified with this user-friendly method.
int	getNumPlays() Effortlessly control the number of times your animation loops with this versatile property.
ImageOptionsBase	getOriginalOptions() Retrieve options based on the original file settings effortlessly with this intuitive method.
int	getPageCount() Retrieve the total number of pages in your image file effortlessly with this property.
Image[]	getPages() Effortlessly access the pages of your image with this convenient property.
ApngFrame	insertFrame(int index) Effortlessly insert a new frame into your frame collection at the specified with this intuitive method.
void	insertFrame(int index, RasterImage frameImage) Inserts new frame into the own frame collection at the specified index.
void	insertFrame(int index, RasterImage frameImage, long frameTime) Inserts new frame into the own frame collection at the specified index.
ApngFrame	popFrameAt(int index) Remove and retrieve the frame at the specified index from your frame collection with this intuitive method.
void	removeAllFrames() Clear your frame collection by removing all frames with this intuitive method.
void	removeFrameAt(int index) Remove the frame at the specified index from your frame collection seamlessly with this method.
void	resetDefaultImage() Remove a previously set default image with this intuitive method.
void	setDefaultFrameTime(long value) Easily adjust the default frame duration for creating new frames with this flexible property.
void	setDefaultImage(RasterImage image) Set the specified raster image as the default image for the current animation effortlessly with this method.
void	setNumPlays(int value) Effortlessly control the number of times your animation loops with this versatile property.

Methods inherited from class com.aspose.imaging.RasterCachedMultipageImage

adjustBrightness, adjustContrast, adjustGamma, adjustGamma, analyzePercentageDigitalSignature, binarizeBradley, binarizeBradley, binarizeFixed, binarizeOtsu, blend, cacheData, crop, crop, dither, embedDigitalSignature, filter, getBackgroundColor, getBitsPerPixel, getHeight, getImageOpacity, getMetadata, getPageExportingAction, getWidth, grayscale, hasAlpha, hasTransparentColor, isCached, isDigitalSigned, normalizeAngle, normalizeHistogram, replaceColor, replaceNonTransparentColors, resize, resize, resizeHeightProportionally, resizeWidthProportionally, rotate, rotateFlip, rotateFlipAll, setBackgroundColor, setPageExportingAction

Methods inherited from class com.aspose.imaging.RasterCachedImage

autoBrightnessContrast

Methods inherited from class com.aspose.imaging.RasterImage

autoRotate, blend, blend, blend, dither, getArgb32Pixel, getDefaultArgb32Pixels, getDefaultPixels, getDefaultRawData, getDefaultRawData, getHorizontalResolution, getPixel, getPremultiplyComponents, getRawCustomColorConverter, getRawDataFormat, getRawDataSettings, getRawFallbackIndex, getRawIndexedColorConverter, getRawLineSize, getSkewAngle, getTransparentColor, getUpdateXmpData, getUseRawData, getVerticalResolution, isDigitalSigned, isRawDataAvailable, isUsePalette, loadArgb32Pixels, loadArgb64Pixels, loadCmyk32Pixels, loadCmykPixels, loadPartialArgb32Pixels, loadPartialArgb64Pixels, loadPartialPixels, loadPixels, loadRawData, loadRawData, normalizeAngle, readArgb32ScanLine, readScanLine, removeMetadata, replaceColor, replaceNonTransparentColors, rotate, saveArgb32Pixels, saveCmyk32Pixels, saveCmykPixels, savePixels, saveRawData, setArgb32Pixel, setHorizontalResolution, setPalette, setPixel, setPremultiplyComponents, setRawCustomColorConverter, setRawFallbackIndex, setRawIndexedColorConverter, setResolution, setTransparentColor, setTransparentColor, setUpdateXmpData, setUseRawData, setVerticalResolution, toBitmap, writeArgb32ScanLine, writeScanLine

Methods inherited from class com.aspose.imaging.Image

canLoad, canLoad, canLoad, canLoad, canSave, create, create, create, create, create, create, create, getBounds, getBufferSizeHint, getContainer, getExifData, getFileFormat, getFileFormat, getFittingRectangle, getFittingRectangle, getInterruptMonitor, getIProgressEventHandler, getPalette, getProgressEventHandlerInfo, getProportionalHeight, getProportionalWidth, getSerializedStream, getSize, getXmpData, hasBackgroundColor, isAutoAdjustPalette, load, load, load, load, load, load, resize, resizeHeightProportionally, resizeHeightProportionally, resizeWidthProportionally, resizeWidthProportionally, save, save, save, save, save, save, save, save, setAutoAdjustPalette, setBackgroundColor, setBufferSizeHint, setExifData, setInterruptMonitor, setPalette, setXmpData, trySetMetadata

Methods inherited from class com.aspose.imaging.DataStreamSupporter

getDataStreamContainer, save, save, save

Methods inherited from class com.aspose.imaging.DisposableObject

close, dispose, getDisposed

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.aspose.imaging.IMultipageImage

getPageExportingAction, setPageExportingAction

Methods inherited from interface com.aspose.imaging.xmp.IHasXmpData

getXmpData, setXmpData

Constructor Detail

ApngImage

public ApngImage(ApngOptions options,
                 int width,
                 int height)

Begin working with the ApngImage class by initializing a new instance effortlessly. Perfect for developers seeking to start using ApngImage objects quickly and efficiently in their projects.

Parameters:

options - The options.

width - The width.

height - The height.

Method Detail

getFileFormat

public long getFileFormat()

Quickly access information about the file format with this convenient property. Ideal for developers who need to retrieve details about the format of their Apng files easily.

Overrides:

getFileFormat in class Image

See Also:

FileFormat

getPageCount

public int getPageCount()

Retrieve the total number of pages in your image file effortlessly with this property. Ideal for developers needing quick access to page count information.

Value: The page count.

Specified by:

getPageCount in interface IMultipageImage

Returns:

the page count.

getPages

public Image[] getPages()

Effortlessly access the pages of your image with this convenient property. Perfect for developers seeking quick and easy access to individual pages for manipulation.

Value: The pages.

Specified by:

getPages in interface IMultipageImage

Returns:

the pages.

getNumPlays

public int getNumPlays()

Effortlessly control the number of times your animation loops with this versatile property. Perfect for developers seeking precise control over animation behavior, with support for infinite looping in case of the value equals to 0.

Value: The number of times to loop.

setNumPlays

public void setNumPlays(int value)

Effortlessly control the number of times your animation loops with this versatile property. Perfect for developers seeking precise control over animation behavior, with support for infinite looping in case of the value equals to 0.

Value: The number of times to loop.

getDefaultFrameTime

public long getDefaultFrameTime()

Easily adjust the default frame duration for creating new frames with this flexible property. Perfect for developers seeking to customize frame timing efficiently in their animations.

Value: The default frame duration, in milliseconds.

setDefaultFrameTime

public void setDefaultFrameTime(long value)

Easily adjust the default frame duration for creating new frames with this flexible property. Perfect for developers seeking to customize frame timing efficiently in their animations.

Value: The default frame duration, in milliseconds.

getInterlaced

public boolean getInterlaced()

Quickly determine whether this PngImage object is interlaced with this convenient property. Ideal for developers needing to check the interlacing status of PNG images easily.

Value: true if interlaced; otherwise, false.

getOriginalOptions

public ImageOptionsBase getOriginalOptions()

Retrieve options based on the original file settings effortlessly with this intuitive method. Perfect for developers seeking to access and utilize settings that align with the characteristics of the original file. This can be helpful to keep bit-depth and other parameters of the original image unchanged. For example, if we load a black-white PNG image with 1 bit per pixel and then save it using the DataStreamSupporter.save(String) method, the output PNG image with 8-bit per pixel will be produced. To avoid it and save PNG image with 1-bit per pixel, use this method to get corresponding saving options and pass them to the Image.save(String, ImageOptionsBase) method as the second parameter.

Overrides:

getOriginalOptions in class Image

Returns:

The options based on the original file settings.

getDefaultOptions

public ImageOptionsBase getDefaultOptions(Object[] args)

Retrieve the default options effortlessly with this straightforward method. Ideal for developers seeking quick access to default Apng image settings.

Overrides:

getDefaultOptions in class Image

Parameters:

args - The arguments.

Returns:

Default options

getModifyDate

public Date getModifyDate(boolean useDefault)

Quickly obtain the date and time when the resource image was last modified with this user-friendly method. Ideal for developers needing to track changes and manage resources effectively.

Overrides:

getModifyDate in class RasterImage

Parameters:

useDefault - if set to true uses the information from FileInfo as default value.

Returns:

The date and time the resource image was last modified.

addPage

public void addPage(RasterImage page)

Add a new page to the image effortlessly with this intuitive method. Perfect for developers seeking to expand the content of their image files dynamically.

Specified by:

addPage in interface IMultipageImageExt

Parameters:

page - The page to add.

Throws:

com.aspose.ms.System.ArgumentNullException - page is null.

addFrame

public ApngFrame addFrame()

/**

Easily append a new frame to the end of your frame collection with this straightforward method. Ideal for developers looking to expand their frame collection dynamically for animations with multi-frame images. A new frame will be created according to the size of the current image.

Returns:

The newly created APNG frame.

addFrame

public void addFrame(RasterImage frameImage)

Effortlessly expand your frame collection by adding a new frame to the end with this intuitive method. Perfect for developers seeking to enhance their animations of multi-frame images dynamically. The contents of the new frame will be filled from the specified image.

Parameters:

frameImage - The frame image.

Throws:

com.aspose.ms.System.ArgumentNullException - frameImage is null.

addFrame

public void addFrame(RasterImage frameImage,
                     long frameTime)

Expand your frame collection seamlessly by appending a new frame to the with this intuitive method. Ideal for developers looking to enrich their animations of multi-frame images. The contents of the new frame will be filled from the specified image.

Parameters:

frameImage - The frame image.

frameTime - The frame duration, in milliseconds.

Throws:

com.aspose.ms.System.ArgumentNullException - frameImage is null.

insertFrame

public ApngFrame insertFrame(int index)

Effortlessly insert a new frame into your frame collection at the specified with this intuitive method. Ideal for developers seeking precise control over the arrangement of frames in their animations of multi-frame images. A new frame will be created according to the size of the current image.

Parameters:

index - The index.

Returns:

The newly created APNG frame.

Throws:

com.aspose.ms.System.ArgumentOutOfRangeException - index is less than 0. or index is greater than PageCount(IMultipageImage.getPageCount()).

insertFrame

public void insertFrame(int index,
                        RasterImage frameImage)

Inserts new frame into the own frame collection at the specified index. The contents of the new frame will be filled from the specified image.

Parameters:

index - The index.

frameImage - The frame image.

Throws:

com.aspose.ms.System.ArgumentOutOfRangeException - index is less than 0. or index is greater than PageCount(IMultipageImage.getPageCount()).

com.aspose.ms.System.ArgumentNullException - frameImage is null.

insertFrame

public void insertFrame(int index,
                        RasterImage frameImage,
                        long frameTime)

Inserts new frame into the own frame collection at the specified index. The contents of the new frame will be filled from the specified image.

Parameters:

index - The index.

frameImage - The frame image.

frameTime - The frame duration, in milliseconds.

Throws:

com.aspose.ms.System.ArgumentOutOfRangeException - index is less than 0. or index is greater than PageCount(IMultipageImage.getPageCount()).

com.aspose.ms.System.ArgumentNullException - frameImage is null.

popFrameAt

public ApngFrame popFrameAt(int index)

Remove and retrieve the frame at the specified index from your frame collection with this intuitive method. Perfect for developers seeking efficient management of frames in their animations.

Parameters:

index - The index.

Returns:

The removed APNG frame.

Throws:

com.aspose.ms.System.ArgumentOutOfRangeException - index is less than 0. or index is equal to or greater than PageCount(IMultipageImage.getPageCount()).

removeFrameAt

public void removeFrameAt(int index)

Remove the frame at the specified index from your frame collection seamlessly with this method. Perfect for developers seeking streamlined management of frames in their multi-frame images. The frame to be deleted will be disposed.

Parameters:

index - The index.

Throws:

com.aspose.ms.System.ArgumentOutOfRangeException - index is less than 0. or index is equal to or greater than PageCount(IMultipageImage.getPageCount()).

removeAllFrames

public void removeAllFrames()

Clear your frame collection by removing all frames with this intuitive method. Ideal for developers seeking to reset or refresh their animations.

setDefaultImage

public void setDefaultImage(RasterImage image)

Set the specified raster image as the default image for the current animation effortlessly with this method. Perfect for developers seeking to customize the default image in their animations.

Parameters:

image - The image.

Throws:

com.aspose.ms.System.ArgumentNullException - image is null.

resetDefaultImage

public void resetDefaultImage()

Remove a previously set default image with this intuitive method. Ideal for developers seeking to reset or clear the default image in their animation. After this, the default image is the first frame in the own frame collection (it cannot be deleted using this method).