Class MetadataExtractor

Definition

Namespace:

Tizen.Multimedia

Assembly:

Tizen.Multimedia.Metadata.dll

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

public class MetadataExtractor : IDisposable

Inheritance

object

MetadataExtractor

Implements

System.IDisposable

Constructors

MetadataExtractor(byte[])

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

Declaration

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.

MetadataExtractor(string)

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

Declaration

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

Dispose()

Releases all resources used by the MetadataExtractor object.

Declaration

public void Dispose()

Dispose(bool)

Releases the resources used by the MetadataExtractor object.

Declaration

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.

~MetadataExtractor()

Finalizes an instance of the MetadataExtractor class.

Declaration

protected ~MetadataExtractor()

GetArtwork()

Gets the artwork image in the source.

Declaration

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.

GetFrameAt(uint, bool)

Gets the frame of a video media.

Declaration

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.

GetMetadata()

Retrieves the Metadata.

Declaration

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.

GetSyncLyrics(int)

Gets the sync lyrics of the source.

Declaration

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.

GetVideoThumbnail()

Gets the frame of a video media.

Declaration

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