The MP3 Class can be used to gather ID3v1 and ID3v2 information ONLY. If there are any non-standard implementations of an ID3 tag or any other non-standard tag in the MP3 header/footer, they will be ignored. This class was derived from information from http://www.id3.org (more specifically http://id3.org/id3v2.3.0)
More...
List of all members.
Public Member Functions |
| | MP3 () |
| | The default constructor for an MP3 class.
|
| | MP3 (string fileName) |
| | The prefered constructor for the MP3 class that initializes all information for the ID3v1 and ID3v2 tags.
|
| void | Clear () |
| | Clear out the MP3 ID3v1 and ID3v2 tag information.
|
| void | GetTagInformation () |
| | Gets the ID3 information from the MP3.
|
| void | Initialize (string fileName) |
| | Initialization method to which the MP3 is read and parsed, gathering the ID3 information.
|
| void | SaveTagInfo () |
| | Saves the ID3v1 and ID3v2 tag info to the actual MP3 file.
|
| override string | ToString () |
| | Returns a string representation of this MP3 object in the format of (Artist - Song Title)
|
Static Public Member Functions |
| static long | GetHeaderPosition (string file, long start) |
| | Retreive the position of the MP3 header (not ID3 tag)
|
Properties |
| Metadata.ID3.V1 | ID3v1 [get, set] |
| Metadata.ID3.V2 | ID3v2 [get, set] |
| Metadata.APE.V2 | APEv2 [get, set] |
| string | File [get, set] |
| long | FileSize [get, set] |
| | Returns the actual file size (in bytes) of the MP3 file.
|
| bool | HasId3v1Tag [get] |
| | Returns true if the MP3 has an ID3v1 tag.
|
| bool | HasId3v2Tag [get] |
| | Returns true if the MP3 has an ID3v2 tag.
|
| bool | HasApeTag [get] |
| | Gets if this instance has an APEv2 tag associated with it.
|
| long | SongDataSize [get] |
| | Returns the logical MP3 size (in bytes). This is the actual size of the song in the MP3 (i.e. FileSize - (ID3 tag sizes))
|
Detailed Description
The MP3 Class can be used to gather ID3v1 and ID3v2 information ONLY. If there are any non-standard implementations of an ID3 tag or any other non-standard tag in the MP3 header/footer, they will be ignored. This class was derived from information from http://www.id3.org (more specifically http://id3.org/id3v2.3.0)
Definition at line 29 of file MP3.cs.
Constructor & Destructor Documentation
| Sylloge.Audio.MP3.MP3 |
( |
| ) |
|
The default constructor for an MP3 class.
Definition at line 56 of file MP3.cs.
| Sylloge.Audio.MP3.MP3 |
( |
string |
fileName | ) |
|
The prefered constructor for the MP3 class that initializes all information for the ID3v1 and ID3v2 tags.
- Parameters:
-
| fileName | The MP3 file to get the information from |
Definition at line 66 of file MP3.cs.
Member Function Documentation
| void Sylloge.Audio.MP3.Clear |
( |
| ) |
|
Clear out the MP3 ID3v1 and ID3v2 tag information.
Definition at line 74 of file MP3.cs.
| static long Sylloge.Audio.MP3.GetHeaderPosition |
( |
string |
file, |
|
|
long |
start |
|
) |
| [static] |
Retreive the position of the MP3 header (not ID3 tag)
- Parameters:
-
| fileName | The MP3 file to look at |
| start | The position in the file to start looking |
- Returns:
- Returns the 0 based index into the file where the MP3 header was found
Definition at line 193 of file MP3.cs.
| void Sylloge.Audio.MP3.GetTagInformation |
( |
| ) |
|
Gets the ID3 information from the MP3.
Definition at line 89 of file MP3.cs.
| void Sylloge.Audio.MP3.Initialize |
( |
string |
fileName | ) |
|
Initialization method to which the MP3 is read and parsed, gathering the ID3 information.
- Parameters:
-
Definition at line 122 of file MP3.cs.
| void Sylloge.Audio.MP3.SaveTagInfo |
( |
| ) |
|
Saves the ID3v1 and ID3v2 tag info to the actual MP3 file.
Definition at line 136 of file MP3.cs.
| override string Sylloge.Audio.MP3.ToString |
( |
| ) |
|
Returns a string representation of this MP3 object in the format of (Artist - Song Title)
- Returns:
Definition at line 169 of file MP3.cs.
Property Documentation
string Sylloge.Audio.MP3.File [get, set] |
long Sylloge.Audio.MP3.FileSize [get, set] |
Returns the actual file size (in bytes) of the MP3 file.
Definition at line 84 of file MP3.cs.
bool Sylloge.Audio.MP3.HasApeTag [get] |
Gets if this instance has an APEv2 tag associated with it.
Definition at line 114 of file MP3.cs.
bool Sylloge.Audio.MP3.HasId3v1Tag [get] |
Returns true if the MP3 has an ID3v1 tag.
Definition at line 98 of file MP3.cs.
bool Sylloge.Audio.MP3.HasId3v2Tag [get] |
Returns true if the MP3 has an ID3v2 tag.
Definition at line 106 of file MP3.cs.
long Sylloge.Audio.MP3.SongDataSize [get] |
Returns the logical MP3 size (in bytes). This is the actual size of the song in the MP3 (i.e. FileSize - (ID3 tag sizes))
Definition at line 151 of file MP3.cs.
The documentation for this class was generated from the following file: