AnimationMetadata Class

Mutable animation-wide settings of an animated image.

public sealed class AnimationMetadata

Remarks

Animation settings are structural data, not optional metadata: stripping metadata on save never removes them. Per-frame timing is stored in FrameMetadata.Duration.

Constructors

NameDescription
AnimationMetadata()

AnimationMetadata()

public AnimationMetadata()

No documentation is available.

Properties

NameDescription
TotalPlaysGets or sets the total number of times the animation is played, including the first play, or null for an infinite loop. Defaults to null.

Gets or sets the total number of times the animation is played, including the first play, or null for an infinite loop. Defaults to null.

public int? TotalPlays { get; set; }

Property value

int?

Exceptions

ArgumentOutOfRangeException
The value is zero or negative.

Remarks

Codecs translate this value to their own conventions: APNG num_plays stores it directly (0 meaning infinite), while the GIF NETSCAPE2.0 extension stores a number of repetitions after the first play.

Methods

NameDescription
Clone()Creates an independent copy of these settings.

Creates an independent copy of these settings.

public AnimationMetadata Clone()

Returns

AnimationMetadata A new instance with the same values.