Harvey
0f25ebc26d
* plex integration * The big one - Full Music Source page rework + Playlist importing + Full Plex Integration + Discovery Options + More Like This/Surprise Me/Instant Mix + More... * Music source track page - Play all / shuffle fixes * lint * format * fix type checks * format
136 lines
3.2 KiB
Python
136 lines
3.2 KiB
Python
from __future__ import annotations
|
|
|
|
from typing import TYPE_CHECKING, Protocol
|
|
|
|
from repositories.navidrome_models import (
|
|
SubsonicAlbum,
|
|
SubsonicAlbumInfo,
|
|
SubsonicArtist,
|
|
SubsonicArtistIndex,
|
|
SubsonicArtistInfo,
|
|
SubsonicGenre,
|
|
SubsonicLyrics,
|
|
SubsonicMusicFolder,
|
|
SubsonicNowPlayingEntry,
|
|
SubsonicPlaylist,
|
|
SubsonicSearchResult,
|
|
SubsonicSong,
|
|
)
|
|
|
|
if TYPE_CHECKING:
|
|
from repositories.navidrome_models import StreamProxyResult
|
|
|
|
|
|
class NavidromeRepositoryProtocol(Protocol):
|
|
|
|
def is_configured(self) -> bool:
|
|
...
|
|
|
|
def configure(self, url: str, username: str, password: str) -> None:
|
|
...
|
|
|
|
async def ping(self) -> bool:
|
|
...
|
|
|
|
async def get_album_list(
|
|
self, type: str, size: int = 20, offset: int = 0, genre: str | None = None
|
|
) -> list[SubsonicAlbum]:
|
|
...
|
|
|
|
async def get_album(self, id: str) -> SubsonicAlbum:
|
|
...
|
|
|
|
async def get_artists(self) -> list[SubsonicArtist]:
|
|
...
|
|
|
|
async def get_artist(self, id: str) -> SubsonicArtist:
|
|
...
|
|
|
|
async def get_song(self, id: str) -> SubsonicSong:
|
|
...
|
|
|
|
async def search(
|
|
self,
|
|
query: str,
|
|
artist_count: int = 20,
|
|
album_count: int = 20,
|
|
song_count: int = 20,
|
|
) -> SubsonicSearchResult:
|
|
...
|
|
|
|
async def get_starred(self) -> SubsonicSearchResult:
|
|
...
|
|
|
|
async def get_genres(self) -> list[SubsonicGenre]:
|
|
...
|
|
|
|
async def get_artists_index(self) -> list[SubsonicArtistIndex]:
|
|
...
|
|
|
|
async def get_songs_by_genre(
|
|
self, genre: str, count: int = 50, offset: int = 0
|
|
) -> list[SubsonicSong]:
|
|
...
|
|
|
|
async def get_music_folders(self) -> list[SubsonicMusicFolder]:
|
|
...
|
|
|
|
async def get_playlists(self) -> list[SubsonicPlaylist]:
|
|
...
|
|
|
|
async def get_playlist(self, id: str) -> SubsonicPlaylist:
|
|
...
|
|
|
|
async def get_random_songs(
|
|
self, size: int = 20, genre: str | None = None
|
|
) -> list[SubsonicSong]:
|
|
...
|
|
|
|
async def scrobble(self, id: str, time_ms: int | None = None) -> bool:
|
|
...
|
|
|
|
async def validate_connection(self) -> tuple[bool, str]:
|
|
...
|
|
|
|
async def clear_cache(self) -> None:
|
|
...
|
|
|
|
def build_stream_url(self, song_id: str) -> str:
|
|
...
|
|
|
|
async def proxy_head_stream(self, song_id: str) -> StreamProxyResult:
|
|
...
|
|
|
|
async def proxy_get_stream(
|
|
self, song_id: str, range_header: str | None = None
|
|
) -> StreamProxyResult:
|
|
...
|
|
|
|
async def now_playing(self, id: str) -> bool:
|
|
...
|
|
|
|
async def get_now_playing(self) -> list[SubsonicNowPlayingEntry]:
|
|
...
|
|
|
|
async def get_top_songs(
|
|
self, artist_name: str, count: int = 20
|
|
) -> list[SubsonicSong]:
|
|
...
|
|
|
|
async def get_similar_songs(
|
|
self, song_id: str, count: int = 20
|
|
) -> list[SubsonicSong]:
|
|
...
|
|
|
|
async def get_artist_info(self, artist_id: str) -> SubsonicArtistInfo | None:
|
|
...
|
|
|
|
async def get_album_info(self, album_id: str) -> SubsonicAlbumInfo | None:
|
|
...
|
|
|
|
async def get_lyrics(self, artist: str, title: str) -> SubsonicLyrics | None:
|
|
...
|
|
|
|
async def get_lyrics_by_song_id(self, song_id: str) -> SubsonicLyrics | None:
|
|
...
|