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.

C#
Copy
public class MetadataEditor : IDisposable
Inheritance
System.Object
MetadataEditor
Implements
System.IDisposable

Constructors

View Source

MetadataEditor(String)

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

Declaration
C#
Copy
public MetadataEditor(string path)
Parameters
Type Name Description
System.String path

The path of the media file to edit the metadata.

Exceptions
Type Condition
System.ArgumentNullException

path is null.

System.ArgumentException

path is a zero-length string, contains only white space.

FileFormatException

The file is not supported.

System.IO.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
C#
Copy
public string Album { get; set; }
Property Value
Type Description
System.String
Exceptions
Type Condition
System.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
C#
Copy
public string Artist { get; set; }
Property Value
Type Description
System.String
Exceptions
Type Condition
System.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
C#
Copy
public string Author { get; set; }
Property Value
Type Description
System.String
Exceptions
Type Condition
System.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
C#
Copy
public string Comment { get; set; }
Property Value
Type Description
System.String
Exceptions
Type Condition
System.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
C#
Copy
public string Conductor { get; set; }
Property Value
Type Description
System.String
Exceptions
Type Condition
System.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

Gets or sets the copyright of media.

Declaration
C#
Copy
public string Copyright { get; set; }
Property Value
Type Description
System.String
Exceptions
Type Condition
System.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
C#
Copy
public string Date { get; set; }
Property Value
Type Description
System.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
System.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
C#
Copy
public string Description { get; set; }
Property Value
Type Description
System.String
Exceptions
Type Condition
System.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
C#
Copy
public string Genre { get; set; }
Property Value
Type Description
System.String
Exceptions
Type Condition
System.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
C#
Copy
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
C#
Copy
public string Title { get; set; }
Property Value
Type Description
System.String
Exceptions
Type Condition
System.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
C#
Copy
public string TrackNumber { get; set; }
Property Value
Type Description
System.String
Exceptions
Type Condition
System.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
C#
Copy
public string UnsyncLyrics { get; set; }
Property Value
Type Description
System.String
Exceptions
Type Condition
System.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
C#
Copy
public void AddPicture(string path)
Parameters
Type Name Description
System.String path

The path of the picture for adding to the metadata.

Exceptions
Type Condition
System.InvalidOperationException

The file is read-only.
-or-
The malformed file which cannot be updatable.
-or-
Internal error.

System.ArgumentNullException

path is null.

System.IO.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
C#
Copy
public void Commit()
Exceptions
Type Condition
System.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
C#
Copy
public void Dispose()
API Level: 3
View Source

Dispose(Boolean)

Releases the resources used by the MetadataEditor object.

Declaration
C#
Copy
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
C#
Copy
protected void Finalize()
View Source

GetPicture(Int32)

Gets the artwork image in the media file.

Declaration
C#
Copy
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
System.InvalidOperationException

An internal error occurs.

System.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
C#
Copy
public void RemovePicture(int index)
Parameters
Type Name Description
Int32 index

The index of the picture to remove.

Exceptions
Type Condition
System.InvalidOperationException

An internal error occurs.
-or-
The media file is read-only.

System.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