file-browser: added some documentation
This commit is contained in:
parent
33511d4400
commit
307a879a90
@ -65,6 +65,10 @@ https://github.com/tkem/mopidy-dleyna
|
|||||||
Provides a backend for playing music from Digital Media Servers using
|
Provides a backend for playing music from Digital Media Servers using
|
||||||
the `dLeyna <http://01.org/dleyna>`_ D-Bus interface.
|
the `dLeyna <http://01.org/dleyna>`_ D-Bus interface.
|
||||||
|
|
||||||
|
Mopidy-Files
|
||||||
|
============
|
||||||
|
|
||||||
|
Bundled with Mopidy. See :ref:`ext-files`.
|
||||||
|
|
||||||
Mopidy-Grooveshark
|
Mopidy-Grooveshark
|
||||||
==================
|
==================
|
||||||
|
|||||||
48
docs/ext/files.rst
Normal file
48
docs/ext/files.rst
Normal file
@ -0,0 +1,48 @@
|
|||||||
|
.. _ext-files:
|
||||||
|
|
||||||
|
************
|
||||||
|
Mopidy-Files
|
||||||
|
************
|
||||||
|
|
||||||
|
Mopidy-Files is an extension for playing music from your local music archive.
|
||||||
|
It is bundled with Mopidy and enabled by default.
|
||||||
|
It allows you to browse through your local file system.
|
||||||
|
Only files that are considered playable will be shown
|
||||||
|
|
||||||
|
This backend handles URIs starting with ``file:``.
|
||||||
|
|
||||||
|
|
||||||
|
Configuration
|
||||||
|
=============
|
||||||
|
|
||||||
|
See :ref:`config` for general help on configuring Mopidy.
|
||||||
|
|
||||||
|
.. literalinclude:: ../../mopidy/files/ext.conf
|
||||||
|
:language: ini
|
||||||
|
|
||||||
|
.. confval:: files/enabled
|
||||||
|
|
||||||
|
If the files extension should be enabled or not.
|
||||||
|
|
||||||
|
.. confval:: files/media_dir
|
||||||
|
|
||||||
|
A list of directories to be browsable.
|
||||||
|
Each Directory path has to be written in a separate line.
|
||||||
|
Optionally the path can be followed by : and a name that will be shown for that path.
|
||||||
|
|
||||||
|
.. confval:: files/show_hidden
|
||||||
|
|
||||||
|
Whether to show hidden files and directories that start with a dot.
|
||||||
|
Default is false.
|
||||||
|
|
||||||
|
.. confval:: files/follow_symlinks
|
||||||
|
|
||||||
|
Whether to follow symbolic links found in :confval:`files/media_dir`.
|
||||||
|
Directories and files that are outside the configured media_dirs will not be shown.
|
||||||
|
Default is false
|
||||||
|
|
||||||
|
.. confval:: files/metadata_timeout
|
||||||
|
|
||||||
|
Number of milliseconds before giving up scanning a file and moving on to
|
||||||
|
the next file. Reducing the value might speed up the directory listing,
|
||||||
|
but can lead to some tracks not being shown.
|
||||||
@ -96,6 +96,7 @@ Extensions
|
|||||||
:maxdepth: 2
|
:maxdepth: 2
|
||||||
|
|
||||||
ext/local
|
ext/local
|
||||||
|
ext/files
|
||||||
ext/m3u
|
ext/m3u
|
||||||
ext/stream
|
ext/stream
|
||||||
ext/http
|
ext/http
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user