com.airbnb.lottie

Class LottieComposition.Factory

java.lang.Object

com.airbnb.lottie.LottieComposition.Factory

Enclosing class:

LottieComposition

public static class LottieComposition.Factory
extends java.lang.Object

Method Summary

Modifier and Type	Method and Description
static Cancellable	fromAssetFileName(android.content.Context context, java.lang.String fileName, OnCompositionLoadedListener listener) Loads a composition from a file stored in /assets.
static LottieComposition	fromFileSync(android.content.Context context, java.lang.String fileName)
static Cancellable	fromInputStream(java.io.InputStream stream, OnCompositionLoadedListener listener) Loads a composition from an arbitrary input stream.
static LottieComposition	fromInputStreamSync(java.io.InputStream stream)
static Cancellable	fromJsonReader(android.util.JsonReader reader, OnCompositionLoadedListener listener) Loads a composition from a json reader.
static Cancellable	fromJsonString(java.lang.String jsonString, OnCompositionLoadedListener listener) Loads a composition from a json string.
static LottieComposition	fromJsonSync(android.util.JsonReader reader)
static Cancellable	fromRawFile(android.content.Context context, int resId, OnCompositionLoadedListener listener) Loads a composition from a file stored in res/raw.

Methods inherited from class java.lang.Object

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

Method Detail

fromAssetFileName

public static Cancellable fromAssetFileName(android.content.Context context,
                                            java.lang.String fileName,
                                            OnCompositionLoadedListener listener)

Loads a composition from a file stored in /assets.

fromRawFile

public static Cancellable fromRawFile(android.content.Context context,
                                      int resId,
                                      OnCompositionLoadedListener listener)

Loads a composition from a file stored in res/raw.

fromInputStream

public static Cancellable fromInputStream(java.io.InputStream stream,
                                          OnCompositionLoadedListener listener)

Loads a composition from an arbitrary input stream.

ex: fromInputStream(context, new FileInputStream(filePath), (composition) -> {});

fromJsonString

public static Cancellable fromJsonString(java.lang.String jsonString,
                                         OnCompositionLoadedListener listener)

Loads a composition from a json string. This is preferable to loading a JSONObject because internally, Lottie uses JsonReader so any original overhead to create the JSONObject is wasted. This is the preferred method to use when loading an animation from the network because you have the response body as a raw string already. No need to convert it to a JSONObject. If you do have a JSONObject, you can call: `new JsonReader(new StringReader(jsonObject));` However, this is not recommended.

fromJsonReader

public static Cancellable fromJsonReader(android.util.JsonReader reader,
                                         OnCompositionLoadedListener listener)

Loads a composition from a json reader.

ex: fromInputStream(context, new FileInputStream(filePath), (composition) -> {});

fromFileSync

public static LottieComposition fromFileSync(android.content.Context context,
                                             java.lang.String fileName)

fromInputStreamSync

public static LottieComposition fromInputStreamSync(java.io.InputStream stream)

fromJsonSync

public static LottieComposition fromJsonSync(android.util.JsonReader reader)
                                      throws java.io.IOException

Throws:

java.io.IOException