Class MetadataExtractor

Definition

Namespace:: Tizen.Multimedia

Assembly:: Tizen.Multimedia.Metadata.dll

API Level:: 3

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

public class MetadataExtractor : IDisposable

Inheritance: Object

MetadataExtractor

Implements: IDisposable

Constructors

View Source

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
ArgumentNullException	`buffer` is null.
ArgumentException	The length of `buffer` is zero.

API Level: 3

View Source

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
ArgumentNullException	`path` is null.
FileNotFoundException	`path` does not exist.

API Level: 3

Methods

View Source

Dispose()

Releases all resources used by the MetadataExtractor object.

Declaration

public void Dispose()

API Level: 3

View Source

Dispose(Boolean)

Releases the resources used by the MetadataExtractor object.

Declaration

protected virtual void Dispose(bool disposing)

Parameters

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

API Level: 3

View Source

Finalize()

Finalizes an instance of the MetadataExtractor class.

Declaration

protected void Finalize()

View Source

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
InvalidOperationException	An internal process error occurs.
ObjectDisposedException	The MetadataExtractor has been already disposed of.

API Level: 3

View Source

GetFrameAt(UInt32, Boolean)

Gets the frame of a video media.

Declaration

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

Parameters

Type	Name	Description
UInt32	timeStamp	The timestamp in milliseconds.
Boolean	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
InvalidOperationException	An internal error occurs.
ObjectDisposedException	The MetadataExtractor has been already disposed of.

API Level: 3

View Source

GetMetadata()

Retrieves the Metadata.

Declaration

public Metadata GetMetadata()

Returns

Type	Description
Metadata	The Metadata for the given source.

Exceptions

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

API Level: 3

View Source

GetSyncLyrics(Int32)

Gets the sync lyrics of the source.

Declaration

public SyncLyrics GetSyncLyrics(int index)

Parameters

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

Returns

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

Exceptions

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

API Level: 3

View Source

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
InvalidOperationException	An internal process error occurs.
ObjectDisposedException	The MetadataExtractor has been already disposed of.

API Level: 3

Implements

System.IDisposable