The AudioFile class contains the metadata of an audio file.
It can refresh the metadata by reading the tags inside the audio file or from
the database (using MPfm.Library).
Declaration Syntax| C# | Visual Basic |
public class AudioFile
Public Class AudioFile
Members| All Members | Constructors | Methods | Properties | ||
| Icon | Member | Description |
|---|---|---|
 | AudioFile(String) |
Default constructor for AudioFile. Requires the path to the audio file.
Will raise an exception if the file doesn't exists.
|
| AudioFile(String, Guid) |
Constructor for the AudioFile class. Requires the path to the audio file.
Will raise an exception if the file doesn't exists.
|
| AudioFile(String, Guid, Boolean) |
Constructor for the AudioFile class. Requires the path to the audio file.
Will raise an exception if the file doesn't exists.
|
 | AlbumTitle |
Album title.
|
| APETag |
Defines the APEv1/APEv2 tag associated with this audio file.
Supported file formats: FLAC, APE, WV, MPC, OFR, TTA.
For more information go to http://wiki.hydrogenaudio.org/index.php?title=APEv2_specification.
|
| ArtistName |
Artist name.
|
| AudioChannels |
Number of audio channels.
|
| AudioLayer |
Audio layer type.
|
| Bitrate |
Audio bitrate. Indicates the average bitrate for VBR MP3 files.
|
| BitsPerSample |
Audio bits per sample. Usually 16-bit or 24-bit.
|
| ChannelMode |
Channel mode (only for MP3 files).
|
| DiscNumber |
Disc number.
|
| DiscTrackNumber |
Returns the disc and track number in string format.
If the disc number is zero, it will return the track number (ex: 10).
If the disc number is higher than zero, it will return the disc number
and the track number separated by a comma (ex: 1.10).
|
| Equals(Object) | (Inherited from Object.) |
 | ExtractImageForAudioFile(String) |
Extracts album art from an audio file.
|
| FilePath |
Full path to the audio file.
|
| FileType |
Type of audio file (FLAC, MP3, OGG, WAV, WV, MPC, OFR, TTA).
|
| FillTags(File) |
Fills the Tag properties of a TagLib.File class (including its subclasses).
|
 | Finalize()()()() | Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.) |
| FirstBlockPosition |
Position of the first block of data. Useful for reading the Xing header.
|
| FrameLength |
Frame length.
|
| Genre |
Genre.
|
| GetHashCode()()()() | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetType()()()() | Gets the Type of the current instance. (Inherited from Object.) |
| Id |
Unique identifier for reading and writing audio file metadata to the database.
|
| LastBlockPosition |
Position of the last block of data.
|
| LastPlayed |
Defines the last time the audio file has been played with MPfm (information comes from the MPfm database).
Null if the audio file has never been played.
|
| Length |
Audio file length (in 00:00.000 format).
|
| Lyrics |
Song lyrics.
|
| MemberwiseClone()()()() | Creates a shallow copy of the current Object. (Inherited from Object.) |
| MP3EncoderDelay |
MP3 Encoder delay.
Ex: 576
|
| MP3EncoderPadding |
MP3 Encoder padding.
Ex: 1800
|
| MP3EncoderVersion |
MP3 Encoder version.
Ex: LAME3.98
|
| MP3HeaderType |
Indicates the type of header for the MP3 file.
The XING header is found on MP3 files encoded using LAME and VBR/ABR settings.
The INFO header is found on MP3 files encoded using LAME and CBR settings.
Both headers are in fact the same.
|
| PlayCount |
Defines the number of times the audio file has been played with MPfm (information comes from the MPfm database).
|
| Rating |
Defines the rating of the audio file, from 1 to 5.
0 means no rating.
|
| RefreshMetadata()()()() |
Refreshes the metadata of the audio file.
|
| SampleRate |
Sample rate (in Hz).
|
| SaveMetadata()()()() |
Saves the metadata associated with this audio file from its properties.
|
| SV7Tag |
Defines the SV7 tag associated with this audio file.
Supported file formats: MPC (MusePack).
For more information, go to http://trac.musepack.net/trac/wiki/SV7Specification.
|
| SV8Tag |
Defines the SV8 tag associated with this audio file.
Supported file formats: MPC (MusePack).
For more information, go to http://trac.musepack.net/trac/wiki/SV8Specification.
|
| Tempo |
Defines the audio file tempo, in BPM (beats per minute).
0 means no tempo found.
|
| Title |
Song title.
|
| ToString()()()() | (Inherited from Object.) |
| TrackCount |
Track number.
|
| TrackNumber |
Track number.
|
| Year |
Production year (year only).
|
Inheritance Hierarchy| Object | |
 | AudioFile |