SkiaSharp.Skottie
Represents a Lottie animation that can be loaded, positioned, and rendered to a canvas.
Skottie is a Lottie animation player built on top of the Skia graphics library. Lottie is an animation file format that allows designers to create animations in tools like Adobe After Effects and export them as JSON files for use in applications.
Use the or factory methods to load an animation, then use or to set the animation state, and finally call to draw the current frame.
For more control over the animation loading process, use to obtain an .
The Lottie animation data in JSON format.
Creates an animation from Lottie JSON data.
A new instance, or if the data could not be parsed.
Use the Builder helper for more options and control over the loading process.
A Skia stream containing Lottie animation JSON data.
Creates an animation from a Skia stream containing Lottie JSON data.
A new instance, or if the stream could not be parsed.
Use the Builder helper for more options and control over the loading process.
A .NET stream containing Lottie animation JSON data.
Creates an animation from a .NET stream containing Lottie JSON data.
A new instance, or if the stream could not be parsed.
Use the Builder helper for more options and control over the loading process.
The path to a Lottie animation JSON file.
Creates an animation from a Lottie JSON file.
A new instance, or if the file could not be loaded or parsed.
Use the Builder helper for more options and control over the loading process.
Builder flags to control the loading process.
Creates a new animation builder with the specified flags.
A new instance.
Use the builder for more options and control over the loading process, such as setting a custom font manager or resource provider.
Disposes of the native resources associated with this animation.
Called when the animation is disposed.
Gets the animation duration.
The total duration of the animation.
Gets the animation frame rate.
The animation frame rate in frames per second (FPS).
Gets the animation "in" point.
The animation "in" point (time in frames).
This is the frame number where the animation playback should start. Seek values are clamped to the [, ] range.
Gets the animation "out" point.
The animation "out" point (time in frames).
This is the frame number where the animation playback should end. Seek values are clamped to the [, ] range.
A string containing the Lottie animation JSON.
Parses an animation from a Lottie JSON string.
A new instance, or if the JSON could not be parsed.
Use the Builder helper for more options and control over the loading process.
The canvas to render onto.
The destination rectangle.
Renders the current animation frame to a canvas.
The current frame is determined by the most recent or call. The animation is scaled to fit the destination rectangle while preserving the aspect ratio.
The canvas to render onto.
The destination rectangle.
Render flags that control the rendering behavior.
Renders the current animation frame to a canvas with the specified render flags.
The current frame is determined by the most recent or call. The animation is scaled to fit the destination rectangle while preserving the aspect ratio.
The normalized position in the animation, where 0.0 is the start and 1.0 is the end.
An optional invalidation controller that tracks the regions requiring repaint.
Sets the animation state at a normalized position.
Values are clamped to the [0, 1] interval. When a seek triggers an invalidation, any dirty regions are reported to the optional invalidation controller.
The frame number to seek to.
An optional invalidation controller that tracks the regions requiring repaint.
Sets the animation state at a specific frame number.
The frame number is clamped to the [, ] interval. When a seek triggers an invalidation, any dirty regions are reported to the optional invalidation controller.
The time in seconds to seek to.
An optional invalidation controller that tracks the regions requiring repaint.
Sets the animation state at a specific time position in seconds.
Values are clamped to the animation duration. When a seek triggers an invalidation, any dirty regions are reported to the optional invalidation controller.
The time to seek to.
An optional invalidation controller that tracks the regions requiring repaint.
Sets the animation state at a specific time position.
Values are clamped to the animation duration. When a seek triggers an invalidation, any dirty regions are reported to the optional invalidation controller.
Gets the animation size.
The intrinsic size of the animation.
The Lottie animation data in JSON format.
When this method returns, contains the animation, or if the creation failed.
Attempts to create an animation from Lottie JSON data.
if the animation was created successfully; otherwise, .
Use the Builder helper for more options and control over the loading process.
A Skia stream containing Lottie animation JSON data.
When this method returns, contains the animation, or if the creation failed.
Attempts to create an animation from a Skia stream containing Lottie JSON data.
if the animation was created successfully; otherwise, .
Use the Builder helper for more options and control over the loading process.
A .NET stream containing Lottie animation JSON data.
When this method returns, contains the animation, or if the creation failed.
Attempts to create an animation from a .NET stream containing Lottie JSON data.
if the animation was created successfully; otherwise, .
Use the Builder helper for more options and control over the loading process.
The path to a Lottie animation JSON file.
When this method returns, contains the animation, or if the creation failed.
Attempts to create an animation from a Lottie JSON file.
if the animation was created successfully; otherwise, .
Use the Builder helper for more options and control over the loading process.
A string containing the Lottie animation JSON.
When this method returns, contains the animation, or if the parsing failed.
Attempts to parse an animation from a Lottie JSON string.
if the animation was parsed successfully; otherwise, .
Use the Builder helper for more options and control over the loading process.
Gets the animation Lottie bodymovin version.
The version string from the Lottie JSON file.
Provides a builder pattern for creating animations with custom configuration.
Use the builder to configure custom font managers and resource providers before loading an animation.
Create a builder using .
The Lottie animation data in JSON format.
Builds an animation from Lottie JSON data.
A new instance, or if the data could not be parsed.
A Skia stream containing Lottie animation JSON data.
Builds an animation from a Skia stream containing Lottie JSON data.
A new instance, or if the stream could not be parsed.
A .NET stream containing Lottie animation JSON data.
Builds an animation from a .NET stream containing Lottie JSON data.
A new instance, or if the stream could not be parsed.
The path to a Lottie animation JSON file.
Builds an animation from a Lottie JSON file.
A new instance, or if the file could not be loaded or parsed.
Disposes of the native resources associated with this builder.
Called when the builder is disposed.
The font manager to use for text rendering.
Sets the font manager used for text rendering in the animation.
This builder instance for method chaining.
Use this method to provide custom fonts for animations that contain text layers.
The resource provider to use for loading external assets.
Sets the resource provider used for loading external assets referenced by the animation.
This builder instance for method chaining.
Use this method to provide custom resource loading for animations that reference external files such as images.
Gets the statistics for the most recent animation build operation.
Statistics about the animation parsing and loading process.
Check this property after calling to get timing and size information about the build process.
Specifies flags that control animation builder behavior.
Defer image loading in the animation builder. Images will be loaded on demand instead of at build time.
No flags. Use default behavior.
Prefer fonts embedded in the Lottie JSON file over externally loaded fonts.
Contains statistics about the animation build process.
These statistics are available from after calling one of the build methods.
Gets the total number of animators in the animation scene graph.
The number of animators created during the build process.
The object to compare with the current instance.
Determines whether the specified is equal to the current instance.
if the specified object is equal to the current instance; otherwise, .
The object to compare with the current instance.
Determines whether the specified object is equal to the current instance.
if the specified object is equal to the current instance; otherwise, .
Returns a hash code for this instance.
A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.
Gets the time spent parsing the JSON data.
The duration of the JSON parsing phase.
Gets the size of the JSON data in bytes.
The size of the Lottie JSON data in bytes.
The first value to compare.
The second value to compare.
Determines whether two specified values are equal.
if the values are equal; otherwise, .
The first value to compare.
The second value to compare.
Determines whether two specified values are not equal.
if the values are not equal; otherwise, .
Gets the time spent parsing the scene graph.
The duration of the scene graph construction phase.
Gets the total time spent loading the animation.
The total duration of the animation loading process, including JSON parsing and scene graph construction.
Specifies flags that control animation rendering behavior.
Disable the implicit top-level clipping to the animation bounds.
When rendering into a transparent canvas, skip the implicit layer isolation. This can be used to improve performance when it is known that no animation blend modes or layer effects require isolation.