provider

package
v0.4.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 4, 2025 License: GPL-3.0 Imports: 1 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Name

type Name string

Name represents lyrics finding providers to choose from when doing a lyrics search.

const (
	// Dank pass this to [GetSongLyrics] to use DankLyrics as a lyrics provider.
	Dank Name = "dank"
	// LyricFind pass this to [GetSongLyrics] to use LyricFind as a lyrics provider.
	LyricFind Name = "lrc"
)

type SearchParams

type SearchParams struct {
	SongName   string
	ArtistName string
	AlbumName  string
	Query      string
}

SearchParams holds the search criteria to find a song from a provider.

type Service

type Service interface {
	// GetSongLyrics searches for a song's lyrics using the given search params.
	GetSongLyrics(s SearchParams) (models.Lyrics, error)
}

Service fetches lyrics for the given song in the search params.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL