Class MetadataEditor

    Definition

    Namespace:
    Tizen.Multimedia
    Assembly:
    Tizen.Multimedia.Metadata.dll

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

    System.UnauthorizedAccessException

    The caller does not have required privilege to access the file.

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

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

    System.ObjectDisposedException

    The MetadataEditor has already been disposed of.

    View Source

    Artist

    Gets or sets the artist of media.

    Declaration
    public string Artist { get; set; }
    Property Value
    Type Description
    string
    Exceptions
    Type Condition
    System.InvalidOperationException

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

    System.ObjectDisposedException

    The MetadataEditor has already been disposed of.

    View Source

    Author

    Gets or sets the author of media.

    Declaration
    public string Author { get; set; }
    Property Value
    Type Description
    string
    Exceptions
    Type Condition
    System.InvalidOperationException

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

    System.ObjectDisposedException

    The MetadataEditor has already been disposed of.

    View Source

    Comment

    Gets or sets the comment of media.

    Declaration
    public string Comment { get; set; }
    Property Value
    Type Description
    string
    Exceptions
    Type Condition
    System.InvalidOperationException

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

    System.ObjectDisposedException

    The MetadataEditor has already been disposed of.

    View Source

    Conductor

    Gets or sets the conductor of media.

    Declaration
    public string Conductor { get; set; }
    Property Value
    Type Description
    string
    Exceptions
    Type Condition
    System.InvalidOperationException

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

    System.ObjectDisposedException

    The MetadataEditor has already been disposed of.

    View Source

    Copyright

    Gets or sets the copyright of media.

    Declaration
    public string Copyright { get; set; }
    Property Value
    Type Description
    string
    Exceptions
    Type Condition
    System.InvalidOperationException

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

    System.ObjectDisposedException

    The MetadataEditor has already been disposed of.

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

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

    System.ObjectDisposedException

    The MetadataEditor has already been disposed of.

    View Source

    Description

    Gets or sets the description of media.

    Declaration
    public string Description { get; set; }
    Property Value
    Type Description
    string
    Exceptions
    Type Condition
    System.InvalidOperationException

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

    System.ObjectDisposedException

    The MetadataEditor has already been disposed of.

    View Source

    Genre

    Gets or sets the genre of media.

    Declaration
    public string Genre { get; set; }
    Property Value
    Type Description
    string
    Exceptions
    Type Condition
    System.InvalidOperationException

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

    System.ObjectDisposedException

    The MetadataEditor has already been disposed of.

    View Source

    PictureCount

    Gets the count of album arts of media.

    Declaration
    public int PictureCount { get; }
    Property Value
    Type Description
    int
    Exceptions
    Type Condition
    System.ObjectDisposedException

    The MetadataEditor has already been disposed of.

    View Source

    Title

    Gets or sets the title of media.

    Declaration
    public string Title { get; set; }
    Property Value
    Type Description
    string
    Exceptions
    Type Condition
    System.InvalidOperationException

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

    System.ObjectDisposedException

    The MetadataEditor has already been disposed of.

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

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

    System.ObjectDisposedException

    The MetadataEditor has already been disposed of.

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

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

    System.ObjectDisposedException

    The MetadataEditor has already been disposed of.

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

    System.UnauthorizedAccessException

    The caller does not have required privilege to access the file.

    System.ObjectDisposedException

    The MetadataEditor has already been disposed of.

    FileFormatException

    The specified file is not supported.

    View Source

    Commit()

    Writes the modified metadata to the media file.

    Declaration
    public void Commit()
    Exceptions
    Type Condition
    System.InvalidOperationException

    The file is read-only.
    -or-
    Internal error.

    System.ObjectDisposedException

    The MetadataEditor has already been disposed of.

    View Source

    Dispose()

    Releases all resources used by the MetadataEditor object.

    Declaration
    public void Dispose()
    View Source

    Dispose(bool)

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

    View Source

    ~MetadataEditor()

    Finalizes an instance of the MetadataEditor class.

    Declaration
    protected ~MetadataEditor()
    View Source

    GetPicture(int)

    Gets the artwork image in the media file.

    Declaration
    public Artwork GetPicture(int index)
    Parameters
    Type Name Description
    int 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.

    System.ObjectDisposedException

    The MetadataEditor has already been disposed of.

    View Source

    RemovePicture(int)

    Removes the picture from the media file.

    Declaration
    public void RemovePicture(int index)
    Parameters
    Type Name Description
    int 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.

    System.ObjectDisposedException

    The MetadataEditor has already been disposed of.

    Implements

    System.IDisposable
    • View Source
    Back to top Copyright © 2016-2024 Samsung
    Generated by DocFX