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#Copypublic class MetadataEditor : IDisposable
- Inheritance
-
System.ObjectMetadataEditor
- Implements
-
System.IDisposable
Constructors
MetadataEditor(String)
Initializes a new instance of the MetadataEditor class with the specified path.
Declaration
C#Copypublic 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 |
|
System.ArgumentException |
|
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
Declaration
C#Copypublic string Album { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Exceptions
Type | Condition |
---|---|
System.InvalidOperationException | The file is read-only. |
ObjectDisposedException | The MetadataEditor has already been disposed of. |
API Level: 3
Declaration
C#Copypublic string Artist { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Exceptions
Type | Condition |
---|---|
System.InvalidOperationException | The file is read-only. |
ObjectDisposedException | The MetadataEditor has already been disposed of. |
API Level: 3
Declaration
C#Copypublic string Author { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Exceptions
Type | Condition |
---|---|
System.InvalidOperationException | The file is read-only. |
ObjectDisposedException | The MetadataEditor has already been disposed of. |
API Level: 3
Declaration
C#Copypublic string Comment { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Exceptions
Type | Condition |
---|---|
System.InvalidOperationException | The file is read-only. |
ObjectDisposedException | The MetadataEditor has already been disposed of. |
API Level: 3
Declaration
C#Copypublic string Conductor { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Exceptions
Type | Condition |
---|---|
System.InvalidOperationException | The file is read-only. |
ObjectDisposedException | The MetadataEditor has already been disposed of. |
API Level: 3
Declaration
C#Copypublic string Copyright { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Exceptions
Type | Condition |
---|---|
System.InvalidOperationException | The file is read-only. |
ObjectDisposedException | The MetadataEditor has already been disposed of. |
API Level: 3
Declaration
C#Copypublic 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. |
ObjectDisposedException | The MetadataEditor has already been disposed of. |
API Level: 3
Declaration
C#Copypublic string Description { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Exceptions
Type | Condition |
---|---|
System.InvalidOperationException | The file is read-only. |
ObjectDisposedException | The MetadataEditor has already been disposed of. |
API Level: 3
Declaration
C#Copypublic string Genre { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Exceptions
Type | Condition |
---|---|
System.InvalidOperationException | The file is read-only. |
ObjectDisposedException | The MetadataEditor has already been disposed of. |
API Level: 3
Declaration
C#Copypublic int PictureCount { get; }
Property Value
Type | Description |
---|---|
Int32 |
Exceptions
Type | Condition |
---|---|
ObjectDisposedException | The MetadataEditor has already been disposed of. |
API Level: 3
Declaration
C#Copypublic string Title { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Exceptions
Type | Condition |
---|---|
System.InvalidOperationException | The file is read-only. |
ObjectDisposedException | The MetadataEditor has already been disposed of. |
API Level: 3
Declaration
C#Copypublic string TrackNumber { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Exceptions
Type | Condition |
---|---|
System.InvalidOperationException | The file is read-only. |
ObjectDisposedException | The MetadataEditor has already been disposed of. |
API Level: 3
Declaration
C#Copypublic string UnsyncLyrics { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Exceptions
Type | Condition |
---|---|
System.InvalidOperationException | The file is read-only. |
ObjectDisposedException | The MetadataEditor has already been disposed of. |
API Level: 3
Methods
Declaration
C#Copypublic 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. |
System.ArgumentNullException |
|
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
Declaration
C#Copypublic void Commit()
Exceptions
Type | Condition |
---|---|
System.InvalidOperationException | The file is read-only. |
ObjectDisposedException | The MetadataEditor has already been disposed of. |
API Level: 3
Declaration
C#Copypublic void Dispose()
API Level: 3
Declaration
C#Copyprotected 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
Declaration
C#Copyprotected void Finalize()
Declaration
C#Copypublic 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 |
|
ObjectDisposedException | The MetadataEditor has already been disposed of. |
API Level: 3
Declaration
C#Copypublic 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. |
System.ArgumentOutOfRangeException |
|
ObjectDisposedException | The MetadataEditor has already been disposed of. |