Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Browse files
Browse the repository at this point in the history
update sounds
- Loading branch information
Showing
4 changed files
with
194 additions
and
131 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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` |
Oops, something went wrong.