Class AnimatedImageVisual

Definition

Namespace:
Tizen.NUI.Visuals
Assembly:
Tizen.NUI.dll

The visual which can display and control an animated image resource. We can also set image sequences by using ResourceUrlList and FrameDelay property.

public class AnimatedImageVisual : ImageVisual, IDynamicResourceHandler, INameScope, System.IDisposable
Inheritance
object
BindableObject
Element
BaseHandle
VisualBase
ImageVisual
AnimatedImageVisual
Implements
IDynamicResourceHandler
INameScope
System.IDisposable

Constructors

View Source

AnimatedImageVisual()

Creates an visual object.

Declaration
public AnimatedImageVisual()

Properties

View Source

BatchSize

Gets and Sets the batch size for pre-loading images in the AnimatedImageVisual. (Advanced)

Declaration
public int BatchSize { get; set; }
Property Value
Type Description
int
View Source

CacheSize

Gets and Sets the cache size for loading images in the AnimatedImageVisual. (Advanced)

Declaration
public int CacheSize { get; set; }
Property Value
Type Description
int
View Source

CurrentFrame

Set or get the current frame. When setting a specific frame, it is displayed as a still image.

Declaration
public int CurrentFrame { get; set; }
Property Value
Type Description
int
Remarks

Gets the value set by a user. If the setting value is out-ranged, it is reset as a minimum frame or a maximum frame.

View Source

FrameDelay

The number of milliseconds between each frame in the Image-Array animation.

Declaration
public int FrameDelay { get; set; }
Property Value
Type Description
int
Remarks

This is only used when ResourceUrlList(multiple string) are provided.

View Source

FrameSpeedFactor

Gets and sets the speed factor for the AnimatedImageVisual frame rendering. The default is 1.0f. If the number is less than 1.0f then it will play slower than normal case. If the number is greater than 1.0f then it will play faster than normal case. We will clamp the value between [0.01f 100.0f] internally.

Declaration
public float FrameSpeedFactor { get; set; }
Property Value
Type Description
float
View Source

LoopCount

Gets and sets the number of times the AnimatedImageVisual will be looped. The default is -1. If the number is less than 0 then it loops unlimited,otherwise loop loopCount times.

Declaration
public int LoopCount { get; set; }
Property Value
Type Description
int
View Source

ResourceUrlList

Gets and Sets the url list in the AnimatedImageVisual.

Declaration
public List<string> ResourceUrlList { get; set; }
Property Value
Type Description
List<><string>
Remarks

If we set ResourceUrlList as non-null, ImageVisual.ResourceUrl will be ignored.

View Source

StopBehavior

Sets or gets the stop behavior.

Declaration
public AnimatedImageView.StopBehaviorType StopBehavior { get; set; }
Property Value
Type Description
AnimatedImageView.StopBehaviorType
View Source

TotalFrame

Get the number of total frames. Or -1 if image is invalid, or not loaded yet.

Declaration
public int TotalFrame { get; }
Property Value
Type Description
int

Methods

View Source

Pause()

Pause the animated image.

Declaration
public void Pause()
View Source

Play()

Play the animated image.

Declaration
public void Play()
View Source

Stop()

Stop the animated image.

Declaration
public void Stop()

Implements

System.IDisposable

Extension Methods