public class

PAGFile

extends PAGComposition

java.lang.Object
↳	org.libpag.PAGLayer
	↳	org.libpag.PAGComposition
		↳	org.libpag.PAGFile

Summary

Nested Classes
interface	PAGFile.LoadListener

[Expand]

Inherited Constants

From class org.libpag.PAGLayer

[Expand]

Inherited Fields

From class org.libpag.PAGLayer

Public Methods
static PAGFile	Load(AssetManager manager, String fileName) Load a pag file from assets, returns null if the file does not exist or the data is not a pag file.
static PAGFile	Load(byte[] bytes)
static PAGFile	Load(String path) Load a pag file from the specified path, returns null if the file does not exist or the data is not a pag file.
static void	LoadAsync(String path, PAGFile.LoadListener listener) Asynchronously load a pag file from the specific path.
static int	MaxSupportedTagLevel() The maximum tag level current SDK supports.
PAGFile	copyOriginal() Make a copy of the original file, any modification to current file has no effect on the result file.
int[]	getEditableIndices(int layerType) Returns the indices of the editable layers in this PAGFile.
PAGLayer[]	getLayersByEditableIndex(int editableIndex, int layerType) Return an array of layers by specified editable index and layer type.
PAGText	getTextData(int index) Get a text data of the specified index.
void	nativeReplaceImage(int editableImageIndex, long image)
void	nativeReplaceImageByName(String layerName, long image)
int	numImages() The number of replaceable images.
int	numTexts() The number of editable texts.
int	numVideos() The number of video compositions.
String	path() The path string of this file, returns empty string if the file is loaded from byte stream.
void	replaceImage(int editableImageIndex, PAGImage image) Replace the image data of the specified index.
void	replaceImageByName(String layerName, PAGImage image) Replace the image data of the specified layer name.
void	replaceText(int editableTextIndex, PAGText textData) Replace the text data of the specified index.
void	setDuration(long duration) Set the duration of this PAGFile.
void	setTimeStretchMode(int value) Set the timeStretchMode of this file.
int	tagLevel() The tag level this pag file requires.
int	timeStretchMode() Indicate how to stretch the original duration to fit target duration when file's duration is changed.

[Expand]

Inherited Methods

From class org.libpag.PAGComposition

static PAGComposition	Make(int width, int height) Make a empty PAGComposition with specified size.
void	addLayer(PAGLayer pagLayer) Add PAGLayer to current PAGComposition at the top.
void	addLayerAt(PAGLayer pagLayer, int index) Add PAGLayer to current PAGComposition at the specified index.
ByteBuffer	audioBytes() The audio data of this composition, which is an AAC audio in an MPEG-4 container.
PAGMarker[]	audioMarkers() Returns the audio markers of this composition.
long	audioStartTime() Indicates when the first frame of the audio plays in the composition's timeline.
boolean	contains(PAGLayer pagLayer) Check whether current PAGComposition contains the specified pagLayer.
PAGLayer	getLayerAt(int index) Returns the child layer that exists at the specified index.
int	getLayerIndex(PAGLayer layer) Returns the index position of a child layer.
PAGLayer[]	getLayersByName(String layerName) Returns an array of layers that match the specified layer name.
PAGLayer[]	getLayersUnderPoint(float localX, float localY) Returns an array of layers that lie under the specified point.
int	height() Returns the height of Composition.
int	numChildren() Returns the number of child layers of this composition.
void	removeAllLayers() Remove all PAGLayers from current PAGComposition.
PAGLayer	removeLayer(PAGLayer pagLayer) Remove the specified PAGLayer from current PAGComposition.
PAGLayer	removeLayerAt(int index) Remove the PAGLayer at specified index from current PAGComposition.
void	setContentSize(int width, int height) Set the size of the Composition.
void	setLayerIndex(PAGLayer layer, int index) Changes the position of an existing child in the container.
void	swapLayer(PAGLayer pagLayer1, PAGLayer pagLayer2) Swap the layers.
void	swapLayerAt(int index1, int index2) Swap the layers at the specified index.
int	width() The width of Composition.

From class org.libpag.PAGLayer

