This is docvo4Sjc.info, produced by makeinfo version 6.8 from
listen.texi.


File: docvo4Sjc.info,  Node: Top,  Next: Installation,  Up: (dir)

listen.el
*********

https://elpa.gnu.org/packages/listen.svg
(https://elpa.gnu.org/packages/listen.html)

   This package aims to provide a simple audio/music player for Emacs.
It should "just work," with little-to-no configuration, have intuitive
commands, and be easily extended and customized.  (Contrast to setting
up EMMS, or having to configure external players like MPD.)  A Transient
menu, under the command ‘listen’, is the primary entry point.

   The only external dependency is VLC, which is currently the only
player backend that is supported.  (Other backends may easily be added;
see library ‘listen-vlc’ for example.)  Track metadata is read using
EMMS’s native Elisp metadata library, which has been imported into this
package.

   Queues are provided as the means to play consecutive tracks, and they
are shown in a ‘vtable’-based view buffer.  They are persisted between
sessions using the ‘persist’ library, and they may be bookmarked.

   The primary interface to one’s music library is through the
filesystem, by selecting a file to play, or by adding files and
directories to a queue.  Although MPD is not required, support is
provided for finding files from a local MPD server’s library using MPD’s
metadata searching.

   A simple "library" view is provided that shows a list of files
organized into a hierarchy by genre, date, artist, album, etc.  (This
will be made more configurable and useful in the future.)

   Note a silly limitation: a track may be present in a queue only once
(but who would want to have a track more than once in a playlist).

* Menu:

* Installation::
* Configuration::
* Usage::
* Changelog::
* Development::

— The Detailed Node Listing —

Installation

* GNU ELPA::
* Git::

Changelog

* v0.3-pre: v03-pre.
* v0.2: v02.
* v0.1: v01.

Development

* Copyright assignment::



File: docvo4Sjc.info,  Node: Installation,  Next: Configuration,  Prev: Top,  Up: Top

1 Installation
**************

Note that Listen.el uses VLC (https://www.videolan.org/vlc/) to play
audio, so it must be installed.

* Menu:

* GNU ELPA::
* Git::


File: docvo4Sjc.info,  Node: GNU ELPA,  Next: Git,  Up: Installation

1.1 GNU ELPA
============

Listen.el is published in GNU ELPA (http://elpa.gnu.org/) as listen
(https://elpa.gnu.org/packages/listen.html), so it may be installed in
Emacs with the command ‘M-x package-install RET listen RET’.  This is
the recommended way to install Listen.el, as it will install the current
stable release.

   The latest development build may be installed from ELPA-devel
(https://elpa.gnu.org/devel/listen.html) or from Git (see below).


File: docvo4Sjc.info,  Node: Git,  Prev: GNU ELPA,  Up: Installation

1.2 Git
=======

The ‘master’ branch of the Git repository is intended to be usable at
all times; only minor bugs are expected to be found in it before a new
stable release is made.

   To install, it is recommended to use quelpa-use-package
(https://github.com/quelpa/quelpa-use-package), like this (using this
helpful command
(https://github.com/alphapapa/unpackaged.el#upgrade-a-quelpa-use-package-forms-package)
for upgrading versions):

     ;; Install and load `quelpa-use-package'.
     (package-install 'quelpa-use-package)
     (require 'quelpa-use-package)

     ;; Install Listen.
     (use-package listen
       :quelpa (listen :fetcher github :repo "alphapapa/listen.el"))

   One might also use systems like Elpaca
(https://github.com/progfolio/elpaca) or Straight
(https://github.com/radian-software/straight.el) (which is also used by
DOOM (https://github.com/doomemacs/doomemacs)), but the author cannot
offer support for them.


File: docvo4Sjc.info,  Node: Configuration,  Next: Usage,  Prev: Installation,  Up: Top

2 Configuration
***************

Listen is intended to work with little-to-no configuration.  You can set
the ‘listen-directory’ to the location of your music library if it’s not
at ‘~/Music’.  See ‘M-x customize-group RET listen RET’.


File: docvo4Sjc.info,  Node: Usage,  Next: Changelog,  Prev: Configuration,  Up: Top

3 Usage
*******

Use the command ‘listen’ to show the Transient menu.  From there, it
is–hopefully–self-explanatory.  Please feel free to give feedback if it
doesn’t seem so.


File: docvo4Sjc.info,  Node: Changelog,  Next: Development,  Prev: Usage,  Up: Top

4 Changelog
***********

* Menu:

* v0.3-pre: v03-pre.
* v0.2: v02.
* v0.1: v01.


File: docvo4Sjc.info,  Node: v03-pre,  Next: v02,  Up: Changelog

4.1 v0.3-pre
============

*Additions*
   • Command ‘listen-library-from-mpd’ shows tracks selected from MPD in
     a library view.
   • Command ‘listen-queue-as-library’ shows tracks selected from a
     queue buffer in a library view.

   *Changes*
   • Reading tracks from MPD allows multiple selection using
     ‘completing-read-multiple’.
   • Various improvements in robustness.
   • Command ‘listen-queue’ doesn’t recreate its buffer when already
     open.
   • Key bindings in ‘listen’ Transient menu.

   *Fixes*
   • Completing read of tracks from MPD.
   • Unset VLC process’s query-on-exit flag.

   *Credits*
   • Thanks to Philip Kaludercic (https://amodernist.com/) for
     reviewing.


File: docvo4Sjc.info,  Node: v02,  Next: v01,  Prev: v03-pre,  Up: Changelog

4.2 v0.2
========

*Additions*
   • Command ‘listen-queue-jump’ jumps to the currently playing track in
     the queue.
   • Command ‘listen-queue-shell-command’ runs a shell command on the
     tracks selected in the queue.
   • Reverting a queue buffer with universal prefix argument refreshes
     the tracks’ metadata from disk.

   *Fixes*
   • The queue could sometimes skip tracks when playing.
   • Improve handling of tracks that are changed during playback (e.g.
     metadata).
   • Update copyright statements in all libraries.


File: docvo4Sjc.info,  Node: v01,  Prev: v02,  Up: Changelog

4.3 v0.1
========

Initial release.


File: docvo4Sjc.info,  Node: Development,  Prev: Changelog,  Up: Top

5 Development
*************

Feedback and patches are welcome.

* Menu:

* Copyright assignment::


File: docvo4Sjc.info,  Node: Copyright assignment,  Up: Development

5.1 Copyright assignment
========================

Listen.el is published in GNU ELPA and is considered part of GNU Emacs.
Therefore, cumulative contributions of more than 15 lines of code
require that the author assign copyright of such contributions to the
FSF.  Authors who are interested in doing so may contact assign@gnu.org
<assign@gnu.org> to request the appropriate form.



Tag Table:
Node: Top76
Node: Installation2004
Node: GNU ELPA2257
Node: Git2791
Node: Configuration3813
Node: Usage4155
Node: Changelog4429
Node: v03-pre4597
Node: v025412
Node: v016055
Node: Development6156
Node: Copyright assignment6327

End Tag Table


Local Variables:
coding: utf-8
End:
