Documentation
¶
Overview ¶
Package lyrics provides a way to work with both synced and plain lyrics
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Instrumental ¶
type Instrumental struct {
// contains filtered or unexported fields
}
func (*Instrumental) Current ¶
func (i *Instrumental) Current() (Lyric, bool)
func (*Instrumental) GetSong ¶
func (i *Instrumental) GetSong() model.Song
func (*Instrumental) Next ¶
func (i *Instrumental) Next() (Lyric, bool)
func (*Instrumental) Previous ¶
func (i *Instrumental) Previous(amount int) []Lyric
func (*Instrumental) Progress ¶
func (i *Instrumental) Progress() float64
func (*Instrumental) Upcoming ¶
func (i *Instrumental) Upcoming(amount int) []Lyric
type Lyrics ¶
type Lyrics interface {
GetSong() model.Song // GetSong returns the song associated to the lyrics
Previous(int) []Lyric // Previous returns the previous 'int amount' of lyrics without affecting the current lyric
Current() (Lyric, bool) // Current provides the current lyric and a bool indicating if there is one
Next() (Lyric, bool) // Next returns the next lyric and a bool if there are any
Upcoming(int) []Lyric // Upcoming returns the next `int amount` of lyrics without affecting the current lyric
Progress() float64 // Progress returns the fraction of lyrics that have been used
}
Lyrics is the common interface for different lyric types
Click to show internal directories.
Click to hide internal directories.