Class MetadataExtractor

Definition

Namespace:: Tizen.Multimedia

Assembly:: Tizen.Multimedia.Metadata.dll

Provides a means to get the metadata from a media file.


                C#
                
                    Copy
                    
                
            
public class MetadataExtractor : IDisposable

Inheritance: object

MetadataExtractor

Implements: System.IDisposable

Constructors

View Source

MetadataExtractor(byte[])

Initializes a new instance of the MetadataExtractor class with the specified buffer.

Declaration


                C#
                
                    Copy
                    
                
            
public MetadataExtractor(byte[] buffer)

Parameters

Type	Name	Description
byte[]	buffer	The buffer to extract the metadata.

Exceptions

Type	Condition
System.ArgumentNullException	`buffer` is null.
System.ArgumentException	The length of `buffer` is zero.

View Source

MetadataExtractor(string)

Initializes a new instance of the MetadataExtractor class with the specified path.

Declaration


                C#
                
                    Copy
                    
                
            
public MetadataExtractor(string path)

Parameters

Type	Name	Description
string	path	The path for the file to extract the metadata.

Exceptions

Type	Condition
System.ArgumentNullException	`path` is null.
System.IO.FileNotFoundException	`path` does not exist.

Methods

View Source

Dispose()

Releases all resources used by the MetadataExtractor object.

Declaration


                C#
                
                    Copy
                    
                
            
public void Dispose()

View Source

Dispose(bool)

Releases the resources used by the MetadataExtractor object.

Declaration


                C#
                
                    Copy
                    
                
            
protected virtual void Dispose(bool disposing)

Parameters

Type	Name	Description
bool	disposing	true to release both managed and unmanaged resources; false to release only unmanaged resources.

View Source

~MetadataExtractor()

Finalizes an instance of the MetadataExtractor class.

Declaration


                C#
                
                    Copy
                    
                
            
protected ~MetadataExtractor()

View Source

GetArtwork()

Gets the artwork image in the source.

Declaration


                C#
                
                    Copy
                    
                
            
public Artwork GetArtwork()

Returns

Type	Description
Artwork	The Artwork if it exists, otherwise null.

Exceptions

Type	Condition
System.InvalidOperationException	An internal process error occurs.
System.ObjectDisposedException	The MetadataExtractor has been already disposed of.

View Source

GetFrameAt(uint, bool)

Gets the frame of a video media.

Declaration


                C#
                
                    Copy
                    
                
            
public byte[] GetFrameAt(uint timeStamp, bool accurate)

Parameters

Type	Name	Description
uint	timeStamp	The timestamp in milliseconds.
bool	accurate	true to get an accurate frame for the given timestamp, otherwise false to get the nearest i-frame of the video rapidly.

Returns

Type	Description
byte[]	The raw frame data in RGB888 if a frame at specified time exists, otherwise null.

Exceptions

Type	Condition
System.InvalidOperationException	An internal error occurs.
System.ObjectDisposedException	The MetadataExtractor has been already disposed of.

View Source

GetMetadata()

Retrieves the Metadata.

Declaration


                C#
                
                    Copy
                    
                
            
public Metadata GetMetadata()

Returns

Type	Description
Metadata	The Metadata for the given source.

Exceptions

Type	Condition
System.InvalidOperationException	An internal process error occurs.
System.ObjectDisposedException	The MetadataExtractor has been already disposed of.

View Source

GetSyncLyrics(int)

Gets the sync lyrics of the source.

Declaration


                C#
                
                    Copy
                    
                
            
public SyncLyrics GetSyncLyrics(int index)

Parameters

Type	Name	Description
int	index	The index of lyrics to retrieve.

Returns

Type	Description
SyncLyrics	The SyncLyrics object if `index` is valid, otherwise null.

Exceptions

Type	Condition
System.InvalidOperationException	An internal process error occurs.
System.ObjectDisposedException	The MetadataExtractor has been already disposed of.

View Source

GetVideoThumbnail()

Gets the frame of a video media.

Declaration


                C#
                
                    Copy
                    
                
            
public byte[] GetVideoThumbnail()

Returns

Type	Description
byte[]	The raw thumbnail data in RGB888 if it exists, otherwise null.

Exceptions

Type	Condition
System.InvalidOperationException	An internal process error occurs.
System.ObjectDisposedException	The MetadataExtractor has been already disposed of.

Implements

System.IDisposable