Class AnimatedImageView

View Source

Definition

Namespace:
Tizen.NUI.BaseComponents
Assembly:
Tizen.NUI.dll

AnimatedImageView is a class for displaying Animated-GIF and Image-Array


                
C#

                

                    
Copy

                    

                

            
public class AnimatedImageView : ImageView, IDynamicResourceHandler, IElement, INameScope, IElementController, System.IDisposable, IResourcesProvider
Inheritance
Object
BindableObject
Element
BaseHandle
Animatable
Container
View
ImageView
AnimatedImageView
Implements
IDynamicResourceHandler
INameScope
System.IDisposable
IResourcesProvider

Constructors

View Source

AnimatedImageView()

Construct AnimatedImageView

Declaration

                
C#

                

                    
Copy

                    

                

            
public AnimatedImageView()

Fields

View Source

BatchSizeProperty

BatchSizeProperty

Declaration

                
C#

                

                    
Copy

                    

                

            
public static readonly BindableProperty BatchSizeProperty
Field Value
Type Description
BindableProperty
View Source

CacheSizeProperty

CacheSizeProperty

Declaration

                
C#

                

                    
Copy

                    

                

            
public static readonly BindableProperty CacheSizeProperty
Field Value
Type Description
BindableProperty
View Source

CurrentFrameProperty

CurrentFrameProperty

Declaration

                
C#

                

                    
Copy

                    

                

            
public static readonly BindableProperty CurrentFrameProperty
Field Value
Type Description
BindableProperty
View Source

FrameDelayProperty

FrameDelayProperty

Declaration

                
C#

                

                    
Copy

                    

                

            
public static readonly BindableProperty FrameDelayProperty
Field Value
Type Description
BindableProperty
View Source

LoopCountProperty

LoopCountProperty

Declaration

                
C#

                

                    
Copy

                    

                

            
public static readonly BindableProperty LoopCountProperty
Field Value
Type Description
BindableProperty
View Source

StopBehaviorProperty

StopBehaviorProperty

Declaration

                
C#

                

                    
Copy

                    

                

            
public static readonly BindableProperty StopBehaviorProperty
Field Value
Type Description
BindableProperty

Properties

View Source

BatchSize

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

                
C#

                

                    
Copy

                    

                

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

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

                
C#

                

                    
Copy

                    

                

            
public int CacheSize { get; set; }
Property Value
Type Description
Int32
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.

View Source

CurrentFrame

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

Declaration

                
C#

                

                    
Copy

                    

                

            
public int CurrentFrame { get; set; }
Property Value
Type Description
Int32
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. The number of milliseconds between each frame.

Declaration

                
C#

                

                    
Copy

                    

                

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

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

View Source

LoopCount

The number of looping.

Declaration

                
C#

                

                    
Copy

                    

                

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

StopBehavior

Sets or gets the stop behavior.

Declaration

                
C#

                

                    
Copy

                    

                

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

TotalFrame

Get the number of total frames

Declaration

                
C#

                

                    
Copy

                    

                

            
public int TotalFrame { get; }
Property Value
Type Description
Int32
View Source

URLs

Image URL list for Image-Array

Declaration

                
C#

                

                    
Copy

                    

                

            
public List<string> URLs { get; }
Property Value
Type Description
List<String>

Methods

View Source

Dispose(DisposeTypes)

You can override it to clean-up your own resources

Declaration

                
C#

                

                    
Copy

                    

                

            
protected override void Dispose(DisposeTypes type)
Parameters
Type Name Description
DisposeTypes type

DisposeTypes
Overrides
View Source

MergeCachedImageVisualProperty(PropertyMap)

Update NUI cached animated image visual property map by inputed property map. And call base.MergeCachedImageVisualProperty()

Declaration

                
C#

                

                    
Copy

                    

                

            
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.

View Source

SetValues()

To make the properies be set. This should be called after the properties are set.

Declaration

                
C#

                

                    
Copy

                    

                

            
public void SetValues()
View Source

UpdateImage()

Update animated-image-relative properties synchronously. After call this API, All image properties updated.

Declaration

                
C#

                

                    
Copy

                    

                

            
protected override void UpdateImage()
Overrides

Implements

Extension Methods