MPfm: Music Player for Musicians - Developer Documentation - 0.6.0.0
MPfmGateway Class
NamespacesMPfm.LibraryMPfmGateway
The MPfmGateway class implements the SQLiteGateway class. It acts as a facade to select, insert, update and delete data from the MPfm database.
Declaration Syntax
C#Visual Basic
public class MPfmGateway : SQLiteGateway
Public Class MPfmGateway _
	Inherits SQLiteGateway
Members
All MembersConstructorsMethodsProperties



IconMemberDescription
MPfmGateway(String)
Default constructor for the MPfmGateway class.

CloseConnection()()()()
Closes the database connection. Raises an exception if the connection cannot be closed.
(Inherited from SQLiteGateway.)
CompactDatabase()()()()
Compacts the database.
(Inherited from SQLiteGateway.)
DatabaseFilePath
Database file path.
(Inherited from SQLiteGateway.)
Delete(String, String, Guid)
Deletes an item from the database.
(Inherited from SQLiteGateway.)
Delete(String)
Deletes all rows from a database table.
(Inherited from SQLiteGateway.)
Delete(String, String)
Deletes all rows from a database table using the specified Where clause.
(Inherited from SQLiteGateway.)
DeleteAudioFile(Guid)
Deletes an audio file from the database.

DeleteAudioFiles(String)
Deletes audio files from the database based on their file path.

DeleteEqualizer(Guid)
Deletes an EQ preset from the database.

DeleteFolder(Guid)
Deletes a specific folder.

DeleteFolders()()()()
Deletes all folders.

DeleteLoop(Guid)
Deletes a loop from the database.

DeleteMarker(Guid)
Deletes a marker from the database.

DeletePlaylistFile(String)
Deletes a playlist file from the database.

DeleteSetting(Guid)
Deletes a setting from the database.

Equals(Object)
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Execute(String)
Executes a SQL query and returns the number of rows affected.
(Inherited from SQLiteGateway.)
ExecuteScalar(String)
Executes a scalar SQL query and returns the query value.
(Inherited from SQLiteGateway.)
ExecuteSQL(String)
Executes an SQL statement.

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.)
GetAudioFileLastPlayedFromHistory(Guid)
Returns the last time the audio file has been played. The value is null if the file has never been played.

GetAudioFilePlayCountFromHistory(Guid)
Returns the number of times the audio file has been played.

GetHashCode()()()()
Serves as a hash function for a particular type.
(Inherited from Object.)
GetType()()()()
Gets the Type of the current instance.
(Inherited from Object.)
Insert(String, String, Object)
Inserts an item into the database.
(Inherited from SQLiteGateway.)
InsertAudioFile(AudioFile)
Inserts a new audio file into the database.

InsertAudioFiles(List<(Of <<'(AudioFile>)>>))
Inserts new audio files into the database.

InsertEqualizer(EQPreset)
Inserts a new EQ preset into the database.

InsertFolder(String, Boolean)
Inserts a folder in the database. Configuration for library location.

InsertHistory(Guid)
Inserts an history item into the database using the current datetime.

InsertHistory(Guid, DateTime)
Inserts an history item into the database.

InsertLoop(Loop)
Inserts a new loop into the database.

InsertMarker(Marker)
Inserts a new marker into the database.

InsertPlaylistFile(PlaylistFile)
Inserts a new playlist file into the database.

InsertSetting(String, String)
Inserts a new setting into the database.

InsertSetting(Setting)
Inserts a new setting into the database.

MemberwiseClone()()()()
Creates a shallow copy of the current Object.
(Inherited from Object.)
OpenConnection()()()()
Opens the database connection. Raises an exception if the connection cannot be opened.
(Inherited from SQLiteGateway.)
ResetLibrary()()()()
Resets the library.

Select(String)
Executes a select query and returns a DataTable object.
(Inherited from SQLiteGateway.)
SelectAudioFile(Guid)
Selects a specific audio file from the database by its identifier.

SelectAudioFiles()()()()
Selects all audio files from the database.

SelectDistinctAlbumTitles()()()()
Returns the distinct list of album titles per artist from the database.

SelectDistinctAlbumTitles(AudioFileFormat)
Returns the distinct list of album titles per artist from the database, using the sound format filter passed in the soundFormat parameter.

SelectDistinctAlbumTitlesWithFilePaths(AudioFileFormat)
Returns the distinct list of album titles with the path of at least one song of the album from the database, using the sound format filter passed in the soundFormat parameter. This is useful for displaying album art for example (no need to return all songs from every album).

SelectDistinctArtistNames()()()()
Returns the distinct list of artist names from the database.

SelectDistinctArtistNames(AudioFileFormat)
Returns the distinct list of artist names from the database, using the sound format filter passed in the soundFormat parameter.

SelectEQPreset(String)
Selects an EQ preset from the database.

SelectEQPresets()()()()
Select all EQ presets from the database.

SelectFolderByPath(String)
Selects a folder from a path.

SelectFolders()()()()
Selects a folders.

SelectLoop(Guid)
Selects a loop from the database.

SelectLoops()()()()
Selects all loops from the database.

SelectLoops(Guid)
Selects loops related to an audio file from the database.

SelectMarker(Guid)
Selects a marker from the database.

SelectMarkers()()()()
Selects all markers from the database.

SelectMarkers(Guid)
Selects markers related to an audio file from the database.

SelectPlaylistFiles()()()()
Selects all playlist files.

SelectSetting(String)
Selects a setting by its name.

SelectSettings()()()()
Selects all settings.

ToString()()()()
Returns a String that represents the current Object.
(Inherited from Object.)
Update(String, String, Guid, Object)
Updates an item in the database.
(Inherited from SQLiteGateway.)
UpdateAudioFile(AudioFile)
Updates an existing audio file to the database.

UpdateDataTable(DataTable, String)
Updates a DataTable into the database (useful for insert/update/delete).
(Inherited from SQLiteGateway.)
UpdateDataTableTransaction(DataTable, String)
Updates a DataTable into the database using a transaction (useful for insert/update/delete).
(Inherited from SQLiteGateway.)
UpdateEqualizer(EQPreset)
Updates an existing EQ preset in the database.

UpdateLoop(Loop)
Updates an existing loop from the database.

UpdateMarker(Marker)
Updates an existing marker from the database.

UpdatePlayCount(Guid)
Updates the play count of an audio file and sets the last playback datetime.

UpdateSetting(Setting)
Updates an existing setting from the database.

Inheritance Hierarchy
Object
SQLiteGateway
 MPfmGateway

Assembly: MPfm.Library (Module: MPfm.Library) Version: 0.5.3.0 (0.5.3.0)