Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
update sounds
  • Loading branch information
jabdoa2 committed Apr 12, 2020
1 parent 61e7bcd commit d1364fa
Show file tree
Hide file tree
Showing 4 changed files with 194 additions and 131 deletions.
2 changes: 2 additions & 0 deletions config/index.rst
Expand Up @@ -158,8 +158,10 @@ indicated which type of config file it's valid in.
smart_virtual: <smart_virtual>
smartmatrix: <smartmatrix>
snux: <snux>
sound_ducking: <sound_ducking>
sound_loop_player: <sound_loop_player>
sound_loop_sets: <sound_loop_sets>
sound_marker: <sound_marker>
sound_player: <sound_player>
sound_pools: <sound_pools>
sound_system: <sound_system>
Expand Down
78 changes: 78 additions & 0 deletions config/sound_ducking.rst
@@ -0,0 +1,78 @@
sound_ducking:
==============

*Config file section*

+----------------------------------------------------------------------------+---------+
| Valid in :doc:`machine config files </config/instructions/machine_config>` | **NO** |
+----------------------------------------------------------------------------+---------+
| Valid in :doc:`mode config files </config/instructions/mode_config>` | **NO** |
+----------------------------------------------------------------------------+---------+

.. overview
The ``ducking:`` setting in your ``sounds:`` section of your config is where
you configure ducking settings for a sound.

.. config
Required settings
-----------------

The following sections are required in the ``sound_ducking:`` section of your config:

target:
~~~~~~~
List of one (or more) events.

The list of track names to apply the ducking to when the sound is played. This most commonly
contains the name of the track that music is played on.


Optional settings
-----------------

The following sections are optional in the ``sound_ducking:`` section of your config. (If you don't include them, the default will be used).

attack:
~~~~~~~
Single value, type: ``time string (secs)`` (:doc:`Instructions for entering time strings </config/instructions/time_strings>`). Default: ``10ms``

The duration of the period over which the ducking starts until it reaches its maximum attenuation
(attack stage). This value is specified as a :doc:`time string </config/instructions/time_strings>`.

attenuation:
~~~~~~~~~~~~
Single value, type: ``gain setting`` (-inf, db, or float between 0.0 and 1.0). Default: ``1.0``

The attenuation (gain) to apply to the target track while ducking. ``attenuation:`` controls how
quiet to make the target track while the sound is playing.

delay:
~~~~~~
Single value, type: ``time string (secs)`` (:doc:`Instructions for entering time strings </config/instructions/time_strings>`). Default: ``0``

The duration to delay after the sound starts playing before ducking starts. This value is specified
as a :doc:`time string </config/instructions/time_strings>`.

release:
~~~~~~~~
Single value, type: ``time string (secs)`` (:doc:`Instructions for entering time strings </config/instructions/time_strings>`). Default: ``10ms``

The duration of the period over which the ducking goes from its maximum attenuation until the
ducking ends (release stage). This value is specified as a :doc:`time string </config/instructions/time_strings>`.

release_point:
~~~~~~~~~~~~~~
Single value, type: ``time string (secs)`` (:doc:`Instructions for entering time strings </config/instructions/time_strings>`). Default: ``0``

The point relative to the end of the sound at which to start the returning the attenuation back to
normal (release stage). A value of 0.5 seconds means to begin to release the ducking 0.5 seconds
prior to the end of the sound. This value is specified as a :doc:`time string </config/instructions/time_strings>`.


Related How To guides
---------------------

* :doc:`/sound/ducking`
43 changes: 43 additions & 0 deletions config/sound_marker.rst
@@ -0,0 +1,43 @@
sound_marker:
=============

*Config file section*

+----------------------------------------------------------------------------+---------+
| Valid in :doc:`machine config files </config/instructions/machine_config>` | **NO** |
+----------------------------------------------------------------------------+---------+
| Valid in :doc:`mode config files </config/instructions/mode_config>` | **NO** |
+----------------------------------------------------------------------------+---------+

.. overview
The ``markers:`` setting in your ``sounds:`` section of your config is where
you configure markers which trigger events at certain points in playback.

.. config
Required settings
-----------------

The following sections are required in the ``sound_marker:`` section of your config:

events:
~~~~~~~
List of one (or more) events.

A list of one or more names of events that MPF will post when this marker is reached during sound
playback. Enter the list in the MPF config list format. These events are posted exactly as they’re
entered.

time:
~~~~~
Single value, type: ``time string (secs)`` (:doc:`Instructions for entering time strings </config/instructions/time_strings>`).

The marker time (in seconds) relative to the beginning of the sound file.


Related How To guides
---------------------

* :doc:`/sound/index`

0 comments on commit d1364fa

Please sign in to comment.