provider

type AlbumBrowser interface {
	AlbumList(sortType string, offset, size int) ([]AlbumInfo, error)
	AlbumSortTypes() []SortType
	DefaultAlbumSort() string
}

type AlbumInfo struct {
	ID         string
	Name       string
	Artist     string
	ArtistID   string
	Year       int
	TrackCount int
	Genre      string
}

type AlbumSortSaver interface {
	SaveAlbumSort(sortType string) error
}

type AlbumTrackLoader interface {
	AlbumTracks(albumID string) ([]playlist.Track, error)
}

type ArtistBrowser interface {
	Artists() ([]ArtistInfo, error)
	ArtistAlbums(artistID string) ([]AlbumInfo, error)
}

type ArtistInfo struct {
	ID         string
	Name       string
	AlbumCount int
}

type BookmarkSetter interface {
	SetBookmark(playlistName string, idx int) error
	SetBookmarkByPath(playlistName string, path string) error
}

type CatalogLoader interface {
	// LoadCatalogPage fetches the next page of catalog entries starting at
	// offset. Returns the number of items added and any error.
	LoadCatalogPage(offset, limit int) (added int, err error)
}

type CatalogSearcher interface {
	// SearchCatalog performs a server-side search. Results are reflected
	// in the next Playlists() call.
	SearchCatalog(query string) (int, error)
	ClearSearch()
	IsSearching() bool
}

type Closer interface {
	Close()
}

type CustomStreamer interface {
	// URISchemes returns the URI prefixes this provider handles.
	URISchemes() []string
	// NewStreamer creates a decoder for the given URI.
	NewStreamer(uri string) (beep.StreamSeekCloser, beep.Format, time.Duration, error)
}

type FavoriteToggler interface {
	ToggleFavorite(id string) (added bool, name string, err error)
}

type PlaybackReporter interface {
	CanReportPlayback(track playlist.Track) bool
	ReportNowPlaying(track playlist.Track, position time.Duration, canSeek bool)
	ReportScrobble(track playlist.Track, elapsed, duration time.Duration, canSeek bool)
}

type PlaylistBatchWriter interface {
	AddTracksToPlaylist(ctx context.Context, playlistID string, tracks []playlist.Track) (added, skipped int, err error)
}

type PlaylistCreator interface {
	CreatePlaylist(ctx context.Context, name string) (string, error)
}

type PlaylistDeleter interface {
	DeletePlaylist(name string) error
	RemoveTrack(name string, index int) error
}

type PlaylistRenamer interface {
	RenamePlaylist(oldName, newName string) error
}

type PlaylistSaver interface {
	SavePlaylist(name string, tracks []playlist.Track) error
}

type PlaylistWriter interface {
	AddTrackToPlaylist(ctx context.Context, playlistID string, track playlist.Track) error
}

type Searcher interface {
	SearchTracks(ctx context.Context, query string, limit int) ([]playlist.Track, error)
}

type SectionedList interface {
	// IDPrefix returns the section prefix for a playlist ID (e.g. "f", "c", "s").
	IDPrefix(id string) string
	// IsFavoritableID reports whether the given ID can be favorited.
	IsFavoritableID(id string) bool
}

type SortType struct {
	ID    string // e.g. "alphabeticalByName"
	Label string // e.g. "By Name"
}