Class AnimatedImageView
Definition
- Namespace:
- Tizen.NUI.BaseComponents
- Assembly:
- Tizen.NUI.dll
AnimatedImageView is a class for displaying Animated-GIF and Image-Array
public class AnimatedImageView : ImageView, IDynamicResourceHandler, INameScope, System.IDisposable, IResourcesProvider
- Inheritance
- Implements
-
System.IDisposable
Constructors
View SourceAnimatedImageView()
Construct AnimatedImageView
Declaration
public AnimatedImageView()
Fields
View SourceBatchSizeProperty
BatchSizeProperty
Declaration
public static readonly BindableProperty BatchSizeProperty
Field Value
Type | Description |
---|---|
BindableProperty |
CacheSizeProperty
CacheSizeProperty
Declaration
public static readonly BindableProperty CacheSizeProperty
Field Value
Type | Description |
---|---|
BindableProperty |
CurrentFrameProperty
CurrentFrameProperty
Declaration
public static readonly BindableProperty CurrentFrameProperty
Field Value
Type | Description |
---|---|
BindableProperty |
FrameDelayProperty
FrameDelayProperty
Declaration
public static readonly BindableProperty FrameDelayProperty
Field Value
Type | Description |
---|---|
BindableProperty |
LoopCountProperty
LoopCountProperty
Declaration
public static readonly BindableProperty LoopCountProperty
Field Value
Type | Description |
---|---|
BindableProperty |
StopBehaviorProperty
StopBehaviorProperty
Declaration
public static readonly BindableProperty StopBehaviorProperty
Field Value
Type | Description |
---|---|
BindableProperty |
Properties
View SourceBatchSize
Defines the batch size for pre-loading images in the Image-Array animation. number of images to pre-load before starting to play. Default value: 1.
Declaration
public int BatchSize { get; set; }
Property Value
Type | Description |
---|---|
int |
CacheSize
Defines the cache size for loading images in the Image-Array animation. number of images to keep cached ahead during playback. Default value: 1.
Declaration
public int CacheSize { get; set; }
Property Value
Type | Description |
---|---|
int |
Remarks
cacheSize should be >= batchSize. If it isn't, then the cache will automatically be changed to batchSize. because of the defaults, it is expected that the application developer tune the batch and cache sizes to their particular use case.
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.
FrameDelay
The number of milliseconds between each frame in the Image-Array animation. The number of milliseconds between each frame.
Declaration
public int FrameDelay { get; set; }
Property Value
Type | Description |
---|---|
int |
Remarks
This is only used when URLs(multiple string) are provided.
LoopCount
The number of looping.
Declaration
public int LoopCount { get; set; }
Property Value
Type | Description |
---|---|
int |
StopBehavior
Sets or gets the stop behavior.
Declaration
public AnimatedImageView.StopBehaviorType StopBehavior { get; set; }
Property Value
Type | Description |
---|---|
AnimatedImageView.StopBehaviorType |
TotalFrame
Get the number of total frames
Declaration
public int TotalFrame { get; }
Property Value
Type | Description |
---|---|
int |
URLs
Image URL list for Image-Array
Declaration
public List<string> URLs { get; }
Property Value
Type | Description |
---|---|
List<><string> |
Methods
View SourceDispose(DisposeTypes)
You can override it to clean-up your own resources
Declaration
protected override void Dispose(DisposeTypes type)
Parameters
Type | Name | Description |
---|---|---|
DisposeTypes | type | DisposeTypes |
Overrides
View SourceMergeCachedImageVisualProperty(PropertyMap)
Update NUI cached animated image visual property map by inputed property map. And call base.MergeCachedImageVisualProperty()
Declaration
protected override void MergeCachedImageVisualProperty(PropertyMap map)
Parameters
Type | Name | Description |
---|---|---|
PropertyMap | map |
Overrides
Remarks
For performance issue, we will collect only "cachedAnimatedImagePropertyKeyList" hold in this class.
SetValues()
To make the properies be set. This should be called after the properties are set.
Declaration
public void SetValues()
UpdateImage()
Update animated-image-relative properties synchronously. After call this API, All image properties updated.
Declaration
protected override void UpdateImage()