com.airbnb.lottie

Class LottieCompositionFactory

java.lang.Object

com.airbnb.lottie.LottieCompositionFactory

public class LottieCompositionFactory
extends java.lang.Object

Helpers to create or cache a LottieComposition.

All factory methods take a cache key. The animation will be stored in an LRU cache for future use. In-progress tasks will also be held so they can be returned for subsequent requests for the same animation prior to the cache being populated.

Method Summary

Modifier and Type	Method and Description
static LottieTask<LottieComposition>	fromAsset(android.content.Context context, java.lang.String fileName) Parse an animation from src/main/assets.
static LottieResult<LottieComposition>	fromAssetSync(android.content.Context context, java.lang.String fileName) Parse an animation from src/main/assets.
static LottieTask<LottieComposition>	fromJson(org.json.JSONObject json, java.lang.String cacheKey) Deprecated.
static LottieTask<LottieComposition>	fromJsonInputStream(java.io.InputStream stream, java.lang.String cacheKey) Auto-closes the stream.
static LottieResult<LottieComposition>	fromJsonInputStreamSync(java.io.InputStream stream, java.lang.String cacheKey) Return a LottieComposition for the given InputStream to json.
static LottieTask<LottieComposition>	fromJsonReader(JsonReader reader, java.lang.String cacheKey)
static LottieResult<LottieComposition>	fromJsonReaderSync(JsonReader reader, java.lang.String cacheKey)
static LottieTask<LottieComposition>	fromJsonString(java.lang.String json, java.lang.String cacheKey)
static LottieResult<LottieComposition>	fromJsonStringSync(java.lang.String json, java.lang.String cacheKey) Return a LottieComposition for the specified raw json string.
static LottieResult<LottieComposition>	fromJsonSync(org.json.JSONObject json, java.lang.String cacheKey) Deprecated.
static LottieTask<LottieComposition>	fromRawRes(android.content.Context context, int rawRes) Parse an animation from raw/res.
static LottieResult<LottieComposition>	fromRawResSync(android.content.Context context, int rawRes) Parse an animation from raw/res.
static LottieTask<LottieComposition>	fromUrl(android.content.Context context, java.lang.String url) Fetch an animation from an http url.
static LottieResult<LottieComposition>	fromUrlSync(android.content.Context context, java.lang.String url) Fetch an animation from an http url.
static LottieTask<LottieComposition>	fromZipStream(java.util.zip.ZipInputStream inputStream, java.lang.String cacheKey)
static LottieResult<LottieComposition>	fromZipStreamSync(java.util.zip.ZipInputStream inputStream, java.lang.String cacheKey) Parses a zip input stream into a Lottie composition.
static void	setMaxCacheSize(int size) Set the maximum number of compositions to keep cached in memory.

Methods inherited from class java.lang.Object

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

Method Detail

setMaxCacheSize

public static void setMaxCacheSize(int size)

Set the maximum number of compositions to keep cached in memory. This must be > 0.

fromUrl

public static LottieTask<LottieComposition> fromUrl(android.content.Context context,
                                                    java.lang.String url)

Fetch an animation from an http url. Once it is downloaded once, Lottie will cache the file to disk for future use. Because of this, you may call `fromUrl` ahead of time to warm the cache if you think you might need an animation in the future.

fromUrlSync

public static LottieResult<LottieComposition> fromUrlSync(android.content.Context context,
                                                          java.lang.String url)

Fetch an animation from an http url. Once it is downloaded once, Lottie will cache the file to disk for future use. Because of this, you may call `fromUrl` ahead of time to warm the cache if you think you might need an animation in the future.

fromAsset

public static LottieTask<LottieComposition> fromAsset(android.content.Context context,
                                                      java.lang.String fileName)

Parse an animation from src/main/assets. It is recommended to use fromRawRes(Context, int) instead. The asset file name will be used as a cache key so future usages won't have to parse the json again. However, if your animation has images, you may package the json and images as a single flattened zip file in assets.

See Also:

fromZipStream(ZipInputStream, String)

fromAssetSync

public static LottieResult<LottieComposition> fromAssetSync(android.content.Context context,
                                                            java.lang.String fileName)

Parse an animation from src/main/assets. It is recommended to use fromRawRes(Context, int) instead. The asset file name will be used as a cache key so future usages won't have to parse the json again. However, if your animation has images, you may package the json and images as a single flattened zip file in assets.

See Also:

fromZipStreamSync(ZipInputStream, String)

fromRawRes

public static LottieTask<LottieComposition> fromRawRes(android.content.Context context,
                                                       int rawRes)

Parse an animation from raw/res. This is recommended over putting your animation in assets because it uses a hard reference to R. The resource id will be used as a cache key so future usages won't parse the json again. Note: to correctly load dark mode (-night) resources, make sure you pass Activity as a context (instead of e.g. the application context). The Activity won't be leaked.

fromRawResSync

public static LottieResult<LottieComposition> fromRawResSync(android.content.Context context,
                                                             int rawRes)

Parse an animation from raw/res. This is recommended over putting your animation in assets because it uses a hard reference to R. The resource id will be used as a cache key so future usages won't parse the json again. Note: to correctly load dark mode (-night) resources, make sure you pass Activity as a context (instead of e.g. the application context). The Activity won't be leaked.

fromJsonInputStream

public static LottieTask<LottieComposition> fromJsonInputStream(java.io.InputStream stream,
                                                                java.lang.String cacheKey)

Auto-closes the stream.

See Also:

fromJsonInputStreamSync(InputStream, String, boolean)

fromJsonInputStreamSync

public static LottieResult<LottieComposition> fromJsonInputStreamSync(java.io.InputStream stream,
                                                                      java.lang.String cacheKey)

Return a LottieComposition for the given InputStream to json.

fromJson

@Deprecated
public static LottieTask<LottieComposition> fromJson(org.json.JSONObject json,
                                                                 java.lang.String cacheKey)

Deprecated.

See Also:

fromJsonSync(JSONObject, String)

fromJsonSync

@Deprecated
public static LottieResult<LottieComposition> fromJsonSync(org.json.JSONObject json,
                                                                       java.lang.String cacheKey)

Deprecated.

Prefer passing in the json string directly. This method just calls `toString()` on your JSONObject. If you are loading this animation from the network, just use the response body string instead of parsing it first for improved performance.

fromJsonString

public static LottieTask<LottieComposition> fromJsonString(java.lang.String json,
                                                           java.lang.String cacheKey)

See Also:

fromJsonStringSync(String, String)

fromJsonStringSync

public static LottieResult<LottieComposition> fromJsonStringSync(java.lang.String json,
                                                                 java.lang.String cacheKey)

Return a LottieComposition for the specified raw json string. If loading from a file, it is preferable to use the InputStream or rawRes version.

fromJsonReader

public static LottieTask<LottieComposition> fromJsonReader(JsonReader reader,
                                                           java.lang.String cacheKey)

fromJsonReaderSync

public static LottieResult<LottieComposition> fromJsonReaderSync(JsonReader reader,
                                                                 java.lang.String cacheKey)

fromZipStream

public static LottieTask<LottieComposition> fromZipStream(java.util.zip.ZipInputStream inputStream,
                                                          java.lang.String cacheKey)

fromZipStreamSync

public static LottieResult<LottieComposition> fromZipStreamSync(java.util.zip.ZipInputStream inputStream,
                                                                java.lang.String cacheKey)

Parses a zip input stream into a Lottie composition. Your zip file should just be a folder with your json file and images zipped together. It will automatically store and configure any images inside the animation if they exist.