Skip to content

Commit

Permalink
document the output parameter
Browse files Browse the repository at this point in the history
  • Loading branch information
Martin Kirchgessner committed Feb 15, 2023
1 parent 2e47d2c commit 12e7f7e
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 1 deletion.
4 changes: 4 additions & 0 deletions docs/configuring.rst
Original file line number Diff line number Diff line change
Expand Up @@ -134,6 +134,10 @@ Other values can be set as ``method``:
connection by generating different data each time it's called.
This should only be used for Showergel's unit tests.

You can also add a line stating ``ouput = "identifier"`` to force Showergel to
get its "Now playing" information from the output having ``id="identifier"``
in your Liquidsoap script (see :ref:`liq_current`).

``[metadata_log]``
------------------

Expand Down
7 changes: 6 additions & 1 deletion docs/liquidsoap.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,11 +31,12 @@ your existing script (it also contain a few Liquidsoap tricks!).

Sections below discuss implementation details on integrating each Showergel feature.

.. _liq_current:

Display/skip current track
--------------------------

You just need to enable `Liquidsoap's telnet server <https://www.liquidsoap.info/doc-2.0.0/server.html>`_.
You need to enable `Liquidsoap's telnet server <https://www.liquidsoap.info/doc-2.0.0/server.html>`_.
For example:

.. code-block:: ocaml
Expand All @@ -55,6 +56,10 @@ be careful to set a different ``port`` for each one.
This would open your Liquidsoap instance to the Internet,
and someone might connect and mess up your programs.

**If your script has multiple outputs**, ensure the main one has an identifier
by setting its ``id="identifier"`` parameter.
This identifier should be copied as ``output`` in the :ref:`configuration_liquidsoap` section.

.. _liq_metadata:

Logging metadata
Expand Down
4 changes: 4 additions & 0 deletions showergel/commands/install.py
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,10 @@
host = "127.0.0.1"
port = 1234
# to ensure Showergel gets its "Now playing" information from the correct output,
# you can add the following line with that output's `id`:
# output = "id"
############# Logging configuration ##########
[logging]
version = 1
Expand Down

0 comments on commit 12e7f7e

Please sign in to comment.