The zbucium Reference Manual

This is the zbucium Reference Manual, version 0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Dec 15 08:08:13 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

The main system appears first, followed by any subsystem dependency.


2.1 zbucium

last.fm music player with lyrics

Author

Mihai Olteanu

License

GPLv3

Version

0.1

Dependencies
  • lastfm (system).
  • youtube (system).
  • lyrics (system).
  • drakma (system).
  • bordeaux-threads (system).
  • plump (system).
  • lquery (system).
  • alexandria (system).
  • local-time (system).
  • fare-memoization (system).
  • generators (system).
  • yason (system).
Source

zbucium.asd.

Child Components

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.


3.1 Lisp


3.1.1 zbucium/zbucium.asd

Source

zbucium.asd.

Parent Component

zbucium (system).

ASDF Systems

zbucium.


3.1.2 zbucium/packages.lisp

Source

zbucium.asd.

Parent Component

zbucium (system).

Packages

zbucium.


3.1.3 zbucium/zbucium.lisp

Dependency

packages.lisp (file).

Source

zbucium.asd.

Parent Component

zbucium (system).

Public Interface
Internals

4 Packages

Packages are listed by definition order.


4.1 zbucium

Source

packages.lisp.

Use List
  • alexandria.
  • bordeaux-threads.
  • common-lisp.
  • generators.
  • lastfm.
  • lquery.
  • lyrics.
  • plump.
  • youtube.
Public Interface
Internals

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.


5.1 Public Interface


5.1.1 Ordinary functions

Function: love-song ()
Package

zbucium.

Source

zbucium.lisp.

Function: next-song ()

Close the current youtube session, forcing the generator to take and play the next song.

Package

zbucium.

Source

zbucium.lisp.

Function: play-album (artist album)
Package

zbucium.

Source

zbucium.lisp.

Function: play-artist (artist nsongs random)
Package

zbucium.

Source

zbucium.lisp.

Function: play-artist-similar (artist nartists nsongs)
Package

zbucium.

Source

zbucium.lisp.

Function: play-my-loved-songs (nsongs random)
Package

zbucium.

Source

zbucium.lisp.

Function: play-song (artist song)

Play and replay a single song

Package

zbucium.

Source

zbucium.lisp.

Function: play-tag (tag nsongs random)
Package

zbucium.

Source

zbucium.lisp.

Function: play-tag-similar (tag nartists nsongs)
Package

zbucium.

Source

zbucium.lisp.

Function: play-user-songs (username nsongs random)
Package

zbucium.

Source

zbucium.lisp.

Function: song-lyrics ()
Package

zbucium.

Source

zbucium.lisp.

Function: stop ()
Package

zbucium.

Source

zbucium.lisp.

Function: unlove-song ()
Package

zbucium.

Source

zbucium.lisp.

Function: what-is-playing ()
Package

zbucium.

Source

zbucium.lisp.

Function: what-is-playing-as-string ()

Return a printable representation of the artist and song currently playing. If the player is stopped, return an empty string.

Package

zbucium.

Source

zbucium.lisp.


5.2 Internals


5.2.1 Constants

Constant: +scrobble-timeout+

Time to wait, in seconds, before scrobbling the current playing song.

Package

zbucium.

Source

zbucium.lisp.


5.2.2 Special variables

Special Variable: *artist*

The name of the currently playing artist.

Package

zbucium.

Source

zbucium.lisp.

Special Variable: *playing-thread*

Playing a song or list of songs starts a new thread since we also want to return from the call while the player is running.

Package

zbucium.

Source

zbucium.lisp.

Special Variable: *song*

The name of the currently playing song.

Package

zbucium.

Source

zbucium.lisp.

Special Variable: *still-playing*

Set to true when player started, set to nil when stopped.

Package

zbucium.

Source

zbucium.lisp.


5.2.3 Ordinary functions

Function: play-simple (songs-generator)

The main functionality. Take a new song from the generator, save the lyrics for it, scrobble it if needed and either find a youtube url to play or create a string that can be searched by youtube-dl. Repeat after the song finishes or was stopped by the user. End the loop only when the player is stopped by the user.

Package

zbucium.

Source

zbucium.lisp.

Function: set-playing-song (artist-and-song)
Package

zbucium.

Source

zbucium.lisp.

Function: start-playing ()
Package

zbucium.

Source

zbucium.lisp.


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   F   L   N   P   S   U   W  
Index Entry  Section

F
Function, love-song: Public ordinary functions
Function, next-song: Public ordinary functions
Function, play-album: Public ordinary functions
Function, play-artist: Public ordinary functions
Function, play-artist-similar: Public ordinary functions
Function, play-my-loved-songs: Public ordinary functions
Function, play-simple: Private ordinary functions
Function, play-song: Public ordinary functions
Function, play-tag: Public ordinary functions
Function, play-tag-similar: Public ordinary functions
Function, play-user-songs: Public ordinary functions
Function, set-playing-song: Private ordinary functions
Function, song-lyrics: Public ordinary functions
Function, start-playing: Private ordinary functions
Function, stop: Public ordinary functions
Function, unlove-song: Public ordinary functions
Function, what-is-playing: Public ordinary functions
Function, what-is-playing-as-string: Public ordinary functions

L
love-song: Public ordinary functions

N
next-song: Public ordinary functions

P
play-album: Public ordinary functions
play-artist: Public ordinary functions
play-artist-similar: Public ordinary functions
play-my-loved-songs: Public ordinary functions
play-simple: Private ordinary functions
play-song: Public ordinary functions
play-tag: Public ordinary functions
play-tag-similar: Public ordinary functions
play-user-songs: Public ordinary functions

S
set-playing-song: Private ordinary functions
song-lyrics: Public ordinary functions
start-playing: Private ordinary functions
stop: Public ordinary functions

U
unlove-song: Public ordinary functions

W
what-is-playing: Public ordinary functions
what-is-playing-as-string: Public ordinary functions