Composition
Animation
Top level object, describing the animation
Composition Diagram for Animation
| Attribute | Type | Title | Description |
|---|---|---|---|
nm |
string |
Name |
Human readable name, as seen from editors and the like |
layers |
array of Layer |
Layers |
Layers |
ver |
integer |
Specification Version |
Specification version this Lottie is targeting. This is a 6 digit number with version components encoded as |
fr |
number |
Framerate |
Framerate in frames per second |
ip |
number |
In Point |
Frame the animation starts at (usually 0) |
op |
number |
Out Point |
Frame the animation stops/loops at, which makes this the duration in frames when |
w |
integer |
Width |
Width of the animation |
h |
integer |
Height |
Height of the animation |
assets |
array of Asset |
Assets |
List of assets that can be referenced by layers |
markers |
array of Marker |
Markers |
Markers defining named sections of the composition. |
slots |
object |
Slots |
Dictionary of slot ids that will replace matching properties. |
Versioning Guidelines
The Lottie specification version number uses a semantic versioning system, tools implementing the specification SHOULD consider the following guidelines:
- Major version signal the possibility of breaking changes that are not compatible with previous versions of the specification.
- Minor version updates typically add new functionality but do not contain breaking changes for existing features.
- Patch version updates typically make minor changes or clarifications to already existing functionality.
Authoring Tools
Authoring tools SHOULD specify the latest version of the Lottie Specification. They MAY allow the major version to be configurable to facilitate playback on a wider range of players. Changing the targeted major version MAY also require changes to the produced animation in the case of any breaking changes between major versions.
Animation Players
Players SHOULD determine what major versions they support and handle breaking changes across supported major versions. Players SHOULD be able to handle animations that specify both newer and older versions of the Lottie specification and SHOULD issue a warning if:
- The animation specifies a major version that is not supported.
- The animation specifies a newer minor version.
- No warning needed if the specified patch version is different.
Composition
An object that contains a list of layers
Composition Diagram for Composition
| Attribute | Type | Title | Description |
|---|---|---|---|
layers |
array of Layer |
Layers |
Layers |