Class ThumbnailExtractor

Definition

Namespace:: Tizen.Multimedia.Util

Assembly:: Tizen.Multimedia.Util.dll

API Level:: 4

Provides the ability to extract the thumbnail from media files.


                C#
                
                    Copy
                    
                
            
public static class ThumbnailExtractor

Inheritance: Object

ThumbnailExtractor

Methods

View Source

ExtractAsync(String)

Extracts the thumbnail for the given media with the specified path.

Declaration


                C#
                
                    Copy
                    
                
            
public static Task<ThumbnailExtractionResult> ExtractAsync(string path)

Parameters

Type	Name	Description
System.String	path	The path of the media file to extract the thumbnail.

Returns

Type	Description
System.Threading.Tasks.Task<ThumbnailExtractionResult>	A task that represents the asynchronous extracting operation.

Remarks

The size of the thumbnail will be the default size (320x240).

Exceptions

Type	Condition
ArgumentNullException	`path` is null.
System.IO.FileNotFoundException	`path` does not exist.
InvalidOperationException	An internal error occurs.
UnauthorizedAccessException	The caller does not have required privilege for accessing the `path`.
FileFormatException	The specified file is not supported.

API Level: 4

View Source

ExtractAsync(String, CancellationToken)

Extracts the thumbnail for the given media with the specified path.

Declaration


                C#
                
                    Copy
                    
                
            
public static Task<ThumbnailExtractionResult> ExtractAsync(string path, CancellationToken cancellationToken)

Parameters

Type	Name	Description
System.String	path	The path of the media file to extract the thumbnail.
System.Threading.CancellationToken	cancellationToken	The token to stop the operation.

Returns

Type	Description
System.Threading.Tasks.Task<ThumbnailExtractionResult>	A task that represents the asynchronous extracting operation.

Remarks

The size of the thumbnail will be the default size(320x240).

Exceptions

Type	Condition
ArgumentNullException	`path` is null.
System.IO.FileNotFoundException	`path` does not exist.
InvalidOperationException	An internal error occurs.
UnauthorizedAccessException	The caller does not have required privilege for accessing the `path`.
FileFormatException	The specified file is not supported.

API Level: 4

View Source

ExtractAsync(String, Size)

Extracts the thumbnail for the given media with the specified path and size.

Declaration


                C#
                
                    Copy
                    
                
            
public static Task<ThumbnailExtractionResult> ExtractAsync(string path, Size size)

Parameters

Type	Name	Description
System.String	path	The path of the media file to extract the thumbnail.
Size	size	The size of the thumbnail.

Returns

Type	Description
System.Threading.Tasks.Task<ThumbnailExtractionResult>	A task that represents the asynchronous extracting operation.

Remarks

If the width is not a multiple of 8, it can be changed by the inner process.
The width will be a multiple of 8 greater than the set value.

Exceptions

Type	Condition
ArgumentNullException	`path` is null.
System.IO.FileNotFoundException	`path` does not exist.
InvalidOperationException	An internal error occurs.
UnauthorizedAccessException	The caller does not have required privilege for accessing the `path`.
ArgumentOutOfRangeException	The width or the height of `size` is less than or equal to zero.
FileFormatException	The specified file is not supported.

API Level: 4

View Source

ExtractAsync(String, Size, CancellationToken)

Extracts the thumbnail for the given media with the specified path and size.

Declaration


                C#
                
                    Copy
                    
                
            
public static Task<ThumbnailExtractionResult> ExtractAsync(string path, Size size, CancellationToken cancellationToken)

Parameters

Type	Name	Description
System.String	path	The path of the media file to extract the thumbnail.
Size	size	The size of the thumbnail.
System.Threading.CancellationToken	cancellationToken	The token to stop the operation.

Returns

Type	Description
System.Threading.Tasks.Task<ThumbnailExtractionResult>	A task that represents the asynchronous extracting operation.

Remarks

If the width is not a multiple of 8, it can be changed by the inner process.
The width will be a multiple of 8 greater than the set value.

Exceptions

Type	Condition
ArgumentNullException	`path` is null.
System.IO.FileNotFoundException	`path` does not exist.
InvalidOperationException	An internal error occurs.
UnauthorizedAccessException	The caller does not have required privilege for accessing the `path`.
ArgumentOutOfRangeException	The width or the height of `size` is less than or equal to zero.
FileFormatException	The specified file is not supported.