Package com.airbnb.lottie

Class LottieComposition

java.lang.Object

com.airbnb.lottie.LottieComposition

public class LottieComposition
extends Object

After Effects/Bodymovin composition model. This is the serialized model from which the animation will be created. It is designed to be stateless, cacheable, and shareable.

To create one, use LottieCompositionFactory.

It can be used with a LottieAnimationView or LottieDrawable.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	LottieComposition.Factory	Deprecated.

Constructor Summary

Constructors

Constructor	Description
LottieComposition()

Method Summary

Modifier and Type	Method	Description
void	addWarning(String warning)
Rect	getBounds()
androidx.collection.SparseArrayCompat<FontCharacter>	getCharacters()
float	getDuration()
float	getDurationFrames()
float	getEndFrame()
Map<String,Font>	getFonts()
float	getFrameForProgress(float progress)
float	getFrameRate()
Map<String,LottieImageAsset>	getImages()	Returns a map of image asset id to LottieImageAsset.
List<Layer>	getLayers()
Marker	getMarker(String markerName)
List<Marker>	getMarkers()
int	getMaskAndMatteCount()	Used to determine if an animation can be drawn with hardware acceleration.
PerformanceTracker	getPerformanceTracker()
List<Layer>	getPrecomps(String id)
float	getProgressForFrame(float frame)
float	getStartFrame()
ArrayList<String>	getWarnings()
boolean	hasDashPattern()	Used to determine if an animation can be drawn with hardware acceleration.
boolean	hasImages()
void	incrementMatteOrMaskCount(int amount)
void	init(Rect bounds, float startFrame, float endFrame, float frameRate, List<Layer> layers, androidx.collection.LongSparseArray<Layer> layerMap, Map<String,List<Layer>> precomps, Map<String,LottieImageAsset> images, androidx.collection.SparseArrayCompat<FontCharacter> characters, Map<String,Font> fonts, List<Marker> markers)
Layer	layerModelForId(long id)
void	setHasDashPattern(boolean hasDashPattern)
void	setPerformanceTrackingEnabled(boolean enabled)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

LottieComposition

public LottieComposition()

Method Detail

init

public void init(Rect bounds,
                 float startFrame,
                 float endFrame,
                 float frameRate,
                 List<Layer> layers,
                 androidx.collection.LongSparseArray<Layer> layerMap,
                 Map<String,List<Layer>> precomps,
                 Map<String,LottieImageAsset> images,
                 androidx.collection.SparseArrayCompat<FontCharacter> characters,
                 Map<String,Font> fonts,
                 List<Marker> markers)

addWarning

public void addWarning(String warning)

setHasDashPattern

public void setHasDashPattern(boolean hasDashPattern)

incrementMatteOrMaskCount

public void incrementMatteOrMaskCount(int amount)

hasDashPattern

public boolean hasDashPattern()

Used to determine if an animation can be drawn with hardware acceleration.

getMaskAndMatteCount

public int getMaskAndMatteCount()

Used to determine if an animation can be drawn with hardware acceleration.

getWarnings

public ArrayList<String> getWarnings()

setPerformanceTrackingEnabled

public void setPerformanceTrackingEnabled(boolean enabled)

getPerformanceTracker

public PerformanceTracker getPerformanceTracker()

layerModelForId

public Layer layerModelForId(long id)

getBounds

public Rect getBounds()

getDuration

public float getDuration()

getStartFrame

public float getStartFrame()

getEndFrame

public float getEndFrame()

getFrameForProgress

public float getFrameForProgress(float progress)

getProgressForFrame

public float getProgressForFrame(float frame)

getFrameRate

public float getFrameRate()

getLayers

public List<Layer> getLayers()

getPrecomps

@Nullable
public List<Layer> getPrecomps(String id)

getCharacters

public androidx.collection.SparseArrayCompat<FontCharacter> getCharacters()

getFonts

public Map<String,Font> getFonts()

getMarkers

public List<Marker> getMarkers()

getMarker

@Nullable
public Marker getMarker(String markerName)

hasImages

public boolean hasImages()

getImages

public Map<String,LottieImageAsset> getImages()

Returns a map of image asset id to LottieImageAsset. These assets contain image metadata exported from After Effects or other design tool. The resulting Bitmaps can be set directly on the image asset so they can be loaded once and reused across compositions.

getDurationFrames

public float getDurationFrames()

toString

@NonNull
public String toString()

Overrides:

toString in class Object