Logo Search packages:      
Sourcecode: f-spot version File versions  Download package

TagLib::Id3v2::Tag Class Reference

Inheritance diagram for TagLib::Id3v2::Tag:

TagLib::Tag

List of all members.


Detailed Description

This class extends TagLib.Tag and implements T:System.Collections.Generic.IEnumerable`1 to provide support for reading and writing ID3v2 tags.

Definition at line 42 of file Tag.cs.


Public Member Functions

void AddFrame (Frame frame)
 Adds a frame to the current instance.
abstract void Clear ()
 Clears the values stored in the current instance.
virtual void CopyTo (Tag target, bool overwrite)
 Copies the values from the current instance to another TagLib.Tag, optionally overwriting existing values.
IEnumerator< FrameGetEnumerator ()
 Gets an enumerator for enumerating through the frames.
IEnumerable< FrameGetFrames (ByteVector ident)
 Gets all frames with a specified identifier contained in the current instance.
IEnumerable< FrameGetFrames ()
 Gets all frames contained in the current instance.
IEnumerable< TGetFrames< T > (ByteVector ident)
 Gets all frames with a of type T with a specified identifier contained in the current instance.
IEnumerable< TGetFrames< T > ()
 Gets all frames with of a specified type contained in the current instance.
void RemoveFrame (Frame frame)
 Removes a specified frame from the current instance.
void RemoveFrames (ByteVector ident)
 Removes all frames with a specified identifier from the current instance.
ByteVector Render ()
 Renders the current instance as a raw ID3v2 tag.
void ReplaceFrame (Frame oldFrame, Frame newFrame)
 Replaces an existing frame with a new one in the list contained in the current instance, or adds a new one if the existing one is not contained.
void SetNumberFrame (ByteVector ident, uint number, uint count)
 Sets the numeric values for a specified Text Information Frame.
void SetTextFrame (ByteVector ident, StringCollection text)
 Sets the text for a specified Text Information Frame.
void SetTextFrame (ByteVector ident, params string[] text)
 Sets the text for a specified Text Information Frame.
 Tag (ByteVector data)
 Constructs and initializes a new instance of Tag by reading the contents from a specified ByteVector object.
 Tag (File file, long position)
 Constructs and initializes a new instance of Tag by reading the contents from a specified position in a specified file.
 Tag ()
 Constructs and initializes a new instance of Tag with no contents.

Static Public Member Functions

static void Duplicate (Tag source, Tag target, bool overwrite)
 Copies all standard values from one tag to another, optionally overwriting existing values.

Protected Member Functions

void Parse (ByteVector data)
 Populates the current instance by parsing the contents of a raw ID3v2 tag, minus the header.
void Read (File file, long position)
 Populates the current instance be reading in a tag from a specified position in a specified file.

Properties

override string Album [get, set]
 Gets and sets the album of the media represented by the current instance.
override string[] AlbumArtists [get, set]
 Gets and sets the band or artist who is credited in the creation of the entire album or collection containing the media described by the current instance.
override string[] AlbumArtistsSort [get, set]
 Gets and sets the sort names of the band or artist who is credited in the creation of the entire album or collection containing the media described by the current instance.
override string AlbumSort [get, set]
 Gets and sets the sort names of the Album title of the media represented by the current instance.
virtual string AmazonId [get, set]
 Gets and sets the Amazon ID of the media represented by the current instance.
virtual string[] Artists [get, set]
 Gets and sets the same value as Performers.
override uint BeatsPerMinute [get, set]
 Gets and sets the number of beats per minute in the audio of the media represented by the current instance.
override string Comment [get, set]
 Gets and sets a user comment on the media represented by the current instance.
override string[] Composers [get, set]
 Gets and sets the composers of the media represented by the current instance.
override string[] ComposersSort [get, set]
 Gets and sets the sort names of the composers of the media represented by the current instance.
override string Conductor [get, set]
 Gets and sets the conductor or director of the media represented by the current instance.
override string Copyright [get, set]
 Gets and sets the copyright information for the media represented by the current instance.
static StringType DefaultEncoding [get, set]
 Gets and sets the encoding to use when creating new frames.
static byte DefaultVersion [get, set]
 Gets and sets the the default version to use when creating new tags.
override uint Disc [get, set]
 Gets and sets the number of the disc containing the media represented by the current instance in the boxed set.
override uint DiscCount [get, set]
 Gets and sets the number of discs in the boxed set containing the media represented by the current instance.
string FirstAlbumArtist [get]
 Gets the first value contained in AlbumArtists.
string FirstAlbumArtistSort [get]
 Gets the first value contained in AlbumArtistsSort.
string FirstArtist [get]
 Gets the same value as FirstPerformer.
string FirstComposer [get]
 Gets the first value contained in Composers.
string FirstComposerSort [get]
 Gets the first value contained in ComposersSort.
string FirstGenre [get]
 Gets the first value contained in Genres.
string FirstPerformer [get]
 Gets the first value contained in Performers.
string FirstPerformerSort [get]
 Gets the first value contained in PerformersSort.
HeaderFlags Flags [get, set]
 Gets and sets the header flags applied to the current instance.
static bool ForceDefaultEncoding [get, set]
 Gets and sets whether or not to render all frames with the default encoding rather than their original encoding.
static bool ForceDefaultVersion [get, set]
 Gets and sets whether or not to save all tags in the default version rather than their original version.
override string[] Genres [get, set]
 Gets and sets the genres of the media represented by the current instance.
override string Grouping [get, set]
 Gets and sets the grouping on the album which the media in the current instance belongs to.
virtual bool IsEmpty [get]
 Gets whether or not the current instance is empty.
string JoinedAlbumArtists [get]
 Gets a semicolon separated string containing the values in AlbumArtists.
string JoinedArtists [get]
 Gets the same value as JoinedPerformers.
string JoinedComposers [get]
 Gets a semicolon separated string containing the values in Composers.
string JoinedGenres [get]
 Gets a semicolon separated string containing the values in Genres.
string JoinedPerformers [get]
 Gets a semicolon separated string containing the values in Performers.
string JoinedPerformersSort [get]
 Gets a semicolon separated string containing the values in PerformersSort.
static string Language [get, set]
 Gets and sets the ISO-639-2 language code to use when searching for and storing language specific values.
override string Lyrics [get, set]
 Gets and sets the lyrics or script of the media represented by the current instance.
override string MusicBrainzArtistId [get, set]
 Gets and sets the MusicBrainz ArtistID.
virtual string MusicBrainzDiscId [get, set]
 Gets and sets the MusicBrainz Disc ID of the media represented by the current instance.
override string MusicBrainzReleaseArtistId [get, set]
 Gets and sets the MusicBrainz ReleaseArtistID.
virtual string MusicBrainzReleaseCountry [get, set]
 Gets and sets the MusicBrainz Release Country of the media represented by the current instance.
override string MusicBrainzReleaseId [get, set]
 Gets and sets the MusicBrainz ReleaseID.
virtual string MusicBrainzReleaseStatus [get, set]
 Gets and sets the MusicBrainz Release Status of the media represented by the current instance.
virtual string MusicBrainzReleaseType [get, set]
 Gets and sets the MusicBrainz Release Type of the media represented by the current instance.
virtual string MusicBrainzTrackId [get, set]
 Gets and sets the MusicBrainz Track ID of the media represented by the current instance.
virtual string MusicIpId [get, set]
 Gets and sets the MusicIP PUID of the media represented by the current instance.
override string[] Performers [get, set]
 Gets and sets the performers or artists who performed in the media described by the current instance.
override string[] PerformersSort [get, set]
 Gets and sets the sort names of the performers or artists who performed in the media described by the current instance.
virtual IPicture[] Pictures [get, set]
 Gets and sets a collection of pictures associated with the media represented by the current instance.
override TagTypes TagTypes [get]
 Gets the tag types contained in the current instance.
override string Title [get, set]
 Gets and sets the title for the media described by the current instance.
override string TitleSort [get, set]
 Gets and sets the sort names of the Title of the media represented by the current instance.
override uint Track [get, set]
 Gets and sets the position of the media represented by the current instance in its containing album.
override uint TrackCount [get, set]
 Gets and sets the number of tracks in the album containing the media represented by the current instance.
static bool UseNumericGenres [get, set]
 Gets and sets whether or not to use ID3v1 style numeric genres when possible.
byte Version [get, set]
 Gets and sets the ID3v2 version of the current instance.
override uint Year [get, set]
 Gets and sets the year that the media represented by the current instance was recorded.

Private Member Functions

IEnumerator IEnumerable. GetEnumerator ()
string[] GetTextAsArray (ByteVector ident)
 Gets the text values from a specified Text Information Frame.
string GetTextAsString (ByteVector ident)
 Gets the text value from a specified Text Information Frame.
uint GetTextAsUInt32 (ByteVector ident, int index)
 Gets an integer value from a "/" delimited list in a specified Text Information Frame.
string GetUfidText (string owner)
 Gets the text from a particular UFID frame, referenced by the owner field.
string GetUserTextAsString (string description)
 Gets a TXXX frame via reference of the description field.
void MakeFirstOfType (Frame frame)
 Moves a specified frame so it is the first of its type in the tag.
void SetUfidText (string owner, string text)
 Creates and/or sets the text for a UFID frame, referenced by owner.
void SetUserTextAsString (string description, string text)
 Creates and/or sets a UserTextInformationFrame (TXXX) with the given description and text.

Private Attributes

ExtendedHeader extended_header = null
 Contains the tag's extended header.
List< Frameframe_list = new List<Frame> ()
 Contains the tag's frames.
Header header = new Header ()
 Contains the tag's header.

Static Private Attributes

static StringType default_string_type = StringType.UTF8
 Specifies the default string type to use for new frames.
static byte default_version = 3
 Contains the field to use for new tags.
static bool force_default_string_type = false
 Specifies whether or not all frames shoudl be saved in default_string_type.
static bool force_default_version = false
 Indicates whether or not all tags should be saved in default_version.
static string language
 Contains the language to use for language specific fields.
static bool use_numeric_genres = true
 Specifies whether or not numeric genres should be used when available.

The documentation for this class was generated from the following file:

Generated by  Doxygen 1.6.0   Back to index