Class MetadataEditor

Definition

Namespace:: Tizen.Multimedia

Assembly:: Tizen.Multimedia.Metadata.dll

API Level:: 3

Privilege Level:: public

Privilege:: If you want to access only an internal storage, you should add privilege http://tizen.org/privilege/mediastorage. Or if you want to access only an external storage, you should add privilege http://tizen.org/privilege/externalstorage.

Provides a means to edit the metadata of MP3 and MP4 files. Since 6.0, WAV, FLAC, OGG files are supported as well.

public class MetadataEditor : IDisposable

Inheritance: Object

MetadataEditor

Implements: IDisposable

Constructors

View Source

MetadataEditor(String)

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

Declaration

public MetadataEditor(string path)

Parameters

Type	Name	Description
String	path	The path of the media file to edit the metadata.

Exceptions

Type	Condition
ArgumentNullException	`path` is null.
ArgumentException	`path` is a zero-length string, contains only white space.
FileFormatException	The file is not supported.
FileNotFoundException	The file does not exist.
UnauthorizedAccessException	The caller does not have required privilege to access the file.

API Level: 3

Properties

View Source

Album

Gets or sets the album name of media.

Declaration

public string Album { get; set; }

Property Value

Type	Description
String

Exceptions

Type	Condition
InvalidOperationException	The file is read-only. -or- The malformed file which cannot be updatable. -or- Internal error.
ObjectDisposedException	The MetadataEditor has already been disposed of.

API Level: 3

View Source

Artist

Gets or sets the artist of media.

Declaration

public string Artist { get; set; }

Property Value

Type	Description
String

Exceptions

Type	Condition
InvalidOperationException	The file is read-only. -or- The malformed file which cannot be updatable. -or- Internal error.
ObjectDisposedException	The MetadataEditor has already been disposed of.

API Level: 3

View Source

Author

Gets or sets the author of media.

Declaration

public string Author { get; set; }

Property Value

Type	Description
String

Exceptions

Type	Condition
InvalidOperationException	The file is read-only. -or- The malformed file which cannot be updatable. -or- Internal error.
ObjectDisposedException	The MetadataEditor has already been disposed of.

API Level: 3

View Source

Comment

Gets or sets the comment of media.

Declaration

public string Comment { get; set; }

Property Value

Type	Description
String

Exceptions

Type	Condition
InvalidOperationException	The file is read-only. -or- The malformed file which cannot be updatable. -or- Internal error.
ObjectDisposedException	The MetadataEditor has already been disposed of.

API Level: 3

View Source

Conductor

Gets or sets the conductor of media.

Declaration

public string Conductor { get; set; }

Property Value

Type	Description
String

Exceptions

Type	Condition
InvalidOperationException	The file is read-only. -or- The malformed file which cannot be updatable. -or- Internal error.
ObjectDisposedException	The MetadataEditor has already been disposed of.

API Level: 3

View Source

Copyright

Gets or sets the copyright of media.

Declaration

public string Copyright { get; set; }

Property Value

Type	Description
String

Exceptions

Type	Condition
InvalidOperationException	The file is read-only. -or- The malformed file which cannot be updatable. -or- Internal error.
ObjectDisposedException	The MetadataEditor has already been disposed of.

API Level: 3

View Source

Date

Gets or sets the date of media.

Declaration

public string Date { get; set; }

Property Value

Type	Description
String

Remarks

If the media contains the ID3 tag, this refers to the recorded date. If the media is a mp4 format, this refers to the year, and the value to set will be converted into integer.

Exceptions

Type	Condition
InvalidOperationException	The file is read-only. -or- The malformed file which cannot be updatable. -or- Internal error.
ObjectDisposedException	The MetadataEditor has already been disposed of.

API Level: 3

View Source

Description

Gets or sets the description of media.

Declaration

public string Description { get; set; }

Property Value

Type	Description
String

Exceptions

Type	Condition
InvalidOperationException	The file is read-only. -or- The malformed file which cannot be updatable. -or- Internal error.
ObjectDisposedException	The MetadataEditor has already been disposed of.

