mirror of
https://github.com/SoPat712/allstarr.git
synced 2026-02-09 23:55:10 -05:00
82 lines
3.0 KiB
C#
82 lines
3.0 KiB
C#
using octo_fiesta.Models.Domain;
|
|
using octo_fiesta.Models.Settings;
|
|
using octo_fiesta.Models.Download;
|
|
using octo_fiesta.Models.Search;
|
|
using octo_fiesta.Models.Subsonic;
|
|
|
|
namespace octo_fiesta.Services;
|
|
|
|
/// <summary>
|
|
/// Interface for external music metadata search service
|
|
/// (Deezer API, Spotify API, MusicBrainz, etc.)
|
|
/// </summary>
|
|
public interface IMusicMetadataService
|
|
{
|
|
/// <summary>
|
|
/// Searches for songs on external providers
|
|
/// </summary>
|
|
/// <param name="query">Search term</param>
|
|
/// <param name="limit">Maximum number of results</param>
|
|
/// <returns>List of found songs</returns>
|
|
Task<List<Song>> SearchSongsAsync(string query, int limit = 20);
|
|
|
|
/// <summary>
|
|
/// Searches for albums on external providers
|
|
/// </summary>
|
|
Task<List<Album>> SearchAlbumsAsync(string query, int limit = 20);
|
|
|
|
/// <summary>
|
|
/// Searches for artists on external providers
|
|
/// </summary>
|
|
Task<List<Artist>> SearchArtistsAsync(string query, int limit = 20);
|
|
|
|
/// <summary>
|
|
/// Combined search (songs, albums, artists)
|
|
/// </summary>
|
|
Task<SearchResult> SearchAllAsync(string query, int songLimit = 20, int albumLimit = 20, int artistLimit = 20);
|
|
|
|
/// <summary>
|
|
/// Gets details of an external song
|
|
/// </summary>
|
|
Task<Song?> GetSongAsync(string externalProvider, string externalId);
|
|
|
|
/// <summary>
|
|
/// Gets details of an external album with its songs
|
|
/// </summary>
|
|
Task<Album?> GetAlbumAsync(string externalProvider, string externalId);
|
|
|
|
/// <summary>
|
|
/// Gets details of an external artist
|
|
/// </summary>
|
|
Task<Artist?> GetArtistAsync(string externalProvider, string externalId);
|
|
|
|
/// <summary>
|
|
/// Gets an artist's albums
|
|
/// </summary>
|
|
Task<List<Album>> GetArtistAlbumsAsync(string externalProvider, string externalId);
|
|
|
|
/// <summary>
|
|
/// Searches for playlists on external providers
|
|
/// </summary>
|
|
/// <param name="query">Search term</param>
|
|
/// <param name="limit">Maximum number of results</param>
|
|
/// <returns>List of found playlists</returns>
|
|
Task<List<ExternalPlaylist>> SearchPlaylistsAsync(string query, int limit = 20);
|
|
|
|
/// <summary>
|
|
/// Gets details of an external playlist (metadata only, not tracks)
|
|
/// </summary>
|
|
/// <param name="externalProvider">Provider name (e.g., "deezer", "qobuz")</param>
|
|
/// <param name="externalId">Playlist ID from the provider</param>
|
|
/// <returns>Playlist details or null if not found</returns>
|
|
Task<ExternalPlaylist?> GetPlaylistAsync(string externalProvider, string externalId);
|
|
|
|
/// <summary>
|
|
/// Gets all tracks from an external playlist
|
|
/// </summary>
|
|
/// <param name="externalProvider">Provider name (e.g., "deezer", "qobuz")</param>
|
|
/// <param name="externalId">Playlist ID from the provider</param>
|
|
/// <returns>List of songs in the playlist</returns>
|
|
Task<List<Song>> GetPlaylistTracksAsync(string externalProvider, string externalId);
|
|
}
|