long	currentTime() The current time of the layer in microseconds, the layer is invisible if currentTime is not in the visible range `(startTime <= currentTime < startTime + duration)`.
long	duration() The duration of the layer in microseconds, indicates the length of the visible range.
int	editableIndex() Ranges from 0 to PAGFile.numTexts - 1 if the layer type is text, or from 0 to PAGFile.numImages -1 if the layer type is image, otherwise returns -1.
boolean	equals(Object obj)
boolean	excludedFromTimeline() Indicate whether this layer is excluded from parent's timeline.
void	finalize()
float	frameRate() Returns the frame rate of this layer.
RectF	getBounds() Returns a rectangle in pixels that defines the original area of the layer, which is not transformed by the matrix.
double	getProgress() Returns the current progress of play position, the value is from 0.0 to 1.0.
Matrix	getTotalMatrix() The final matrix for displaying, it is the combination of the matrix property and current matrix from animation.
long	globalToLocalTime(long globalTime) Converts the time from the PAGSurface (global) to the PAGLayer's (local) timeline timeline.
int	hashCode()
String	layerName() Returns the name of the layer.
int	layerType() Returns the type of layer.
long	localTimeToGlobal(long localTime) Converts the time from the PAGLayer's (local) timeline to the PAGSurface (global) timeline.
PAGMarker[]	markers() Returns the markers of this layer.
Matrix	matrix() A matrix object containing values that alter the scaling, rotation, and translation of the layer.
PAGComposition	parent() Indicates the Container instance that contains this Node instance.
void	resetMatrix() Resets the matrix to its default value.
void	setCurrentTime(long time) Set the current time of the layer in microseconds.
void	setExcludedFromTimeline(boolean value) Set the excludedFromTimeline flag of this layer.
void	setMatrix(Matrix matrix) A matrix object containing values that alter the scaling, rotation, and translation of the layer.
void	setProgress(double value) Set the progress of play position, the value ranges from 0.0 to 1.0.
void	setStartTime(long time) Set the start time of the layer, in microseconds.
void	setVisible(boolean value)
long	startTime() The start time of the layer in microseconds, indicates the start position of the visible range.
PAGLayer	trackMatteLayer() Returns trackMatte layer of this layer.
boolean	visible() Whether or not the layer is visible.

From class java.lang.Object

Public Methods

public static PAGFile Load (AssetManager manager, String fileName)

Load a pag file from assets, returns null if the file does not exist or the data is not a pag file. Note: The same path shares resource in memory untill the file is released. If the file may be changed, please use 'Load(byte[])' instead

public static PAGFile Load (byte[] bytes)

public static PAGFile Load (String path)

Load a pag file from the specified path, returns null if the file does not exist or the data is not a pag file. Note: All PAGFiles loaded by the same path share the same internal cache. The internal cache is alive until all PAGFiles are released. Use 'PAGFile.Load(byte[])' instead if you don't want to load a PAGFile from the intenal caches.

public static void LoadAsync (String path, PAGFile.LoadListener listener)

Asynchronously load a pag file from the specific path.

public static int MaxSupportedTagLevel ()

The maximum tag level current SDK supports.

public PAGFile copyOriginal ()

Make a copy of the original file, any modification to current file has no effect on the result file.

public int[] getEditableIndices (int layerType)

Returns the indices of the editable layers in this PAGFile. If the editableIndex of a PAGLayer is not present in the returned indices, the PAGLayer should not be treated as editable.

public PAGLayer[] getLayersByEditableIndex (int editableIndex, int layerType)

Return an array of layers by specified editable index and layer type.

public PAGText getTextData (int index)

Get a text data of the specified index. The index ranges from 0 to numTexts - 1. Note: It always returns the default text data.

public void nativeReplaceImage (int editableImageIndex, long image)

public void nativeReplaceImageByName (String layerName, long image)

public int numImages ()

The number of replaceable images.

public int numTexts ()

The number of editable texts.

public int numVideos ()

The number of video compositions.

public String path ()

The path string of this file, returns empty string if the file is loaded from byte stream.

public void replaceImage (int editableImageIndex, PAGImage image)

Replace the image data of the specified index. The index ranges from 0 to PAGFile.numImages - 1. Passing in null for the image parameter will reset it to default image data.

public void replaceImageByName (String layerName, PAGImage image)

Replace the image data of the specified layer name. Passing in null for the image parameter will reset it to default image data.

public void replaceText (int editableTextIndex, PAGText textData)

Replace the text data of the specified index. The index ranges from 0 to PAGFile.numTexts - 1. Passing in null for the textData parameter will reset it to default text data.

public void setDuration (long duration)

Set the duration of this PAGFile. Passing a value less than or equal to 0 resets the duration to its default value.

public void setTimeStretchMode (int value)

Set the timeStretchMode of this file.

public int tagLevel ()

The tag level this pag file requires.

public int timeStretchMode ()

Indicate how to stretch the original duration to fit target duration when file's duration is changed. The default value is PAGTimeStretchMode::Repeat.

Interfaces

Classes

PAGFile

Summary

Public Methods

public static PAGFile Load (AssetManager manager, String fileName)

public static PAGFile Load (byte[] bytes)

public static PAGFile Load (String path)

public static void LoadAsync (String path, PAGFile.LoadListener listener)

public static int MaxSupportedTagLevel ()

public PAGFile copyOriginal ()

public int[] getEditableIndices (int layerType)

public PAGLayer[] getLayersByEditableIndex (int editableIndex, int layerType)

public PAGText getTextData (int index)

public void nativeReplaceImage (int editableImageIndex, long image)

public void nativeReplaceImageByName (String layerName, long image)

public int numImages ()

public int numTexts ()

public int numVideos ()

public String path ()

public void replaceImage (int editableImageIndex, PAGImage image)

public void replaceImageByName (String layerName, PAGImage image)

public void replaceText (int editableTextIndex, PAGText textData)

public void setDuration (long duration)

public void setTimeStretchMode (int value)

public int tagLevel ()

public int timeStretchMode ()