AnimatedVisualPlayer Class

Definition

Namespace:

Microsoft.UI.Xaml.Controls

An element that displays and controls an IAnimatedVisual.

This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).

/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
/// [Windows.UI.Xaml.Markup.ContentProperty(Name="Source")]
/// [Windows.Foundation.Metadata.ContractVersion(Microsoft.UI.Xaml.XamlContract, 65536)]
class AnimatedVisualPlayer : FrameworkElement

[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
[Windows.UI.Xaml.Markup.ContentProperty(Name="Source")]
[Windows.Foundation.Metadata.ContractVersion(typeof(Microsoft.UI.Xaml.XamlContract), 65536)]
public class AnimatedVisualPlayer : FrameworkElement

Public Class AnimatedVisualPlayer
Inherits FrameworkElement

Inheritance

FrameworkElement

AnimatedVisualPlayer

Attributes

MarshalingBehaviorAttribute ThreadingAttribute ContentPropertyAttribute ContractVersionAttribute

Examples

Tip

For more info, design guidance, and code examples, see Lottie.

Open the WinUI 2 Gallery app and see the AnimatedVisualPlayer in action.

The WinUI 2 Gallery app includes interactive examples of most WinUI 2 controls, features, and functionality. Get the app from the Microsoft Store or get the source code on GitHub.

Remarks

The AnimatedVisualPlayer hosts and controls playback of an animated Visual tree, integrating custom motion graphic content with XAML UI. For instance, the AnimatedVisualPlayer is used to display and control Lottie animations.

Constructors

AnimatedVisualPlayer()

Initializes a new instance of the AnimatedVisualPlayer class. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).

Properties

AnimationOptimization	Gets or sets a value that specifies how animations are cached when the AnimatedVisualPlayer is idle (when PlayAsync is not active).
AnimationOptimizationProperty	Identifies the AnimationOptimization dependency property.
AutoPlay	Gets or sets a value that indicates whether an animated visual plays immediately when it is loaded. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
AutoPlayProperty	Identifies the AutoPlay dependency property. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
Diagnostics	Gets optional diagnostics information about the last attempt to load an animated visual. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
DiagnosticsProperty	Identifies the Diagnostics dependency property. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
Duration	Gets the duration of the the currently loaded animated visual, or TimeSpan.Zero if no animated visual is loaded. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
DurationProperty	Identifies the Duration dependency property. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
FallbackContent	Gets or sets content to display if an animated visual fails to load. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
FallbackContentProperty	Identifies the FallbackContent dependency property. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
IsAnimatedVisualLoaded	Gets a value that indicates whether an animated visual is loaded. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
IsAnimatedVisualLoadedProperty	Identifies the IsAnimatedVisualLoaded dependency property. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
IsPlaying	Gets a value that indicates whether an animated visual is loaded and a play is underway. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
IsPlayingProperty	Identifies the IsPlaying dependency property. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
PlaybackRate	Gets or sets the rate at which the animation plays. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
PlaybackRateProperty	Identifies the PlaybackRate dependency property. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
ProgressObject	Gets a CompositionObject that is animated along with the progress of the AnimatedVisualPlayer. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
Source	Gets or sets the provider of the animated visual for the player. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
SourceProperty	Identifies the Source dependency property. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
Stretch	Gets or sets a value that describes how an animated visual should be stretched to fill the destination rectangle. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
StretchProperty	Identifies the Stretch dependency property. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).

Methods

Pause()	Pauses the currently playing animated visual, or does nothing if no play is underway. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
PlayAsync(Double, Double, Boolean)	Starts playing the loaded animated visual, or does nothing if no animated visual is loaded. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
Resume()	Resumes the currently paused animated visual, or does nothing if there is no animated visual loaded or the animated visual is not paused. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
SetProgress(Double)	Moves the progress of the animated visual to the given value, or does nothing if no animated visual is loaded. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).
Stop()	Stops the current play, or does nothing if no play is underway. This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).

See also

• Lottie-Windows
• Tutorials with code examples