API Level: 3

View Source

Genre

Gets or sets the genre of media.

Declaration

public string Genre { get; set; }

Property Value

Type	Description
String

Exceptions

Type	Condition
InvalidOperationException	The file is read-only. -or- The malformed file which cannot be updatable. -or- Internal error.
ObjectDisposedException	The MetadataEditor has already been disposed of.

API Level: 3

View Source

PictureCount

Gets the count of album arts of media.

Declaration

public int PictureCount { get; }

Property Value

Type	Description
Int32

Exceptions

Type	Condition
ObjectDisposedException	The MetadataEditor has already been disposed of.

API Level: 3

View Source

Title

Gets or sets the title of media.

Declaration

public string Title { get; set; }

Property Value

Type	Description
String

Exceptions

Type	Condition
InvalidOperationException	The file is read-only. -or- The malformed file which cannot be updatable. -or- Internal error.
ObjectDisposedException	The MetadataEditor has already been disposed of.

API Level: 3

View Source

TrackNumber

Gets or sets the track number of media.

Declaration

public string TrackNumber { get; set; }

Property Value

Type	Description
String

Exceptions

Type	Condition
InvalidOperationException	The file is read-only. -or- The malformed file which cannot be updatable. -or- Internal error.
ObjectDisposedException	The MetadataEditor has already been disposed of.

API Level: 3

View Source

UnsyncLyrics

Gets or sets the unsynchronized lyrics of media.

Declaration

public string UnsyncLyrics { get; set; }

Property Value

Type	Description
String

Exceptions

Type	Condition
InvalidOperationException	The file is read-only. -or- The malformed file which cannot be updatable. -or- Internal error.
ObjectDisposedException	The MetadataEditor has already been disposed of.

API Level: 3

Methods

View Source

AddPicture(String)

Appends the picture to the media file.

Declaration

public void AddPicture(string path)

Parameters

Type	Name	Description
String	path	The path of the picture for adding to the metadata.

Exceptions

Type	Condition
InvalidOperationException	The file is read-only. -or- The malformed file which cannot be updatable. -or- Internal error.
ArgumentNullException	`path` is null.
FileNotFoundException	The file does not exist.
UnauthorizedAccessException	The caller does not have required privilege to access the file.
ObjectDisposedException	The MetadataEditor has already been disposed of.
FileFormatException	The specified file is not supported.

API Level: 3

View Source

Commit()

Writes the modified metadata to the media file.

Declaration

public void Commit()

Exceptions

Type	Condition
InvalidOperationException	The file is read-only. -or- Internal error.
ObjectDisposedException	The MetadataEditor has already been disposed of.

API Level: 3

View Source

Dispose()

Releases all resources used by the MetadataEditor object.

Declaration

public void Dispose()

API Level: 3

View Source

Dispose(Boolean)

Releases the resources used by the MetadataEditor 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 MetadataEditor class.

Declaration

protected void Finalize()

View Source

GetPicture(Int32)

Gets the artwork image in the media file.

Declaration

public Artwork GetPicture(int index)

Parameters

Type	Name	Description
Int32	index	The index of the picture to import.

Returns

Type	Description
Artwork	The artwork included in the media file.

Exceptions

Type	Condition
InvalidOperationException	An internal error occurs.
ArgumentOutOfRangeException	`index` is less than zero. -or- `index` is greater than or equal to PictureCount.
ObjectDisposedException	The MetadataEditor has already been disposed of.

API Level: 3

View Source

RemovePicture(Int32)

Removes the picture from the media file.

Declaration

public void RemovePicture(int index)

Parameters

Type	Name	Description
Int32	index	The index of the picture to remove.

Exceptions

Type	Condition
InvalidOperationException	An internal error occurs. -or- The media file is read-only.
ArgumentOutOfRangeException	`index` is less than zero. -or- `index` is greater than or equal to PictureCount.
ObjectDisposedException	The MetadataEditor has already been disposed of.

API Level: 3

Implements

System.IDisposable